chore: clean-up

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/pop/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # pop
 
-> Return an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
+> Return an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -40,9 +40,9 @@ limitations under the License.
 var pop = require( '@stdlib/ndarray/base/pop' );
 ```
 
-#### pop( x, dim, strict, writable )
+#### pop( x, dim, writable )
 
-Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
+Returns an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.
 
 ```javascript
 var ndarray = require( '@stdlib/ndarray/ctor' );
@@ -62,7 +62,7 @@ var sh = x.shape;
 var arr = ndarray2array( x );
 // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 
-var y = pop( x, 0, false, false );
+var y = pop( x, 0, false );
 // returns [ <ndarray>, <ndarray> ]
 
 arr = ndarray2array( y[ 0 ] );
@@ -76,7 +76,6 @@ The function accepts the following arguments:
 
 -   **x**: input ndarray.
 -   **dim**: dimension along which to perform the operation. If provided an integer less than zero, the dimension index is resolved relative to the last dimension, with the last dimension corresponding to the value `-1`.
--   **strict**: boolean indicating whether to enforce strict bounds checking.
 -   **writable**: boolean indicating whether a returned ndarray should be writable.
 
 </section>
@@ -109,17 +108,17 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var zeroTo = require( '@stdlib/array/base/zero-to' );
 var pop = require( '@stdlib/ndarray/base/pop' );
 
-// Create a linear ndarray buffer:
+// Create a linear data buffer:
 var buf = zeroTo( 27 );
 
-// Create an ndarray which is a stack of three 3x3 matrices:
+// Create an ndarray:
 var x = array( buf, {
     'shape': [ 3, 3, 3 ]
 });
+console.log( ndarray2array( x ) );
 
-// Get the first two rows of each matrix:
-var y = pop( x, 1, false, false );
-// returns [ <ndarray>, <ndarray> ]
+// Remove the last row from each matrix:
+var y = pop( x, 1, false );
 
 console.log( ndarray2array( y[ 0 ] ) );
 console.log( ndarray2array( y[ 1 ] ) );

lib/node_modules/@stdlib/ndarray/base/pop/benchmark/benchmark.js

@@ -48,7 +48,7 @@ bench( pkg+'::1d', function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = pop( values[ i%values.length ], 0, false, false );
+		v = pop( values[ i%values.length ], 0, false );
 		if ( typeof v !== 'object' ) {
 			b.fail( 'should return an array of ndarrays' );
 		}
@@ -66,21 +66,21 @@ bench( pkg+'::2d', function benchmark( b ) {
 	var v;
 	var i;
 
-	/* eslint-disable object-curly-newline */
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	values = [
-		empty( [ 2, 2 ], { 'dtype': 'float64' }),
-		empty( [ 2, 2 ], { 'dtype': 'float32' }),
-		empty( [ 2, 2 ], { 'dtype': 'int32' }),
-		empty( [ 2, 2 ], { 'dtype': 'complex128' }),
-		empty( [ 2, 2 ], { 'dtype': 'generic' })
+		empty( [ 2, 2 ], { 'dtype': 'float64' } ),
+		empty( [ 2, 2 ], { 'dtype': 'float32' } ),
+		empty( [ 2, 2 ], { 'dtype': 'int32' } ),
+		empty( [ 2, 2 ], { 'dtype': 'complex128' } ),
+		empty( [ 2, 2 ], { 'dtype': 'generic' } )
 	];
 
-	/* eslint-enable object-curly-newline */
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = pop( values[ i%values.length ], 0, false, false );
+		v = pop( values[ i%values.length ], 0, false );
 		if ( typeof v !== 'object' ) {
 			b.fail( 'should return an array of ndarrays' );
 		}
@@ -98,21 +98,21 @@ bench( pkg+'::3d', function benchmark( b ) {
 	var v;
 	var i;
 
-	/* eslint-disable object-curly-newline */
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	values = [
-		empty( [ 2, 2, 2 ], { 'dtype': 'float64' }),
-		empty( [ 2, 2, 2 ], { 'dtype': 'float32' }),
-		empty( [ 2, 2, 2 ], { 'dtype': 'int32' }),
-		empty( [ 2, 2, 2 ], { 'dtype': 'complex128' }),
-		empty( [ 2, 2, 2 ], { 'dtype': 'generic' })
+		empty( [ 2, 2, 2 ], { 'dtype': 'float64' } ),
+		empty( [ 2, 2, 2 ], { 'dtype': 'float32' } ),
+		empty( [ 2, 2, 2 ], { 'dtype': 'int32' } ),
+		empty( [ 2, 2, 2 ], { 'dtype': 'complex128' } ),
+		empty( [ 2, 2, 2 ], { 'dtype': 'generic' } )
 	];
 
-	/* eslint-enable object-curly-newline */
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = pop( values[ i%values.length ], 0, false, false );
+		v = pop( values[ i%values.length ], 0, false );
 		if ( typeof v !== 'object' ) {
 			b.fail( 'should return an array of ndarrays' );
 		}
@@ -130,21 +130,21 @@ bench( pkg+'::4d', function benchmark( b ) {
 	var v;
 	var i;
 
-	/* eslint-disable object-curly-newline */
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	values = [
-		empty( [ 2, 2, 2, 2 ], { 'dtype': 'float64' }),
-		empty( [ 2, 2, 2, 2 ], { 'dtype': 'float32' }),
-		empty( [ 2, 2, 2, 2 ], { 'dtype': 'int32' }),
-		empty( [ 2, 2, 2, 2 ], { 'dtype': 'complex128' }),
-		empty( [ 2, 2, 2, 2 ], { 'dtype': 'generic' })
+		empty( [ 2, 2, 2, 2 ], { 'dtype': 'float64' } ),
+		empty( [ 2, 2, 2, 2 ], { 'dtype': 'float32' } ),
+		empty( [ 2, 2, 2, 2 ], { 'dtype': 'int32' } ),
+		empty( [ 2, 2, 2, 2 ], { 'dtype': 'complex128' } ),
+		empty( [ 2, 2, 2, 2 ], { 'dtype': 'generic' } )
 	];
 
-	/* eslint-enable object-curly-newline */
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = pop( values[ i%values.length ], 0, false, false );
+		v = pop( values[ i%values.length ], 0, false );
 		if ( typeof v !== 'object' ) {
 			b.fail( 'should return an array of ndarrays' );
 		}
@@ -162,21 +162,21 @@ bench( pkg+'::5d', function benchmark( b ) {
 	var v;
 	var i;
 
-	/* eslint-disable object-curly-newline */
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	values = [
-		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float64' }),
-		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float32' }),
-		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'int32' }),
-		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'complex128' }),
-		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'generic' })
+		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float64' } ),
+		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float32' } ),
+		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'int32' } ),
+		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'complex128' } ),
+		empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'generic' } )
 	];
 
