ILMathpermuteT Method (BaseArrayT, InArrayInt32)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Note: This API is now obsolete.

Reorder dimensions of n-dimensional array A.

[ILNumerics Computing Engine]

Namespace: ILNumerics
Assembly: ILNumerics.Computing (in ILNumerics.Computing.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

[ObsoleteAttribute("Use overloads expecting dimension order argument as long or uint elements!")]
public static RetArray<T> permute<T>(
	BaseArray<T> A,
	InArray<int> dim
)

<ObsoleteAttribute("Use overloads expecting dimension order argument as long or uint elements!")>
Public Shared Function permute(Of T) ( 
	A As BaseArray(Of T),
	dim As InArray(Of Integer)
) As RetArray(Of T)

Dim A As BaseArray(Of T)
Dim dim As InArray(Of Integer)
Dim returnValue As RetArray(Of T)

returnValue = ILMath.permute(A, dim)

Parameters

A: Type: ILNumericsBaseArrayT
Input array
dim: Type: ILNumericsInArrayInt32
New dimension order. The order of the zero-based indices of the original dimensions specify the target arrays shape.

Type Parameters

T

Return Value

Type: RetArrayT
Array with reordered dimensions.

Exceptions

Exception	Condition
ArgumentException	If the number of elements in A and the number of elements for the new dimensions specified by dim do not match or if any index of a dimension from A is missing in list of elements in dim.

Remarks

A will not change. A new array is created, having the dimensions rearranged in the order specified by dim.

The length of dim must match the number of dimensions in A: A.S.NumberOfDimensions == dim.Length.

From version 5 permute``1(BaseArrayUMP, InArrayInt32) is much more efficient since no elements must be copied for a permutation of the dimensions.

[ILNumerics Computing Engine]

Reference

ILMath Class

permute Overload

ILNumerics Namespace