Click or drag to resize

PLS1 Class

Class PLS1 performs a Partial Least Squares (PLS) regression calculation on a set of predictive and one-dimensional response values. The result is used to predict response variable values.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CorePLS1

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

The PLS1 type exposes the following members.

Constructors
  NameDescription
Public methodPLS1
Constructs a PLS1 instance. The default calculator.
Public methodPLS1(IPLS1Calc)
Constructs a PLS1 instance that used the given calculator.
Public methodPLS1(DoubleMatrix, DoubleVector, Int32)
Constructs a PLS1 instance with the default PLS1 calculator and performs a PLS1 calculation on the given data.
Public methodPLS1(IPLS1Calc, DoubleMatrix, DoubleVector, Int32)
Constructs a PLS1 instance with the given PLS1 calculator and performs a PLS1 calculation on the given data.
Top
Properties
  NameDescription
Public propertyCalculator
Gets and sets the calculator.
Public propertyIsGood
Whether the most recent calculation was successful.
Public propertyMessage
Gets any message that may have been generated by the algorithm. For example, if the calculation was unsuccessful, the message should indicate the reason.
Public propertyNumComponents
Gets and sets the number of predictor variable components to use in the PLS calculation.
Public propertyPredictorMatrix
Gets the predictor matrix.
Public propertyResponseVector
Gets the response vector.
Top
Methods
  NameDescription
Public methodCalculate(DataFrame, DoubleVector, Int32)
Calculates the partial least squares fit.
Public methodCalculate(DoubleMatrix, DoubleVector, Int32)
Calculates the partial least squares fit.
Public methodClone
Creates a deep copy of this PLS1.
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 methodHotellingsT2(DoubleVector)
Computes the Hotelling's T2 statistic for a new sample.
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
If no calculation object is specified during construction of PLS2 objects, this is the default calculator that will be used.
Top
See Also