feat: add ndarray/base/pop

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

@@ -0,0 +1,154 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+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.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var pop = require( '@stdlib/ndarray/base/pop' );
+```
+
+#### pop( 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.
+
+```javascript
+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 sh = x.shape;
+// returns [ 3, 2 ]
+
+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 ] ]
+```
+
+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>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+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:
+var buf = zeroTo( 27 );
+
+// Create an ndarray which is a stack of three 3x3 matrices:
+var x = array( buf, {
+    'shape': [ 3, 3, 3 ]
+});
+
+// Get the first two rows of each matrix:
+var y = pop( x, 1, false, false );
+// returns [ <ndarray>, <ndarray> ]
+
+console.log( ndarray2array( y[ 0 ] ) );
+console.log( ndarray2array( y[ 1 ] ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,190 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var empty = require( '@stdlib/ndarray/empty' );
+var pkg = require( './../package.json' ).name;
+var pop = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+'::1d', function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline, stdlib/line-closing-bracket-spacing */
+
+	values = [
+		empty( [ 2 ], { 'dtype': 'float64' } ),
+		empty( [ 2 ], { 'dtype': 'float32' } ),
+		empty( [ 2 ], { 'dtype': 'int32' } ),
+		empty( [ 2 ], { 'dtype': 'complex128' } ),
+		empty( [ 2 ], { 'dtype': 'generic' } )
+	];
+
+	/* 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 );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array of ndarrays' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::2d', function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline */
+
+	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' })
+	];
+
+	/* eslint-enable object-curly-newline */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = pop( values[ i%values.length ], 0, false, false );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array of ndarrays' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::3d', function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline */
+
+	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' })
+	];
+
+	/* eslint-enable object-curly-newline */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = pop( values[ i%values.length ], 0, false, false );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array of ndarrays' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::4d', function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline */
+
+	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' })
+	];
+
+	/* eslint-enable object-curly-newline */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = pop( values[ i%values.length ], 0, false, false );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array of ndarrays' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::5d', function benchmark( b ) {
+	var values;
+	var v;
+	var i;
+
+	/* eslint-disable object-curly-newline */
+
+	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' })
+	];
+
+	/* eslint-enable object-curly-newline */
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = pop( values[ i%values.length ], 0, false, false );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array of ndarrays' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

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

@@ -0,0 +1,41 @@
+
+{{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.
+
+    Parameters
+    ----------
+    x: ndarray
+        Input array.
+
+    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.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
+    <ndarray>
+    > var y = {{alias}}( x, 1, false, false )
+    [ <ndarray>, <ndarray> ]
+    > {{alias:@stdlib/ndarray/to-array}}( y[0] )
+    [ [ 1 ], [ 3 ] ]
+    > {{alias:@stdlib/ndarray/to-array}}( y[1] )
+    [ [ 2 ], [ 4 ] ]
+
+    See Also
+    --------