You are here: Start » AVL.NET » Function Reference » Data Classification » Principal Component Analysis » AVL.NormalizeMatrixData

AVL.NormalizeMatrixData

Treats Matrix as a data frame, where examples are in rows while columns represent features, and normalizes the data by subtracting mean from each column and dividing it by its standard deviation.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void NormalizeMatrixData
(
	AvlNet.Matrix inMatrix,
	NullableRef<AvlNet.Matrix> inMeansVector,
	NullableRef<AvlNet.Matrix> inStandardDeviationsVector,
	AvlNet.Matrix outNormalizedMatrix,
	AvlNet.Matrix outMeansVector,
	AvlNet.Matrix outStandardDeviationsVector
)

Parameters

Name Type Range Default Description
inMatrixAvlNet.MatrixInput data frame.
inMeansVectorAvlNet.NullableRef<AvlNet.Matrix>If provided, will be used in normalization of inMatrix. Default value: atl::NIL.
inStandardDeviationsVectorAvlNet.NullableRef<AvlNet.Matrix>If provided, will be used in normalization of inMatrix. Default value: atl::NIL.
outNormalizedMatrixAvlNet.MatrixResulting normalized matrix.
outMeansVectorAvlNet.MatrixResulting Means vector - copy of inMeansVector, or calculated Means, if inMeansVector was set NIL.
outStandardDeviationsVectorAvlNet.MatrixResulting StdDevs vector - copy of inStandardDeviationsVector, or calculated Means, if inStandardDeviationsVector was set NIL.

Errors

List of possible exceptions:

Error type Description
DomainError Incorrect matrix dimensions in NormalizeData.
DomainError One can provide both Means and StdDevs vector or none of them.

Function Overrides

See also