feat: document support for normalize index mode

kgryte · kgryte · commit 6ee30cdbe8fe · 2023-11-24T21:45:32.000-08:00
diff --git a/lib/node_modules/@stdlib/ndarray/fancy/README.md b/lib/node_modules/@stdlib/ndarray/fancy/README.md
@@ -111,6 +111,7 @@ The constructor accepts the following `options`:
 The constructor supports the following `modes`:
 
 -   **throw**: specifies that a `FancyArray` instance should throw an error when an index exceeds array dimensions.
+-   **normalize**: specifies that a `FancyArray` instance should normalize negative indices and throw an error when an index exceeds array dimensions.
 -   **wrap**: specifies that a `FancyArray` instance should wrap around an index exceeding array dimensions using modulo arithmetic.
 -   **clamp**: specifies that a `FancyArray` instance should set an index exceeding array dimensions to either `0` (minimum index) or the maximum index.
 
diff --git a/lib/node_modules/@stdlib/ndarray/fancy/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/fancy/docs/repl.txt
@@ -51,21 +51,25 @@
     options.mode: string (optional)
         Specifies how to handle indices which exceed array dimensions. If equal
         to 'throw', an ndarray instance throws an error when an index exceeds
+        array dimensions. If equal to 'normalize', an ndarray instance
+        normalizes negative indices and throws an error when an index exceeds
         array dimensions. If equal to 'wrap', an ndarray instance wraps around
         indices exceeding array dimensions using modulo arithmetic. If equal to
-        'clamp', an ndarray instance sets an index exceeding array dimensions to
-        either `0` (minimum index) or the maximum index. Default: 'throw'.
+        'clamp', an ndarray instance sets an index exceeding array dimensions
+        to either `0` (minimum index) or the maximum index. Default: 'throw'.
 
     options.submode: Array<string> (optional)
         Specifies how to handle subscripts which exceed array dimensions. If a
         mode for a corresponding dimension is equal to 'throw', an ndarray
         instance throws an error when a subscript exceeds array dimensions. If
-        equal to 'wrap', an ndarray instance wraps around subscripts exceeding
-        array dimensions using modulo arithmetic. If equal to 'clamp', an
-        ndarray instance sets a subscript exceeding array dimensions to either
-        `0` (minimum index) or the maximum index. If the number of modes is
-        fewer than the number of dimensions, the function recycles modes using
-        modulo arithmetic. Default: [ options.mode ].
+        equal to 'normalize', an ndarray instance normalizes negative
+        subscripts and throws an error when a subscript exceeds array
+        dimensions. If equal to 'wrap', an ndarray instance wraps around
+        subscripts exceeding array dimensions using modulo arithmetic. If equal
+        to 'clamp', an ndarray instance sets a subscript exceeding array
+        dimensions to either `0` (minimum index) or the maximum index. If the
+        number of modes is fewer than the number of dimensions, the function
+        recycles modes using modulo arithmetic. Default: [ options.mode ].
 
     options.readonly: boolean (optional)
         Boolean indicating whether an array should be read-only. Default: false.
