Click or drag to resize

IPLS2Calc Class

Interface for performing a Partial Least Squares (PLS) calculation.
Inheritance Hierarchy

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
Syntax
Copy
[SerializableAttribute]
public abstract class IPLS2Calc : ICloneable

The IPLS2Calc type exposes the following members.

Constructors
 NameDescription
Protected methodIPLS2CalcInitializes a new instance of the IPLS2Calc class
Top
Properties
 NameDescription
Public propertyCoefficients Gets the matrix of coefficients used for making predictions.
Public propertyIsGood Indicates 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 is unsuccessful, the message should indicate the reason.
Public propertyPredictorLoadings Gets a matrix whow columns are the predictor loading vectors.
Public propertyPredictorScores Gets a matrix whow columns are the predictor score vectors.
Top
Methods
 NameDescription
Public methodCalculate Perform a PLS2 calculation on the given data.
Public methodClone A deep copy of self.
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) Use the calculated model to predict the response value for each of of the given predictor values.
Public methodPredict(DoubleVector) Use the calculated model to predict the response value, y, from 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
Remarks
Implementations must be able to handle dependent, or ResponseVector, data with multiple columns (variables). That is, the algorithm must be a PLS2 algorithm.
See Also