UtilArray (ArrayT) | ArrayT

UtilArray Module

Namespace: ArrayT
Assembly: ArrayT.dll

Internal utilities for array operations and exception handling.

Types

Type	Description
DebugIndexer<'T>	A simple Wrapper for an array. The sole purpose is to provide a better Exception message when an index is out of range.

Functions and values

Function or value	Description
`badGetExn i arr funcName` Full Usage: `badGetExn i arr funcName` Parameters: i : `int` - The invalid index. arr : `'T[]` - The input array. funcName : `string` - The name of the function that failed. Returns: `'a` Never returns (always raises).	Raises an IndexOutOfRangeException for invalid get operations. i : `int` The invalid index. arr : `'T[]` The input array. funcName : `string` The name of the function that failed. Returns: `'a` Never returns (always raises).
`badSetExn i arr funcName doingSet` Full Usage: `badSetExn i arr funcName doingSet` Parameters: i : `int` - The invalid index. arr : `'T[]` - The input array. funcName : `string` - The name of the function that failed. doingSet : `'T` - The value being set. Returns: `'a` Never returns (always raises).	Raises an IndexOutOfRangeException for invalid set operations. i : `int` The invalid index. arr : `'T[]` The input array. funcName : `string` The name of the function that failed. doingSet : `'T` The value being set. Returns: `'a` Never returns (always raises).
`contentAsString entriesToPrint arr` Full Usage: `contentAsString entriesToPrint arr` Parameters: entriesToPrint : `int` - The maximum number of entries to display. arr : `'T[]` - The input array. Returns: `string` A formatted string showing array contents.	Returns a string with the content of the array up to 'entriesToPrint' entries. Includes the index of each entry. Includes the last entry (prints one extra if only one more remains to avoid "..."). entriesToPrint : `int` The maximum number of entries to display. arr : `'T[]` The input array. Returns: `string` A formatted string showing array contents.
`fail arr funcAndReason` Full Usage: `fail arr funcAndReason` Parameters: arr : `'T[]` - The input array. funcAndReason : `string` - A string describing the function and reason for failure. Returns: `'a` Never returns (always raises).	Raises an ArgumentException with a descriptive message about array operation failure. arr : `'T[]` The input array. funcAndReason : `string` A string describing the function and reason for failure. Returns: `'a` Never returns (always raises).
`getUnCkd i arr` Full Usage: `getUnCkd i arr` Parameters: i : `int` - The index to access. arr : `'T[]` - The input array. Returns: `'T` The value at the specified index. Modifiers: inline Type parameters: 'T	Gets the value at index i, skipping bounds check in compiled JS code. i : `int` The index to access. arr : `'T[]` The input array. Returns: `'T` The value at the specified index.
`negIdx i len` Full Usage: `negIdx i len` Parameters: i : `int` - The index to convert (can be negative). len : `int` - The length of the array. Returns: `int` The converted positive index. Modifiers: inline	Converts negative indices to positive ones. Correct results from -length up to length-1. e.g.: -1 is last item. (from the release of F# 5 on a negative index can also be done with '^' prefix. E.g. ^0 for the last item) i : `int` The index to convert (can be negative). len : `int` The length of the array. Returns: `int` The converted positive index.
`negIdxLooped i length` Full Usage: `negIdxLooped i length` Parameters: i : `int` - The index to convert (can be any integer). length : `int` - The length of the array (must be > 0). Returns: `int` A valid looped index. Modifiers: inline	Any int will give a valid index for given collection size. Converts negative indices to positive ones and loops to start after last index is reached. Returns a valid index for a collection of 'length' items for any integer. Requires length > 0. i : `int` The index to convert (can be any integer). length : `int` The length of the array (must be > 0). Returns: `int` A valid looped index.
`nullExn funcName` Full Usage: `nullExn funcName` Parameters: funcName : `string` - The name of the function that received null input. Returns: `'a` Never returns (always raises).	Raises an ArgumentNullException for a null array input. funcName : `string` The name of the function that received null input. Returns: `'a` Never returns (always raises).
`setUnCkd i v arr` Full Usage: `setUnCkd i v arr` Parameters: i : `int` - The index to set. v : `'T` - The value to set. arr : `'T[]` - The input array. Modifiers: inline Type parameters: 'T	Sets the value at index i, skipping bounds check in compiled JS code. i : `int` The index to set. v : `'T` The value to set. arr : `'T[]` The input array.
`toStringCore ofType arr` Full Usage: `toStringCore ofType arr` Parameters: ofType : `'a` - The type name as a string. arr : `'T[]` - The input array. Returns: `string` A string describing the array. Modifiers: inline Type parameters: 'a, 'T	Converts an array to a string representation showing its type and item count. ofType : `'a` The type name as a string. arr : `'T[]` The input array. Returns: `string` A string describing the array.
`toStringInline arr` Full Usage: `toStringInline arr` Parameters: arr : `'T[]` - The input array. Returns: `string` A string describing the array. Modifiers: inline Type parameters: 'T	Converts an array to a string representation using runtime type information. arr : `'T[]` The input array. Returns: `string` A string describing the array.