ExtensionMethods.sum Method (ConcreteArray<Double, Array<Double>, InArray<Double>, OutArray<Double>, RetArray<Double>, Storage<Double>>, 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.5.0.0 (5.5.7503.3146)

Syntax

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

<ExtensionAttribute>
Public Shared Function sum ( 
	A As ConcreteArray(Of Double, Array(Of Double), InArray(Of Double), OutArray(Of Double), RetArray(Of Double), Storage(Of Double)),
	axis As Integer,
	Optional keepdims As Boolean = false
) As RetArray(Of Double)

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

returnValue = A.sum(axis, keepdims)

Parameters

A: Type: ILNumerics.Core.Arrays.ConcreteArray<Double, Array<Double>, InArray<Double>, OutArray<Double>, RetArray<Double>, Storage<Double>>
The source array. This will not be altered.
axis: Type: System.Int32
The dimension to sum elements of A along.
keepdims (Optional): Type: System.Boolean
[Optional] the reduced dimension axis remains in the resulting array. Default: (false) the dimension axis is removed from the result.

Return Value

Type: RetArray<Double>
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 ConcreteArray<Double, Array<Double>, InArray<Double>, OutArray<Double>, RetArray<Double>, Storage<Double>>. 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]

Reference

ExtensionMethods Class

sum Overload

ILNumerics Namespace

ExtensionMethods.sum(ConcreteArray<Double, Array<Double>, InArray<Double>, OutArray<Double>, RetArray<Double>, Storage<Double>>, Int32, Boolean)

ExtensionMethods.sum(ConcreteArray<Double, Array<Double>, InArray<Double>, OutArray<Double>, RetArray<Double>, Storage<Double>>, Boolean)