Auto-generated commit

Author: stdlib-bot

.editorconfig

@@ -148,11 +148,6 @@ indent_size = 2
 indent_style = space
 indent_size = 2
 
-# Set properties for `tslint.json` files:
-[tslint.json]
-indent_style = space
-indent_size = 2
-
 # Set properties for `tsconfig.json` files:
 [tsconfig.json]
 indent_style = space

.github/.keepalive

@@ -119,7 +119,7 @@ jobs:
           # For all dependencies, check in all *.js files if they are still used; if not, remove them:
           jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do
             dep=$(echo "$dep" | xargs)
-            if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
+            if ! find lib -name "*.js" -exec grep -q "$dep" {} + && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
               jq --indent 2 "del(.dependencies[\"$dep\"])" ./package.json > ./package.json.tmp
               mv ./package.json.tmp ./package.json
             fi
@@ -129,7 +129,7 @@ jobs:
               continue
             fi
             dep=$(echo "$dep" | xargs)
-            if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
+            if ! find lib -name "*.js" -exec grep -q "$dep" {} + && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then
               jq --indent 2 "del(.devDependencies[\"$dep\"])" ./package.json > ./package.json.tmp
               mv ./package.json.tmp ./package.json
             fi

.github/workflows/publish.yml

@@ -9,6 +9,7 @@ Brendan Graetz <[email protected]>
 Bruno Fenzl <[email protected]>
 Christopher Dambamuromo <[email protected]>
 Dan Rose <[email protected]>
+Daniel Killenberger <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
 Frank Kovacs <[email protected]>
@@ -29,6 +30,7 @@ Ognjen Jevremović <[email protected]>
 Philipp Burckhardt <[email protected]>
 Pranav Goswami <[email protected]>
 Ricky Reusser <[email protected]>
+Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
 Ryan Seal <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
@@ -37,4 +39,3 @@ Stephannie Jiménez Gacha <[email protected]>
 Yernar Yergaziyev <[email protected]>
 orimiles5 <[email protected]>
 rei2hu <[email protected]>
-Robert Gislason <[email protected]>

CONTRIBUTORS

@@ -77,14 +77,15 @@ Returns a list of ndarray index modes.
 
 ```javascript
 var out = modes();
-// returns [ 'throw', 'clamp', 'wrap' ]
+// returns [ 'throw', 'normalize', 'clamp', 'wrap' ]
 ```
 
-The output `array` contains the following modes:
+The output array contains the following modes:
 
--   `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 `0` to `0` (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 `0` to `0` (minimum index) and set an index greater than a maximum index value to the maximum possible index.
 
 </section>
 
@@ -111,7 +112,6 @@ var indexOf = require( '@stdlib/utils-index-of' );
 var modes = require( '@stdlib/ndarray-index-modes' );
 
 var MODES = modes();
-var bool;
 
 function isMode( str ) {
     if ( indexOf( MODES, str ) === -1 ) {
@@ -120,7 +120,10 @@ function isMode( str ) {
     return true;
 }
 
-bool = isMode( 'throw' );
+var bool = isMode( 'throw' );
+// returns true
+
+bool = isMode( 'normalize' );
 // returns true
 
 bool = isMode( 'clamp' );

README.md

@@ -6,6 +6,8 @@
 
     - 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
@@ -20,7 +22,7 @@
     Examples
     --------
     > var out = {{alias}}()
-    [ 'throw', 'clamp', 'wrap' ]
+    [ 'throw', 'normalize', 'clamp', 'wrap' ]
 
     See Also
     --------

dist/index.js

@@ -25,19 +25,20 @@
 *
 * -   The output array contains the following modes:
 *
-*     -   throw: specifies that a function should throw an error when an index is
+*     -   **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
+*     -   **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
+*     -   **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.
 *
 * @returns list of ndarray index modes
 *
 * @example
 * var list = modes();
-* // returns [ 'throw', 'clamp', 'wrap' ]
+* // returns [ 'throw', 'normalize', 'clamp', 'wrap' ]
 */
 declare function modes(): Array<string>;
 

dist/index.js.map

@@ -22,7 +22,6 @@ var indexOf = require( '@stdlib/utils-index-of' );
 var modes = require( './../lib' );
 
 var MODES = modes();
-var bool;
 
 function isMode( str ) {
 	if ( indexOf( MODES, str ) === -1 ) {
@@ -31,7 +30,11 @@ function isMode( str ) {
 	return true;
 }
 
-bool = isMode( 'throw' );
+var bool = isMode( 'throw' );
+console.log( bool );
+// => true
+
+bool = isMode( 'normalize' );
 console.log( bool );
 // => true
 

docs/repl.txt

@@ -25,7 +25,8 @@
 enum STDLIB_NDARRAY_INDEX_MODE {
 	STDLIB_NDARRAY_INDEX_ERROR = 1,
 	STDLIB_NDARRAY_INDEX_CLAMP = 2,
-	STDLIB_NDARRAY_INDEX_WRAP = 3
+	STDLIB_NDARRAY_INDEX_WRAP = 3,
+	STDLIB_NDARRAY_INDEX_NORMALIZE = 4,
 };
 
 #endif // !STDLIB_NDARRAY_INDEX_MODES_H

docs/types/index.d.ts

@@ -39,7 +39,8 @@ function enumerated() {
 	return {
 		'throw': 1,
 		'clamp': 2,
-		'wrap': 3
+		'wrap': 3,
+		'normalize': 4
 	};
 }
 

examples/index.js

@@ -27,7 +27,7 @@
 * var modes = require( '@stdlib/ndarray-index-modes' );
 *
 * var list = modes();
-* // returns [ 'throw', 'clamp', 'wrap' ]
+* // returns [ 'throw', 'normalize', 'clamp', 'wrap' ]
 */
 
 // MODULES //

include/stdlib/ndarray/index_modes.h

@@ -32,7 +32,7 @@ var MODES = require( './modes.json' );
 *
 * @example
 * var list = modes();
-* // returns [ 'throw', 'clamp', 'wrap' ]
+* // returns [ 'throw', 'normalize', 'clamp', 'wrap' ]
 */
 function modes() {
 	return MODES.slice();

lib/enum.js

@@ -1,5 +1,6 @@
 [
 	"throw",
+  "normalize",
 	"clamp",
 	"wrap"
 ]

lib/index.js

@@ -45,7 +45,7 @@
     "@stdlib/assert-has-own-property": "^0.1.1",
     "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
     "@stdlib/assert-is-string-array": "^0.1.1",
-    "@stdlib/bench": "^0.1.0",
+    "@stdlib/bench": "^0.2.1",
     "@stdlib/utils-index-of": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",

lib/main.js

@@ -40,6 +40,7 @@ tape( 'the function returns a list of ndarray index modes', function test( t ) {
 
 	expected = [
 		'throw',
+		'normalize',
 		'clamp',
 		'wrap'
 	];
@@ -63,6 +64,7 @@ tape( 'attached to the main function is an `enum` method to return an object map
 	// List of index modes which should be supported...
 	m = [
 		'throw',
+		'normalize',
 		'clamp',
 		'wrap'
 	];