ConcreteArrayT1, LocalT, InT, OutT, RetT, StorageTSubarray Method (DimSpec, DimSpec, DimSpec, DimSpec, DimSpec)

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Extract part of this array. Matlab® and numpy indexing.

[ILNumerics Core Module]

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

Syntax

Copy

public RetT Subarray(
	DimSpec d0,
	DimSpec d1,
	DimSpec d2,
	DimSpec d3,
	DimSpec d4
)

Public Function Subarray ( 
	d0 As DimSpec,
	d1 As DimSpec,
	d2 As DimSpec,
	d3 As DimSpec,
	d4 As DimSpec
) As RetT

Dim instance As ConcreteArray
Dim d0 As DimSpec
Dim d1 As DimSpec
Dim d2 As DimSpec
Dim d3 As DimSpec
Dim d4 As DimSpec
Dim returnValue As RetT

returnValue = instance.Subarray(d0, d1, 
	d2, d3, d4)

Parameters

d0: Type: ILNumericsDimSpec
Range specification along dimension #0.
d1: Type: ILNumericsDimSpec
Range specification along dimension #1.
d2: Type: ILNumericsDimSpec
Range specification along dimension #2.
d3: Type: ILNumericsDimSpec
Range specification along dimension #3.
d4: Type: ILNumericsDimSpec
Range specification along dimension #4.

Return Value

Type: RetT
New array with parts of this array as specified by d0 ... d4.

Exceptions

Exception	Condition
IndexOutOfRangeException	if the range provided in a specifier d0,... addresses a non existing element.
NotSupportedException	if any of d0,... attempts to use an indexing feature which is not supported in the current ArrayStyle mode. For example, if d0 was provided as newaxis while being in ILNumericsV4 mode.

Remarks

This method considers the given dimensional range specifiers to extract a subarray from this array. Both indexing styles: numpy and Matlab® indexing (ILNumericsV4) are supported. For such indexing features specific to one or the other style the current setting of ArrayStyle is considered. In ILNumericsV4 array style (default) the last given dimension specifier may refer to elements inside merged, trailing, unspecified dimensions of this array (and not only inside this dimension) in the same manner as the 'linear indexing' feature known from Matlab®, Octave, ILNumerics version 4 et al.

Due to the simplicity of the specifiers d0, ... the subarray creation is optimized to be fast and efficient, often without requiring new memory for copying elements. Note, that the array returned may use the same element storage as this array. Only when trying to modify either one of this array or the subarray a copy will be made.

The setting MinNumberOfArrayDimensions is respected for the array returned.

[ILNumerics Core Module]