Package adams.data.instancesanalysis.pls

Class NIPALS

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.core.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 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 adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • getTechnicalInformation

        public adams.core.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 adams.core.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 adams.core.option.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

      • 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

      • 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