PrincipalProjectionsCorrelateSupplementaryVariables(DoubleMatrix) Method

Gets the correlations of each specified supplementary variable on the standardized principal variables.

Definition

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.1.0+428f3840cfab98dda567bb0ed350b302533e273a

C#

public DoubleMatrix CorrelateSupplementaryVariables(
	DoubleMatrix supplementaryVariables
)

VB

Public Function CorrelateSupplementaryVariables ( 
	supplementaryVariables As DoubleMatrix
) As DoubleMatrix

C++

public:
DoubleMatrix^ CorrelateSupplementaryVariables(
	DoubleMatrix^ supplementaryVariables
)

F#

member CorrelateSupplementaryVariables : 
        supplementaryVariables : DoubleMatrix -> DoubleMatrix

Parameters

supplementaryVariables DoubleMatrix: The supplementary variables.

Return Value

DoubleMatrix
The correlations of each specified supplementary variable on the standardized principal ones.

Remarks

The matrix passed as supplementaryVariables must have as many rows as the number of points in the ActiveCloud, while the number of columns is the number of supplementary variables.

Returns a matrix having as many rows as the number of supplementary variables, and as many columns as the number of principal ones. A given entry is the correlation between a supplementary variable, that corresponding to the entry row, and a principal variable, that corresponding to the entry column.

Exceptions

ArgumentNullException	supplementaryVariables is null.
ArgumentOutOfRangeException	The number of rows in supplementaryVariables is not equal to the number of points in the active cloud.