Record Class BostonHousing

java.lang.Object

java.lang.Record

smile.datasets.BostonHousing

Record Components:

data - data frame.

formula - modeling formula.

public record BostonHousing(DataFrame data, Formula formula)
extends Record

Boston housing dataset. This dataset is a derived from information collected by the U.S. Census Service concerning housing in the area of Boston MA.

Constructor Summary

Constructors

Constructor	Description
BostonHousing()	Constructor.
BostonHousing(Path path)	Constructor.
BostonHousing(DataFrame data, Formula formula)	Creates an instance of a BostonHousing record class.

Method Summary

Modifier and Type	Method	Description
DataFrame	data()	Returns the value of the data record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Formula	formula()	Returns the value of the formula record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
double[][]	x()	Returns the sample features.
double[]	y()	Returns the target values.

Methods inherited from class Object

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

Constructor Details

BostonHousing

public BostonHousing()
              throws IOException,
ParseException

Constructor.

Throws:

IOException - when fails to read the file.

ParseException - when fails to parse the file.

BostonHousing

public BostonHousing(Path path)
              throws IOException,
ParseException

Constructor.

Parameters:

path - the data path.

Throws:

IOException - when fails to read the file.

ParseException - when fails to parse the file.

BostonHousing

public BostonHousing(DataFrame data,
 Formula formula)

Creates an instance of a BostonHousing record class.

Parameters:

data - the value for the data record component

formula - the value for the formula record component

Method Details

x

public double[][] x()

Returns the sample features.

Returns:

the sample features.

y

public double[] y()

Returns the target values.

Returns:

the target values.

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 DataFrame data()

Returns the value of the data record component.

Returns:

the value of the data record component

formula

public Formula formula()

Returns the value of the formula record component.

Returns:

the value of the formula record component