Package adams.data.instancesanalysis.pls

Class NIPALS

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.instancesanalysis.pls.AbstractPLS

adams.data.instancesanalysis.pls.AbstractSingleClassPLS

adams.data.instancesanalysis.pls.NIPALS

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, TechnicalInformationHandler, Serializable, weka.core.CapabilitiesHandler, GenericPLSMatrixAccess

public class NIPALS
extends AbstractSingleClassPLS

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected com.github.waikatodatamining.matrix.algorithm.pls.NIPALS.DeflationMode	m_DeflationMode	X and Y deflation Mode
protected int	m_MaxIter	Inner NIPALS loop maximum number of iterations
protected com.github.waikatodatamining.matrix.algorithm.pls.NIPALS	m_NIPALS	the actual algorithm.
protected boolean	m_NormYWeights	Flag to normalize Y weights
protected double	m_Tol	Inner NIPALS loop improvement tolerance

Fields inherited from class adams.data.instancesanalysis.pls.AbstractSingleClassPLS

m_ClassMean, m_ClassStdDev, m_Filter, m_Missing, PARAM_CLASSVALUES

Fields inherited from class adams.data.instancesanalysis.pls.AbstractPLS

m_Initialized, m_NumComponents, m_OutputFormat, m_PredictionType, m_PreprocessingType, m_ReplaceMissing

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
NIPALS()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	deflationModeTipText()	Returns the tip text for this property
protected weka.core.Instances	doTransform(weka.core.Instances data, Map<String,Object> params)	Transforms the data, initializes if necessary.
com.github.waikatodatamining.matrix.algorithm.pls.NIPALS.DeflationMode	getDeflationMode()	Returns the deflation mode to use.
weka.core.matrix.Matrix	getLoadings()	Returns the loadings, if available.
weka.core.matrix.Matrix	getMatrix(String name)	Returns the matrix with the specified name.
String[]	getMatrixNames()	Returns the all the available matrices.
int	getMaxIter()	Returns the NIPALS loop maximum number of iterations.
boolean	getNormYWeights()	Returns whether to normalize Y weights.
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
double	getTol()	Returns the inner NIPALS loop improvement tolerance.
String	globalInfo()	Returns a string describing the object.
boolean	hasLoadings()	Whether the algorithm supports return of loadings.
String	maxIterTipText()	Returns the tip text for this property
String	normYWeightsTipText()	Returns the tip text for this property
void	setDeflationMode(com.github.waikatodatamining.matrix.algorithm.pls.NIPALS.DeflationMode value)	Sets the deflation mode to use.
void	setMaxIter(int value)	Sets the inner NIPALS loop maximum number of iterations.
void	setNormYWeights(boolean value)	Sets whether to normalize Y weights.
void	setTol(double value)	Sets the inner NIPALS loop improvement tolerance.
String	tolTipText()	Returns the tip text for this property

Methods inherited from class adams.data.instancesanalysis.pls.AbstractSingleClassPLS

determineOutputFormat, postTransform, preTransform, reset

Methods inherited from class adams.data.instancesanalysis.pls.AbstractPLS

getCapabilities, getDefaultPreprocessingType, getNumComponents, getOutputFormat, getPredictionType, getPreprocessingType, getReplaceMissing, isInitialized, numComponentsTipText, predictionTypeTipText, preprocessingTypeTipText, replaceMissingTipText, setNumComponents, setPredictionType, setPreprocessingType, setReplaceMissing, transform

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_NIPALS

protected com.github.waikatodatamining.matrix.algorithm.pls.NIPALS m_NIPALS

the actual algorithm.

m_Tol

protected double m_Tol

Inner NIPALS loop improvement tolerance

m_MaxIter

protected int m_MaxIter

Inner NIPALS loop maximum number of iterations

m_NormYWeights

protected boolean m_NormYWeights

Flag to normalize Y weights

m_DeflationMode

protected com.github.waikatodatamining.matrix.algorithm.pls.NIPALS.DeflationMode m_DeflationMode

X and Y deflation Mode

Constructor Detail

NIPALS

public NIPALS()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Specified by:

getTechnicalInformation in class AbstractPLS

Returns:

the technical information about this class

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractPLS

setTol

public void setTol(double value)

Sets the inner NIPALS loop improvement tolerance.

Parameters:

value - the tolerance

getTol

public double getTol()

Returns the inner NIPALS loop improvement tolerance.

Returns:

the tolerance

tolTipText

public String tolTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setMaxIter

public void setMaxIter(int value)

Sets the inner NIPALS loop maximum number of iterations.

Parameters:

value - the maximum

getMaxIter

public int getMaxIter()

Returns the NIPALS loop maximum number of iterations.

Returns:

the maximum

maxIterTipText

public String maxIterTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setNormYWeights

public void setNormYWeights(boolean value)

Sets whether to normalize Y weights.

Parameters:

value - true if to normalize

getNormYWeights

public boolean getNormYWeights()

Returns whether to normalize Y weights.

Returns:

true if to normalized

normYWeightsTipText

public String normYWeightsTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setDeflationMode

public void setDeflationMode(com.github.waikatodatamining.matrix.algorithm.pls.NIPALS.DeflationMode value)

Sets the deflation mode to use.

Parameters:

value - the mode

getDeflationMode

public com.github.waikatodatamining.matrix.algorithm.pls.NIPALS.DeflationMode getDeflationMode()

Returns the deflation mode to use.

Returns:

the model

deflationModeTipText

public String deflationModeTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

getMatrixNames

public String[] getMatrixNames()

Returns the all the available matrices.

Specified by:

getMatrixNames in interface GenericPLSMatrixAccess

Specified by:

getMatrixNames in class AbstractPLS

Returns:

the names of the matrices

getMatrix

public weka.core.matrix.Matrix getMatrix(String name)

Returns the matrix with the specified name.

Specified by:

getMatrix in interface GenericPLSMatrixAccess

Specified by:

getMatrix in class AbstractPLS

Parameters:

name - the name of the matrix

Returns:

the matrix, null if not available

hasLoadings

public boolean hasLoadings()

Whether the algorithm supports return of loadings.

Specified by:

hasLoadings in interface GenericPLSMatrixAccess

Specified by:

hasLoadings in class AbstractPLS

Returns:

true if supported

See Also:

getLoadings()

getLoadings

public weka.core.matrix.Matrix getLoadings()

Returns the loadings, if available.

Specified by:

getLoadings in interface GenericPLSMatrixAccess

Specified by:

getLoadings in class AbstractPLS

Returns:

the loadings, null if not available

doTransform

protected weka.core.Instances doTransform(weka.core.Instances data,
                                          Map<String,Object> params)
                                   throws Exception

Transforms the data, initializes if necessary.

Specified by:

doTransform in class AbstractPLS

Parameters:

data - the data to use

params - additional parameters

Returns:

the transformed data

Throws:

Exception