Click or drag to resize

PLS2 Class

Class PLS2 performs a Partial Least Squares (PLS) regression calculation on a set of predictive and response values. The result is used to predict response variable values.
Inheritance Hierarchy

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
[SerializableAttribute]
public class PLS2 : ICloneable

The PLS2 type exposes the following members.

Constructors
  NameDescription
Public methodPLS2
Default constructor. Calculator is set to the default.
Public methodPLS2(IPLS2Calc)
Constructs a PLS2 instance which uses the given calculator.
Public methodPLS2(DoubleMatrix, DoubleMatrix, Int32)
Constructs a PLS2 instance with the default calculator and performs a PLS2 calculation on the given data.
Public methodPLS2(IPLS2Calc, DoubleMatrix, DoubleMatrix, Int32)
Constructs a PLS2 instance with the given calculator and performs a PLS2 calculation on the given data. ///
Top
Properties
  NameDescription
Public propertyCalculator
Gets and sets the calculator.
Public propertyIsGood
Whether the calculation was successful.
Public propertyMessage
Gets any message that may have been generated by the algorithm. For example, if the calculation is unsuccessful, the message indicate the reason.
Public propertyNumComponents
Gets and sets the number of predictor variable components to use in the calculation.
Public propertyX
Gets the predictor matrix.
Public propertyY
Gets the response matrix.
Top
Methods
  NameDescription
Public methodCalculate(DataFrame, DataFrame, Int32)
Calculates the partial least squares fit.
Public methodCalculate(DoubleMatrix, DoubleMatrix, Int32)
Calculates the partial least squares fit.
Public methodClone
Creates a deep copy of this PLS2.
Public methodHotellingsT2
Calculaties Hotelling's T2 statistic for each sample. T2 can be viewed as the squared distance from a samples projection into the subspace to the centroid of the subspace, or, more simply, the variation of the sample point within the model.
Public methodPredict(DoubleMatrix)
Predict the responses for a set of predictor values.
Public methodPredict(DoubleVector)
Calculates the predicted value of the response variable for the given value of the predictor variable.
Public methodQResiduals
Calculates the Q residuals for in sample in the model. The Q residual for a given sample is the distance between the sample and its projection in the subspace of the model.
Top
Fields
  NameDescription
Public fieldStatic memberDEFAULT_CALCULATOR
Calculator to use when no specific calculator is specified.
Top
See Also