ExtensionMethodssum Method (ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, Boolean)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Create a scalar array with the sum of all 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<double> sum(
	this ConcreteArray<double, Array<double>, InArray<double>, OutArray<double>, RetArray<double>, Storage<double>> A,
	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)),
	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 keepdims As Boolean
Dim returnValue As RetArray(Of Double)

returnValue = A.sum(keepdims)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble
The source array. This will not be altered.
keepdims (Optional): Type: SystemBoolean
[Optional] accumulated dimensions remain in the resulting array. Default: (false) accumulated singleton dimensions are removed.

Return Value

Type: RetArrayDouble
A scalar array with the sum of all elements of A.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble. 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.

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

ExtensionMethodssum(ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, Int32, Boolean)

ExtensionMethodssum(ConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble, Boolean)