ExtensionMethodsflattenT1 Method (BaseArrayT1, StorageOrders)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

[numpy API] Returns a flattened copy of the source array. This is the same as ravelT1(BaseArrayT1, StorageOrders). See remarks for details.

[ILNumerics numpy Module]

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

Syntax

Copy

public static RetArray<T1> flatten<T1>(
	this BaseArray<T1> A,
	StorageOrders order = StorageOrders.RowMajor
)

<ExtensionAttribute>
Public Shared Function flatten(Of T1) ( 
	A As BaseArray(Of T1),
	Optional order As StorageOrders = StorageOrders.RowMajor
) As RetArray(Of T1)

Dim A As BaseArray(Of T1)
Dim order As StorageOrders
Dim returnValue As RetArray(Of T1)

returnValue = A.flatten(order)

Parameters

A: Type: ILNumericsBaseArrayT1
The source array.
order (Optional): Type: ILNumericsStorageOrders
[Optional] The storage order of the array returned. Default: row major.

Type Parameters

T1: Element type.

Return Value

Type: RetArrayT1
A new array having the same element number and -type as A flattened to a vector.

Usage Note

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

This is the same as 'A.Reshape(-1,order)'. Note that in ILNumerics all arrays semantically behave like copies.

[ILNumerics numpy Module]

Reference

ExtensionMethods Class

flatten Overload

ILNumerics Namespace

ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageTReshape(Int64, NullableStorageOrders)

ExtensionMethodsravelT1(BaseArrayT1, StorageOrders)