jsat.datatransform

Class UnitVarianceTransform

java.lang.Object

jsat.datatransform.UnitVarianceTransform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, DataTransform, InPlaceTransform

public class UnitVarianceTransform
extends java.lang.Object
implements InPlaceTransform

Creates a transform to alter data points so that each attribute has a standard deviation of 1, which means a variance of 1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnitVarianceTransform() Creates a new object for transforming datasets
UnitVarianceTransform(DataSet d) Creates a new object for making datasets unit variance fit to the given dataset

Method Summary

Modifier and Type	Method and Description
DataTransform	clone()
void	fit(DataSet d) Fits this transform to the given dataset.
void	mutableTransform(DataPoint dp) Mutates the given data point.
boolean	mutatesNominal() By default returns false.
DataPoint	transform(DataPoint dp) Returns a new data point that is a transformation of the original data point.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitVarianceTransform

public UnitVarianceTransform()

Creates a new object for transforming datasets

UnitVarianceTransform

public UnitVarianceTransform(DataSet d)

Creates a new object for making datasets unit variance fit to the given dataset

Parameters:

d - the dataset to learn this transform from

Method Detail

fit

public void fit(DataSet d)

Description copied from interface: DataTransform

Fits this transform to the given dataset. Some transforms can only be learned from classification or regression datasets. If an incompatible dataset type is given, a FailedToFitException exception may be thrown.

Specified by:

fit in interface DataTransform

Parameters:

d - the dataset to fir this transform to

transform

public DataPoint transform(DataPoint dp)

Description copied from interface: DataTransform

Returns a new data point that is a transformation of the original data point. This new data point is a different object, but may contain the same references as the original data point. It is not guaranteed that you can mutate the transformed point without having a side effect on the original point.

Specified by:

transform in interface DataTransform

Parameters:

dp - the data point to apply a transformation to

Returns:

a transformed data point

mutableTransform

public void mutableTransform(DataPoint dp)

Description copied from interface: InPlaceTransform

Mutates the given data point. This causes side effects, altering the data point to have the same value as the output of DataTransform.transform(jsat.classifiers.DataPoint).

Specified by:

mutableTransform in interface InPlaceTransform

Parameters:

dp - the data point to alter

mutatesNominal

public boolean mutatesNominal()

Description copied from interface: InPlaceTransform

By default returns false. Only returns true if this transform will mutableTransform the nominal feature values of a data point.

Specified by:

mutatesNominal in interface InPlaceTransform

Returns:

true if nominal feature values are mutated, false otherwise.

clone

public DataTransform clone()

Specified by:

clone in interface DataTransform

Overrides:

clone in class java.lang.Object