ExtensionMethodssumIndT Method (ConcreteArrayUInt32, ArrayUInt32, InArrayUInt32, OutArrayUInt32, RetArrayUInt32, StorageUInt32, BaseArrayIndT, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Create an array based on the sum of elements of A.

[ILNumerics numpy Module]

Namespace: ILNumerics
Assembly: ILNumerics.numpy (in ILNumerics.numpy.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

public static RetArray<uint> sum<IndT>(
	this ConcreteArray<uint, Array<uint>, InArray<uint>, OutArray<uint>, RetArray<uint>, Storage<uint>> A,
	BaseArray<IndT> axes = null,
	bool keepdims = false
)
where IndT : struct, new(), IConvertible

<ExtensionAttribute>
Public Shared Function sum(Of IndT As {Structure, New, IConvertible}) ( 
	A As ConcreteArray(Of UInteger, Array(Of UInteger), InArray(Of UInteger), OutArray(Of UInteger), RetArray(Of UInteger), Storage(Of UInteger)),
	Optional axes As BaseArray(Of IndT) = Nothing,
	Optional keepdims As Boolean = false
) As RetArray(Of UInteger)

Dim A As ConcreteArray(Of UInteger, Array(Of UInteger), InArray(Of UInteger), OutArray(Of UInteger), RetArray(Of UInteger), Storage(Of UInteger))
Dim axes As BaseArray(Of IndT)
Dim keepdims As Boolean
Dim returnValue As RetArray(Of UInteger)

returnValue = A.sum(axes, keepdims)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayUInt32, ArrayUInt32, InArrayUInt32, OutArrayUInt32, RetArrayUInt32, StorageUInt32
The source array. This will not be altered.
axes (Optional): Type: ILNumericsBaseArrayIndT
[Optional] Dimensions of A to build sum along. Default: (null) sum all elements.
keepdims (Optional): Type: SystemBoolean
[Optional] accumulated dimensions remain in the resulting array. Default: (false) accumulated singleton dimensions are removed.

Type Parameters

IndT: Element type for axes parameter. Must be numeric.

Return Value

Type: RetArrayUInt32
Array with the result of summing elements of A accordingly.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayUInt32, ArrayUInt32, InArrayUInt32, OutArrayUInt32, RetArrayUInt32, StorageUInt32. 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).

Exceptions

Exception	Condition
ArgumentException	if elements of axes are smaller than -A.S.NumberOfDimensions;

Remarks

Summing over virtual dimensions is allowed. The result corresponds to A and has the same shape and the same elements.

Elements of axes may be negative. Corresponding dimension indices are considered as counting from the end of the range of existing dimensions in A.

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

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.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

sum Overload

ILNumerics Namespace

ExtensionMethodssum(ConcreteArrayUInt32, ArrayUInt32, InArrayUInt32, OutArrayUInt32, RetArrayUInt32, StorageUInt32, Int32, Boolean)

ExtensionMethodssum(ConcreteArrayUInt32, ArrayUInt32, InArrayUInt32, OutArrayUInt32, RetArrayUInt32, StorageUInt32, Boolean)