ILNumerics Ultimate VSILMathsum Method (BaseArraySingle, Int32, Boolean)ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
Compute the sum of elements of A along the specified dimension.

[ILNumerics Computing Engine]

Namespace: ILNumerics
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.3.0.0 (5.3.7131.2749)
Syntax

public static RetArray<float> sum(
	BaseArray<float> A,
	int dim = -1,
	bool keepdim = true
)

Parameters

A
Type: ILNumericsBaseArraySingle
Input array.
dim (Optional)
Type: SystemInt32
[Optional] The index of the dimension to be reduced. Default: (-1) the first non-singleton dimension found in A or 0.
keepdim (Optional)
Type: SystemBoolean
[Optional] True: reduced singleton dimension is not removed from the output (default). False: the new singleton dimension is removed.

Return Value

Type: RetArraySingle
New array with the same shape as A except that the dimension specified by dim is reduced to length min(1,A.S[dim]) and removed if keepdim is false.
Exceptions

ExceptionCondition
ArgumentExceptionIf A.S[dim] == 0 and keepdim was false.
Remarks

[ILNumerics Computing Engine]

See Also

Reference