ArrayExtensions.DangerousGetReferenceAt Method

Definition

Namespace:

Microsoft.Toolkit.HighPerformance

Assembly:

Microsoft.Toolkit.HighPerformance.dll

Package:

Microsoft.Toolkit.HighPerformance v7.1.2

Overloads

DangerousGetReferenceAt<T>(T[], Int32)	Returns a reference to an element at a specified index within a given T array, with no bounds checks.
DangerousGetReferenceAt<T>(T[,], Int32, Int32)	Returns a reference to an element at a specified coordinate within a given 2D T array, with no bounds checks.
DangerousGetReferenceAt<T>(T[,,], Int32, Int32, Int32)	Returns a reference to an element at a specified coordinate within a given 3D T array, with no bounds checks.

DangerousGetReferenceAt<T>(T[], Int32)

Returns a reference to an element at a specified index within a given T array, with no bounds checks.

public static ref T DangerousGetReferenceAt<T> (this T[] array, int i);

static member DangerousGetReferenceAt : 'T[] * int -> 'T

<Extension()>
Public Function DangerousGetReferenceAt(Of T) (array As T(), i As Integer) As T

Type Parameters

T

The type of elements in the input T array instance.

Parameters

array

T[]

The input T array instance.

i

Int32

The index of the element to retrieve within array.

Returns

T

A reference to the element within array at the index specified by i.

Remarks

This method doesn't do any bounds checks, therefore it is responsibility of the caller to ensure the i parameter is valid.

DangerousGetReferenceAt<T>(T[,], Int32, Int32)

Returns a reference to an element at a specified coordinate within a given 2D T array, with no bounds checks.

public static ref T DangerousGetReferenceAt<T> (this T[,] array, int i, int j);

static member DangerousGetReferenceAt : 'T[,] * int * int -> 'T

<Extension()>
Public Function DangerousGetReferenceAt(Of T) (array As T(,), i As Integer, j As Integer) As T

Type Parameters

T

The type of elements in the input 2D T array instance.

Parameters

array

T[,]

The input 2D T array instance.

i

Int32

The vertical index of the element to retrieve within array.

j

Int32

The horizontal index of the element to retrieve within array.

Returns

T

A reference to the element within array at the coordinate specified by i and j.

Remarks

This method doesn't do any bounds checks, therefore it is responsibility of the caller to ensure the i and j parameters are valid. Furthermore, this extension will ignore the lower bounds for the input array, and will just assume that the input index is 0-based. It is responsibility of the caller to adjust the input indices to account for the actual lower bounds, if the input array has either axis not starting at 0.

DangerousGetReferenceAt<T>(T[,,], Int32, Int32, Int32)

Returns a reference to an element at a specified coordinate within a given 3D T array, with no bounds checks.

public static ref T DangerousGetReferenceAt<T> (this T[,,] array, int i, int j, int k);

static member DangerousGetReferenceAt : 'T[,,] * int * int * int -> 'T

<Extension()>
Public Function DangerousGetReferenceAt(Of T) (array As T(,,), i As Integer, j As Integer, k As Integer) As T

Type Parameters

T

The type of elements in the input 3D T array instance.

Parameters

array

T[,,]

The input 2D T array instance.

i

Int32

The depth index of the element to retrieve within array.

j

Int32

The vertical index of the element to retrieve within array.

k

Int32

The horizontal index of the element to retrieve within array.

Returns

T

A reference to the element within array at the coordinate specified by i and j.

Remarks

This method doesn't do any bounds checks, therefore it is responsibility of the caller to ensure the i and j parameters are valid. Furthermore, this extension will ignore the lower bounds for the input array, and will just assume that the input index is 0-based. It is responsibility of the caller to adjust the input indices to account for the actual lower bounds, if the input array has either axis not starting at 0.