feat: add support for normalize index mode

kgryte · kgryte · commit 1fc9020622fa · 2023-11-24T14:28:38.000-08:00
diff --git a/lib/node_modules/@stdlib/types/index.d.ts b/lib/node_modules/@stdlib/types/index.d.ts
@@ -35,7 +35,6 @@
 */
 declare module '@stdlib/types/array' {
 	import { ComplexLike, Complex64, Complex128 } from '@stdlib/types/complex';
-	import { Override } from '@stdlib/types/utilities';
 
 	/**
 	* Data type.
@@ -121,7 +120,7 @@ declare module '@stdlib/types/array' {
 		/**
 		* Properties.
 		*/
-		[key: string]: any;
+		[key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 		/**
 		* Number of elements.
@@ -277,7 +276,7 @@ declare module '@stdlib/types/array' {
 	* const x: AnyArray = [ 1, 2, 3 ];
 	* const y: AnyArray = new Float64Array( 10 );
 	*/
-	type AnyArray = Array<any> | RealOrComplexTypedArray;
+	type AnyArray = Array<any> | RealOrComplexTypedArray; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 	/**
 	* An array or typed array.
@@ -286,7 +285,7 @@ declare module '@stdlib/types/array' {
 	* const x: ArrayOrTypedArray = [ 1, 2, 3 ];
 	* const y: ArrayOrTypedArray = new Float64Array( 10 );
 	*/
-	type ArrayOrTypedArray = Array<any> | TypedArray;
+	type ArrayOrTypedArray = Array<any> | TypedArray; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 	/**
 	* A typed array.
@@ -533,7 +532,7 @@ declare module '@stdlib/types/array' {
 	* @example
 	* const x: Collection<number> = [ 1, 2, 3 ];
 	*/
-	type Collection<T = any> = Array<T> | TypedArray | ArrayLike<T>;
+	type Collection<T = any> = Array<T> | TypedArray | ArrayLike<T>; // eslint-disable-line @typescript-eslint/no-explicit-any
 }
 
 /**
@@ -576,7 +575,7 @@ declare module '@stdlib/types/iter' {
 		* @param value - value to return
 		* @returns iterator protocol-compliant object
 		*/
-		return?( value?: any ): IteratorResult;
+		return?( value?: any ): IteratorResult; // eslint-disable-line @typescript-eslint/no-explicit-any
 	}
 
 	/**
@@ -610,7 +609,7 @@ declare module '@stdlib/types/iter' {
 		/**
 		* Iterated value (if one exists).
 		*/
-		value?: any;
+		value?: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 		/**
 		* Boolean flag indicating whether an iterator is finished.
@@ -742,7 +741,7 @@ declare module '@stdlib/types/iter' {
 */
 declare module '@stdlib/types/ndarray' {
 	import { ArrayLike, AccessorArrayLike, Collection, Complex128Array, Complex64Array, RealOrComplexTypedArray, FloatOrComplexTypedArray, RealTypedArray, ComplexTypedArray, IntegerTypedArray, FloatTypedArray, SignedIntegerTypedArray, UnsignedIntegerTypedArray } from '@stdlib/types/array';
-	import { ComplexLike, Complex128, Complex64 } from '@stdlib/types/complex';
+	import { ComplexLike, Complex128, Complex64 } from '@stdlib/types/complex'; // eslint-disable-line no-duplicate-imports
 
 	/**
 	* Data type.
@@ -810,11 +809,12 @@ declare module '@stdlib/types/ndarray' {
 	*
 	* -   The following index modes are supported:
 	*
-	*     -   `throw`: specifies that a function should throw an error when an index is outside a restricted interval.
-	*     -   `wrap`: specifies that a function should wrap around an index using modulo arithmetic.
-	*     -   `clamp`: specifies that a function should set an index less than zero to zero (minimum index) and set an index greater than a maximum index value to the maximum possible index.
+	*     -   **throw**: specifies that a function should throw an error when an index is outside a restricted interval.
+	*     -   **normalize**: specifies that a function should normalize negative indices and throw an error when an index is outside a restricted interval.
+	*     -   **wrap**: specifies that a function should wrap around an index using modulo arithmetic.
+	*     -   **clamp**: specifies that a function should set an index less than zero to zero (minimum index) and set an index greater than a maximum index value to the maximum possible index.
 	*/
-	type Mode = 'throw' | 'clamp' | 'wrap';
+	type Mode = 'throw' | 'normalize' | 'clamp' | 'wrap';
 
 	/**
 	* Array shape.
@@ -1074,7 +1074,7 @@ declare module '@stdlib/types/ndarray' {
 		/**
 		* A reference to the underlying data buffer.
 		*/
-		data: ArrayLike<any> | AccessorArrayLike<any>;
+		data: ArrayLike<any> | AccessorArrayLike<any>; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 		/**
 		* Underlying data type.
@@ -1145,7 +1145,7 @@ declare module '@stdlib/types/ndarray' {
 		* @param args - subscripts
 		* @returns array element
 		*/
-		get( ...args: Array<number> ): any;
+		get( ...args: Array<number> ): any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 		/**
 		* Sets an array element specified according to provided subscripts.
@@ -1157,7 +1157,7 @@ declare module '@stdlib/types/ndarray' {
 		* @param args - subscripts and value to set
 		* @returns ndarray instance
 		*/
-		set( ...args: Array<any> ): ndarray;
+		set( ...args: Array<any> ): ndarray; // eslint-disable-line @typescript-eslint/no-explicit-any
 	}
 
 	/**
@@ -2618,8 +2618,6 @@ declare module '@stdlib/types/ndarray' {
 * };
 */
 declare module '@stdlib/types/object' {
-	import { ArrayLike, TypedArray } from '@stdlib/types/array';
-
 	/**
 	* Interface describing a data property descriptor object.
 	*
@@ -2812,7 +2810,7 @@ declare module '@stdlib/types/complex' {
 * const rand: PRNG = () => 3.14;
 */
 declare module '@stdlib/types/random' {
-	import { ArrayLike } from '@stdlib/types/array';
+	import { ArrayLike } from '@stdlib/types/array'; // eslint-disable-line no-duplicate-imports
 
 	/**
 	* A pseudorandom number generator (PRNG).
@@ -2886,7 +2884,7 @@ declare module '@stdlib/types/utilities' {
 * const s: slice.Slice = { 'start': 0, 'stop': 10, 'step': 1 };
 */
 declare module '@stdlib/types/slice' {
-	import { ArrayLike } from '@stdlib/types/array';
+	import { ArrayLike } from '@stdlib/types/array'; // eslint-disable-line no-duplicate-imports
 
 	/**
 	* A slice object.
