ILNumerics Ultimate VSExtensionMethodssum Method (ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16, Int32, Boolean)ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development
[numpy API] Create an array with the sum of elements of A along a single dimension.

[ILNumerics numpy Module]

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

public static RetArray<ushort> sum(
	this ConcreteArray<ushort, Array<ushort>, InArray<ushort>, OutArray<ushort>, RetArray<ushort>, Storage<ushort>> A,
	int axis,
	bool keepdims = false
)

Parameters

A
Type: ILNumerics.Core.ArraysConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16
The source array. This will not be altered.
axis
Type: SystemInt32
The dimension to sum elements of A along.
keepdims (Optional)
Type: SystemBoolean
[Optional] the reduced dimension axis remains in the resulting array. Default: (false) the dimension axis is removed from the result.

Return Value

Type: RetArrayUInt16
An array with the same shape of A, except dimension 'axis' which is reduced / expanded to length 1.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks

Depending on the value of keepdims the array returned will have the same number of dimensions as A (keepdims = true) or with a number of dimensions according to MinNumberOfArrayDimensions (keepdims = false).

Empty arrays A produce a scalar array with the default element value for the element data type.

[ILNumerics numpy Module]

See Also

Reference

ExtensionMethodssum(ConcreteArrayUInt16, ArrayUInt16, InArrayUInt16, OutArrayUInt16, RetArrayUInt16, StorageUInt16, Int32, Boolean)