Record Class SwissRoll

java.lang.Object
java.lang.Record
smile.datasets.SwissRoll
Record Components:
data - the data points.
public record SwissRoll(double[][] data) extends Record
Swiss roll dataset. It is commonly used demonstrating nonlinear dimensionality reduction algorithms. It consists of a set of points in three dimensions, arranged in a "roll" shape, such that the points on the roll are mapped to a two-dimensional plane in a nonlinear fashion.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwissRoll()
    Constructor.
    SwissRoll(double[][] data)
    Creates an instance of a SwissRoll record class.
    SwissRoll(Path path)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    double[][]
    data()
    Returns the value of the data record component.
    double[][]
    distance(int size)
    Returns the pairwise distance matrix.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SwissRoll

      public SwissRoll() throws IOException
      Constructor.
      Throws:
      IOException - when fails to read the file.

    • SwissRoll

      public SwissRoll(Path path) throws IOException
      Constructor.
      Parameters:
      path - the data path.
      Throws:
      IOException - when fails to read the file.

    • SwissRoll

      public SwissRoll(double[][] data)
      Creates an instance of a SwissRoll record class.
      Parameters:
      data - the value for the data record component

  • Method Details

    • distance

      public double[][] distance(int size)
      Returns the pairwise distance matrix.
      Parameters:
      size - the number of samples to calculate pair wise distance.
      Returns:
      the pairwise distance matrix.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • data

      public double[][] data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component