ILNumerics Ultimate VS

Size Methods

ILNumerics Ultimate VS Documentation
ILNumerics - Technical Application Development

The Size type exposes the following members.

Methods

  NameDescription
Public methodGetBSD
[EXPERT INTERFACE!] Gets a reference to the internal BSD array describing the sizes / strides of this size object. Use with care!

[ILNumerics Core Module]

Public methodGetElementSpan
Gets the element index of the last element addressed by this size descriptor.

[ILNumerics Core Module]

Public methodStatic memberGetElementSpan(Int64*)
Gets the element index of the last element addressed by a size descriptor.

[ILNumerics Core Module]

Public methodGetHashCode
Gets a hash code representing this size descriptors current content.

[ILNumerics Core Module]

(Overrides ObjectGetHashCode.)
Public methodGetPermuted
Permutes the dimension of an existing BSD.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64)
Retrieves the storage element index into an array stored according to this size descriptor object based on the provided sequential index d0. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32)
Retrieves the storage element index into an array stored according to this size descriptor object based on the provided sequential index d0.

[ILNumerics Core Module]

Public methodGetSeqIndex(InArrayInt64)
Retrieves the element index of an element located at indices stored in an array according to this size descriptor.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64, Int64)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d1. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32*, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided index array d.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 and d1.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64, Int64, Int64)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d2. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32, UInt32, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d2.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64, Int64, Int64, Int64)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d3. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32, UInt32, UInt32, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d3.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64, Int64, Int64, Int64, Int64)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d4. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32, UInt32, UInt32, UInt32, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d4.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64, Int64, Int64, Int64, Int64, Int64)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d5. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32, UInt32, UInt32, UInt32, UInt32, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d5.

[ILNumerics Core Module]

Public methodGetSeqIndex(Int64, Int64, Int64, Int64, Int64, Int64, Int64)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d6. Allows negative indices.

[ILNumerics Core Module]

Public methodGetSeqIndex(UInt32, UInt32, UInt32, UInt32, UInt32, UInt32, UInt32)
Retrieves the sequential index into an array stored according to this size descriptor object based on the provided indices d0 ... d6.

[ILNumerics Core Module]

Public methodGetSeqIndex_NP
Computes the memory element offset into an array stored according to this BSD to retrieve the element identified by the _row major_ sequential element index d0.

[ILNumerics Core Module]

Public methodGetShifted
Create a new BSD with a rotated version of the dimensions of this size descriptor.

[ILNumerics Core Module]

Public methodGetStride
Get the spacing between elements in the dimension dim.

[ILNumerics Core Module]

Public methodIsSameShape(InArrayInt64)
Compares the exact shape of this size to another size. Considering all dimensions.

[ILNumerics Core Module]

Public methodIsSameShape(Size)
Compares the exact shape of this size to another size. Considering all dimensions.

[ILNumerics Core Module]

Public methodIsSameSize
Compares this size to another size, ignoring leading and trailing singleton dimensions.

[ILNumerics Core Module]

Public methodSetAll
Set all values of this size descriptor.

[ILNumerics Core Module]

Public methodToIntArray Obsolete.
Gets the lengths of the dimensions of the array associated with this size object.

[ILNumerics Core Module]

Public methodToString
Pretty print dimensions in the format "[a,b,c]".

[ILNumerics Core Module]

(Overrides ObjectToString.)
Public methodWorkingDimension
Find working dimension to work on. Array style dependent.

[ILNumerics Core Module]

Top
Extension Methods

  NameDescription
Public Extension MethodIterator
Efficient iterator over the array for use in foreach loops.

[ILNumerics Core Module]

(Defined by ExtensionMethods.)
Top
See Also

Reference