-	/* eslint-enable object-curly-newline */
+	/* eslint-enable object-curly-newline, stdlib/line-closing-bracket-spacing */
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		v = pop( values[ i%values.length ], 0, false, false );
+		v = pop( values[ i%values.length ], 0, false );
 		if ( typeof v !== 'object' ) {
 			b.fail( 'should return an array of ndarrays' );
 		}

lib/node_modules/@stdlib/ndarray/base/pop/docs/repl.txt

@@ -1,36 +1,34 @@
 
-{{alias}}( x, dim, strict, writable )
-    Returns an array containing a truncated view of an input ndarray and a
-    complementary view of the last element(s) along a specified dimension.
+{{alias}}( x, dim, writable )
+    Returns an array containing a truncated view of an input ndarray and a view
+    of the last element(s) along a specified dimension.
 
     Parameters
     ----------
     x: ndarray
-        Input array.
+        Input ndarray.
 
     dim: integer
         Dimension along which to perform the operation. If provided an integer
         less than zero, the dimension index is resolved relative to the last
         dimension, with the last dimension corresponding to the value `-1`.
 
-    strict: boolean
-        Boolean indicating whether to enforce strict bounds checking.
-
     writable: boolean
         Boolean indicating whether a returned ndarray should be writable. This
         parameter only applies to ndarray constructors which support read-only
         instances.
 
     Returns
     -------
-    out: array
-        Output array.
+    out: Array<ndarray>
+        An array containing a truncated view of an input ndarray and a view of
+        the last element(s) along a specified dimension.
 
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
     <ndarray>
-    > var y = {{alias}}( x, 1, false, false )
+    > var y = {{alias}}( x, 1, false )
     [ <ndarray>, <ndarray> ]
     > {{alias:@stdlib/ndarray/to-array}}( y[0] )
     [ [ 1 ], [ 3 ] ]

lib/node_modules/@stdlib/ndarray/base/pop/docs/types/index.d.ts

