jsat.regression

Class MultipleLinearRegression

java.lang.Object

jsat.regression.MultipleLinearRegression

All Implemented Interfaces:

Serializable, Cloneable, Regressor, SimpleWeightVectorModel, SingleWeightVectorModel

public class MultipleLinearRegression
extends Object
implements Regressor, SingleWeightVectorModel

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MultipleLinearRegression()
MultipleLinearRegression(boolean useWeights)

Method Summary

Modifier and Type	Method and Description
MultipleLinearRegression	clone()
double	getBias() Returns the bias term used for the model, or 0 of the model does not support or was not trained with a bias term.
double	getBias(int index) Returns the bias term used with the weight vector for the given class index.
Vec	getRawWeight() Returns the only weight vector used for the model
Vec	getRawWeight(int index) Returns the raw weight vector associated with the given class index.
int	numWeightsVecs() Returns the number of weight vectors that can be returned.
double	regress(DataPoint data)
boolean	supportsWeightedData()
void	train(RegressionDataSet dataSet)
void	train(RegressionDataSet dataSet, ExecutorService threadPool)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultipleLinearRegression

public MultipleLinearRegression()

MultipleLinearRegression

public MultipleLinearRegression(boolean useWeights)

Method Detail

regress

public double regress(DataPoint data)

Specified by:

regress in interface Regressor

train

public void train(RegressionDataSet dataSet,
                  ExecutorService threadPool)

Specified by:

train in interface Regressor

train

public void train(RegressionDataSet dataSet)

Specified by:

train in interface Regressor

supportsWeightedData

public boolean supportsWeightedData()

Specified by:

supportsWeightedData in interface Regressor

getRawWeight

public Vec getRawWeight()

Description copied from interface: SingleWeightVectorModel

Returns the only weight vector used for the model

Specified by:

getRawWeight in interface SingleWeightVectorModel

Returns:

the only weight vector used for the model

getBias

public double getBias()

Description copied from interface: SingleWeightVectorModel

Returns the bias term used for the model, or 0 of the model does not support or was not trained with a bias term.

Specified by:

getBias in interface SingleWeightVectorModel

Returns:

the bias term for the model

getRawWeight

public Vec getRawWeight(int index)

Description copied from interface: SimpleWeightVectorModel

Returns the raw weight vector associated with the given class index. If the given class is an implicit zero vector, a ConstantVector object may be returned.
Do not alter the returned weight vector, as it will change the model's values.

If a regression problem, only index = 0 should be used

Specified by:

getRawWeight in interface SimpleWeightVectorModel

Parameters:

index - the class index to get the weight vector for

Returns:

the weight vector used for the specified class

getBias

public double getBias(int index)

Description copied from interface: SimpleWeightVectorModel

Returns the bias term used with the weight vector for the given class index. If the model does not support or was not trained with bias weights, 0 will be returned.

If a regression problem, only index = 0 should be used

Specified by:

getBias in interface SimpleWeightVectorModel

Parameters:

index - the class index to get the weight vector for

Returns:

the bias term for the specified class

numWeightsVecs

public int numWeightsVecs()

Description copied from interface: SimpleWeightVectorModel

Returns the number of weight vectors that can be returned. For binary classification problems the value may be 1 if only a single weight vector's sign is used to determine the class. For multi-class problems, the weight vector count includes the implicit zero vector (if one is being used).

Specified by:

numWeightsVecs in interface SimpleWeightVectorModel

Returns:

the number of weight vectors for which SimpleWeightVectorModel.getRawWeight(int) can be called.

clone

public MultipleLinearRegression clone()

Specified by:

clone in interface Regressor

Overrides:

clone in class Object