ExtensionMethodscumsumIndT Method (ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32, IndT)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Computes the cumulative sum of elements of A along dimension axis.

[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<int> cumsum<IndT>(
	this ConcreteArray<int, Array<int>, InArray<int>, OutArray<int>, RetArray<int>, Storage<int>> A,
	IndT axis
)
where IndT : struct, new(), IConvertible

<ExtensionAttribute>
Public Shared Function cumsum(Of IndT As {Structure, New, IConvertible}) ( 
	A As ConcreteArray(Of Integer, Array(Of Integer), InArray(Of Integer), OutArray(Of Integer), RetArray(Of Integer), Storage(Of Integer)),
	axis As IndT
) As RetArray(Of Integer)

Dim A As ConcreteArray(Of Integer, Array(Of Integer), InArray(Of Integer), OutArray(Of Integer), RetArray(Of Integer), Storage(Of Integer))
Dim axis As IndT
Dim returnValue As RetArray(Of Integer)

returnValue = A.cumsum(axis)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32
The source array. This will not be altered.
axis: Type: IndT
Dimension of A to compute the cumulative sum along. A negative value counts from the last dimension.

Type Parameters

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

Return Value

Type: RetArrayInt32
Array of the same shape as A.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayInt32, ArrayInt32, InArrayInt32, OutArrayInt32, RetArrayInt32, StorageInt32. 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 axis are smaller than -A.S.NumberOfDimensions;

Remarks

axis must lay in the range of existing dimension indices.

Elements of axis 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 empty arrays of the same shape.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

cumsum Overload

ILNumerics Namespace

ExtensionMethodscumsum(ConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex)

ExtensionMethodssum(ConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex, Boolean)

ExtensionMethodssumIndT(ConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex, BaseArrayIndT, Boolean)