ILNumerics Ultimate VS

Statisticsstd Method (InArraySingle, InArraySingle, Boolean, Int32)

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Calculates the standard deviation for values in A.

[ILNumerics Statistics Toolbox]

Namespace:  ILNumerics.Toolboxes
Assembly:  ILNumerics.Toolboxes.Statistics (in ILNumerics.Toolboxes.Statistics.dll) Version: 5.5.0.0 (5.5.7503.3146)
Syntax

public static RetArray<float> std(
	InArray<float> A,
	InArray<float> Weights = null,
	bool biased = false,
	int dim = -1
)

Parameters

A
Type: ILNumericsInArraySingle
Input array.
Weights (Optional)
Type: ILNumericsInArraySingle
Vector of scaling factors, same length as working dimension of A, default: no scaling.
biased (Optional)
Type: SystemBoolean
[Optional] true: apply biased normalization to result, default: false (non-biased).
dim (Optional)
Type: SystemInt32
[Optional] Dimension index of A to operate along, default: first non singleton dimension.

Return Value

Type: RetArraySingle
Variances.
Remarks

On scalar A a scalar 0 of the same shape as A is returned.

On empty A an empty array is returned, having the dimension to operate along reduced to length 1.

The parameters Weights, biased and dim are optional. Ommiting either one will choose its respective default value.

The standard deviation is computed by the formula std = sqrt(var(A,...)). For further details on given parameters, see [M:ILNumerics.Toolboxes.Statistics.var(ILNumerics.InArray{T},ILNumerics.InArray{T},bool,false);].

[ILNumerics Statistics Toolbox]

See Also

Reference