@@ -20,17 +20,13 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { typedndarray, genericndarray } from '@stdlib/types/ndarray';
-import { ComplexLike } from '@stdlib/types/complex';
-import { ArrayLike } from '@stdlib/types/array';
-
+import { ndarray } from '@stdlib/types/ndarray';
 
 /**
-* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
+* Returns an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.
 *
 * @param x - input array
 * @param dim - dimension along which to perform the operation
-* @param strict - boolean indicating whether to enforce strict bounds checking
 * @param writable - boolean indicating whether returned arrays should be writable
 * @returns a list of ndarrays
 *
@@ -50,114 +46,7 @@ import { ArrayLike } from '@stdlib/types/array';
 * var arr = ndarray2array( x );
 * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* var y = pop( x, 0, false, false );
-* // returns [ <ndarray>, <ndarray> ]
-*
-* arr = ndarray2array( y[ 0 ] );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
-*
-* arr = ndarray2array( y[ 1 ] );
-* // returns [ [ 5.0, 6.0 ] ]
-*/
-declare function pop<T extends typedndarray<number> = typedndarray<number>>( x: T, dim: number, strict: boolean, writable: boolean ): ArrayLike<T>;
-
-/**
-* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
-*
-* @param x - input array
-* @param dim - dimension along which to perform the operation
-* @param strict - boolean indicating whether to enforce strict bounds checking
-* @param writable - boolean indicating whether returned arrays should be writable
-* @returns a list of ndarrays
-*
-* @example
-* var Complex64Array = require( '@stdlib/array/complex64' );
-* var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
-*
-* var buffer = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
-* var shape = [ 2, 2 ];
-* var strides = [ 2, 1 ];
-* var offset = 0;
-*
-* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( x );
-* // returns [ [ 1.0, 2.0, 3.0, 4.0 ], [ 5.0, 6.0, 7.0, 8.0 ] ]
-*
-* var y = pop( x, 0, false, false );
-* // returns [ <ndarray>, <ndarray> ]
-*
-* arr = ndarray2array( y[ 0 ] );
-* // returns [ [ 1.0, 2.0 ], [ 5.0, 6.0 ] ]
-*
-* arr = ndarray2array( y[ 1 ] );
-* // returns [ [ 2.0, 3.0 ], [ 7.0, 8.0 ] ]
-*/
-declare function pop<T extends ComplexLike = ComplexLike, U extends typedndarray<T> = typedndarray<T>>( x: U, dim: number, strict: boolean, writable: boolean ): ArrayLike<U>;
-
-/**
-* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
-*
-* @param x - input array
-* @param dim - dimension along which to perform the operation
-* @param strict - boolean indicating whether to enforce strict bounds checking
-* @param writable - boolean indicating whether returned arrays should be writable
-* @returns a list of ndarrays
-*
-* @example
-* var BooleanArray = require( '@stdlib/array/bool' );
-* var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
-*
-* var buffer = new BooleanArray( [ true, false, true, false, true, false ] );
-* var shape = [ 3, 2 ];
-* var strides = [ 2, 1 ];
-* var offset = 0;
-*
-* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( x );
-* // returns [ [ true, false ], [ true, false ], [ true, false ] ]
-*
-* var y = pop( x, 0, false, false );
-* // returns [ <ndarray>, <ndarray> ]
-*
-* arr = ndarray2array( y[ 0 ] );
-* // returns [ [ true, false ], [ true, false ] ]
-*
-* arr = ndarray2array( y[ 1 ] );
-* // returns [ [ true, false ] ]
-*/
-declare function pop<T extends typedndarray<boolean> = typedndarray<boolean>>( x: T, dim: number, strict: boolean, writable: boolean ): ArrayLike<T>;
-
-/**
-* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
-*
-* @param x - input array
-* @param dim - dimension along which to perform the operation
-* @param strict - boolean indicating whether to enforce strict bounds checking
-* @param writable - boolean indicating whether returned arrays should be writable
-* @returns a list of ndarrays
-*
-* @example
-* var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
-*
-* var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
-* var shape = [ 3, 2 ];
-* var strides = [ 2, 1 ];
-* var offset = 0;
-*
-* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( x );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
-*
-* var y = pop( x, 0, false, false );
+* var y = pop( x, 0, false );
 * // returns [ <ndarray>, <ndarray> ]
 *
 * arr = ndarray2array( y[ 0 ] );
@@ -166,7 +55,7 @@ declare function pop<T extends typedndarray<boolean> = typedndarray<boolean>>( x
 * arr = ndarray2array( y[ 1 ] );
 * // returns [ [ 5.0, 6.0 ] ]
 */
-declare function pop<T = unknown, U extends genericndarray<T> = genericndarray<T>>( x: U, dim: number, strict: boolean, writable: boolean ): ArrayLike<U>;
+declare function pop<T extends ndarray = ndarray>( x: T, dim: number, writable: boolean ): [ T, T ];
 
 
 // EXPORTS //