ExtensionMethodsround Method (ConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex, Int32)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Creates an array with elements of A, rounded to the specified number of fractional digits.

[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<complex> round(
	this ConcreteArray<complex, Array<complex>, InArray<complex>, OutArray<complex>, RetArray<complex>, Storage<complex>> A,
	int decimals = 0
)

<ExtensionAttribute>
Public Shared Function round ( 
	A As ConcreteArray(Of complex, Array(Of complex), InArray(Of complex), OutArray(Of complex), RetArray(Of complex), Storage(Of complex)),
	Optional decimals As Integer = 0
) As RetArray(Of complex)

Dim A As ConcreteArray(Of complex, Array(Of complex), InArray(Of complex), OutArray(Of complex), RetArray(Of complex), Storage(Of complex))
Dim decimals As Integer
Dim returnValue As RetArray(Of complex)

returnValue = A.round(decimals)

Parameters

A: Type: ILNumerics.Core.ArraysConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex
Input array.
decimals (Optional): Type: SystemInt32
[Optional] number of fractional digits to round to. Default: (0) round to integers.

Return Value

Type: RetArraycomplex
Array of same size as A with elements of A rounded towards the nearest even integer value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConcreteArraycomplex, Arraycomplex, InArraycomplex, OutArraycomplex, RetArraycomplex, Storagecomplex. 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

The operation is efficiently performed on all elements of the input array A.

The storage order of the array returned depends on the order of A. If A.IsContinuous is true the array returned will have the same StorageOrder as A. Otherwise, the elements of the returned array will be reordered in the order defined by DefaultStorageOrder (default: ColumnMajor).

The operation is performed in multiple threads, according to the current settings of MaxNumberThreads.

The input array A is not altered. However, if A's storage is suitable and not shared by other arrays its memory will be used for the result and the operation is performed 'inplace'.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

round Overload

ILNumerics Namespace