Record Class ProstateCancer

java.lang.Object
java.lang.Record
smile.datasets.ProstateCancer
Record Components:
train - training data frame.
test - testing data frame.
formula - modeling formula.
public record ProstateCancer(DataFrame train, DataFrame test, Formula formula) extends Record
Prostate cancer dataset. This dataset examines the correlation between the level of prostate-specific antigen and a number of clinical measures in men who were about to receive a radical prostatectomy.

  • Constructor Details

    • ProstateCancer

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

    • ProstateCancer

      public ProstateCancer(Path trainDataPath, Path testDataPath) throws IOException
      Constructor.
      Parameters:
      trainDataPath - the path to training data file.
      testDataPath - the path to testing data file.
      Throws:
      IOException - when fails to read the file.

    • ProstateCancer

      public ProstateCancer(DataFrame train, DataFrame test, Formula formula)
      Creates an instance of a ProstateCancer record class.
      Parameters:
      train - the value for the train record component
      test - the value for the test record component
      formula - the value for the formula record component

  • Method Details

    • x

      public double[][] x()
      Returns the train sample features.
      Returns:
      the train sample features.

    • y

      public double[] y()
      Returns the train sample class labels.
      Returns:
      the train sample class labels.

    • testx

      public double[][] testx()
      Returns the test sample features.
      Returns:
      the test sample features.

    • testy

      public double[] testy()
      Returns the test sample class labels.
      Returns:
      the test sample class labels.

    • 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.

    • train

      public DataFrame train()
      Returns the value of the train record component.
      Returns:
      the value of the train record component

    • test

      public DataFrame test()
      Returns the value of the test record component.
      Returns:
      the value of the test record component

    • formula

      public Formula formula()
      Returns the value of the formula record component.
      Returns:
      the value of the formula record component