ILNumerics - Technical Application Development

Array with the result of summing elements of A accordingly.

[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<double> sum<IndT>( this ConcreteArray<double, Array<double>, InArray<double>, OutArray<double>, RetArray<double>, Storage<double>> A, BaseArray<IndT> axes = null, bool keepdims = false ) where IndT : struct, new(), IConvertible

#### Parameters

- A
- Type: ILNumerics.Core.ArraysConcreteArrayDouble, ArrayDouble, InArrayDouble, OutArrayDouble, RetArrayDouble, StorageDouble

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: RetArrayDoubleArray 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 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).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]

See Also