Skip to content

Commit 5cecf5c

Browse files
headlessNodeheadlessNode
committed
feat: add ndarray/base/pop
1 parent 990705b commit 5cecf5c

File tree

10 files changed

+1171
-0
lines changed

10 files changed

+1171
-0
lines changed

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

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# pop
22+
23+
> Return an array containing a truncated view of an input ndarray and the last element along a specified dimension.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var pop = require( '@stdlib/ndarray/base/pop' );
41+
```
42+
43+
#### pop( x, dim, strict, writable )
44+
45+
Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
46+
47+
```javascript
48+
var ndarray = require( '@stdlib/ndarray/ctor' );
49+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
50+
51+
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
52+
var shape = [ 3, 2 ];
53+
var strides = [ 2, 1 ];
54+
var offset = 0;
55+
56+
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
57+
// returns <ndarray>
58+
59+
var sh = x.shape;
60+
// returns [ 3, 2 ]
61+
62+
var arr = ndarray2array( x );
63+
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
64+
65+
var y = pop( x, 0, false, false );
66+
// returns [ <ndarray>, <ndarray> ]
67+
68+
arr = ndarray2array( y[ 0 ] );
69+
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
70+
71+
arr = ndarray2array( y[ 1 ] );
72+
// returns [ [ 5.0, 6.0 ] ]
73+
```
74+
75+
The function accepts the following arguments:
76+
77+
- **x**: input ndarray.
78+
- **dim**: dimension along which to perform the operation.
79+
- **strict**: boolean indicating whether to enforce strict bounds checking.
80+
- **writable**: boolean indicating whether a returned ndarray should be writable.
81+
82+
</section>
83+
84+
<!-- /.usage -->
85+
86+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
87+
88+
<section class="notes">
89+
90+
## Notes
91+
92+
- The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
93+
94+
</section>
95+
96+
<!-- /.notes -->
97+
98+
<!-- Package usage examples. -->
99+
100+
<section class="examples">
101+
102+
## Examples
103+
104+
<!-- eslint no-undef: "error" -->
105+
106+
```javascript
107+
var array = require( '@stdlib/ndarray/array' );
108+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
109+
var zeroTo = require( '@stdlib/array/base/zero-to' );
110+
var pop = require( '@stdlib/ndarray/base/pop' );
111+
112+
// Create a linear ndarray buffer:
113+
var buf = zeroTo( 27 );
114+
115+
// Create an ndarray:
116+
var x = array( buf, {
117+
'shape': [ 3, 3, 3 ]
118+
});
119+
120+
// Get the first two rows of each matrix:
121+
var y = pop( x, 1, false, false );
122+
// returns [ <ndarray>, <ndarray> ]
123+
124+
console.log( ndarray2array( y[ 0 ] ) );
125+
126+
console.log( ndarray2array( y[ 1 ] ) );
127+
```
128+
129+
</section>
130+
131+
<!-- /.examples -->
132+
133+
<!-- 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. -->
134+
135+
<section class="references">
136+
137+
</section>
138+
139+
<!-- /.references -->
140+
141+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
142+
143+
<section class="related">
144+
145+
</section>
146+
147+
<!-- /.related -->
148+
149+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
150+
151+
<section class="links">
152+
153+
</section>
154+
155+
<!-- /.links -->

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

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2023 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
25+
var empty = require( '@stdlib/ndarray/empty' );
26+
var pkg = require( './../package.json' ).name;
27+
var pop = require( './../lib' );
28+
29+
30+
// MAIN //
31+
32+
bench( pkg+'::1d', function benchmark( b ) {
33+
var values;
34+
var v;
35+
var i;
36+
37+
/* eslint-disable object-curly-newline */
38+
39+
values = [
40+
empty( [ 2 ], { 'dtype': 'float64' }),
41+
empty( [ 2 ], { 'dtype': 'float32' }),
42+
empty( [ 2 ], { 'dtype': 'int32' }),
43+
empty( [ 2 ], { 'dtype': 'complex128' }),
44+
empty( [ 2 ], { 'dtype': 'generic' })
45+
];
46+
47+
/* eslint-enable object-curly-newline */
48+
49+
b.tic();
50+
for ( i = 0; i < b.iterations; i++ ) {
51+
v = pop( values[ i%values.length ], 0, false, false );
52+
if ( typeof v !== 'object' ) {
53+
b.fail( 'should return an array of ndarrays' );
54+
}
55+
}
56+
b.toc();
57+
if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
58+
b.fail( 'should return an array of ndarrays' );
59+
}
60+
b.pass( 'benchmark finished' );
61+
b.end();
62+
});
63+
64+
bench( pkg+'::2d', function benchmark( b ) {
65+
var values;
66+
var v;
67+
var i;
68+
69+
/* eslint-disable object-curly-newline */
70+
71+
values = [
72+
empty( [ 2, 2 ], { 'dtype': 'float64' }),
73+
empty( [ 2, 2 ], { 'dtype': 'float32' }),
74+
empty( [ 2, 2 ], { 'dtype': 'int32' }),
75+
empty( [ 2, 2 ], { 'dtype': 'complex128' }),
76+
empty( [ 2, 2 ], { 'dtype': 'generic' })
77+
];
78+
79+
/* eslint-enable object-curly-newline */
80+
81+
b.tic();
82+
for ( i = 0; i < b.iterations; i++ ) {
83+
v = pop( values[ i%values.length ], 0, false, false );
84+
if ( typeof v !== 'object' ) {
85+
b.fail( 'should return an array of ndarrays' );
86+
}
87+
}
88+
b.toc();
89+
if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
90+
b.fail( 'should return an array of ndarrays' );
91+
}
92+
b.pass( 'benchmark finished' );
93+
b.end();
94+
});
95+
96+
bench( pkg+'::3d', function benchmark( b ) {
97+
var values;
98+
var v;
99+
var i;
100+
101+
/* eslint-disable object-curly-newline */
102+
103+
values = [
104+
empty( [ 2, 2, 2 ], { 'dtype': 'float64' }),
105+
empty( [ 2, 2, 2 ], { 'dtype': 'float32' }),
106+
empty( [ 2, 2, 2 ], { 'dtype': 'int32' }),
107+
empty( [ 2, 2, 2 ], { 'dtype': 'complex128' }),
108+
empty( [ 2, 2, 2 ], { 'dtype': 'generic' })
109+
];
110+
111+
/* eslint-enable object-curly-newline */
112+
113+
b.tic();
114+
for ( i = 0; i < b.iterations; i++ ) {
115+
v = pop( values[ i%values.length ], 0, false, false );
116+
if ( typeof v !== 'object' ) {
117+
b.fail( 'should return an array of ndarrays' );
118+
}
119+
}
120+
b.toc();
121+
if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
122+
b.fail( 'should return an array of ndarrays' );
123+
}
124+
b.pass( 'benchmark finished' );
125+
b.end();
126+
});
127+
128+
bench( pkg+'::4d', function benchmark( b ) {
129+
var values;
130+
var v;
131+
var i;
132+
133+
/* eslint-disable object-curly-newline */
134+
135+
values = [
136+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'float64' }),
137+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'float32' }),
138+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'int32' }),
139+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'complex128' }),
140+
empty( [ 2, 2, 2, 2 ], { 'dtype': 'generic' })
141+
];
142+
143+
/* eslint-enable object-curly-newline */
144+
145+
b.tic();
146+
for ( i = 0; i < b.iterations; i++ ) {
147+
v = pop( values[ i%values.length ], 0, false, false );
148+
if ( typeof v !== 'object' ) {
149+
b.fail( 'should return an array of ndarrays' );
150+
}
151+
}
152+
b.toc();
153+
if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
154+
b.fail( 'should return an array of ndarrays' );
155+
}
156+
b.pass( 'benchmark finished' );
157+
b.end();
158+
});
159+
160+
bench( pkg+'::5d', function benchmark( b ) {
161+
var values;
162+
var v;
163+
var i;
164+
165+
/* eslint-disable object-curly-newline */
166+
167+
values = [
168+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float64' }),
169+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'float32' }),
170+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'int32' }),
171+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'complex128' }),
172+
empty( [ 2, 2, 2, 2, 2 ], { 'dtype': 'generic' })
173+
];
174+
175+
/* eslint-enable object-curly-newline */
176+
177+
b.tic();
178+
for ( i = 0; i < b.iterations; i++ ) {
179+
v = pop( values[ i%values.length ], 0, false, false );
180+
if ( typeof v !== 'object' ) {
181+
b.fail( 'should return an array of ndarrays' );
182+
}
183+
}
184+
b.toc();
185+
if ( !isndarrayLike( v[0] ) || !isndarrayLike( v[1] ) ) {
186+
b.fail( 'should return an array of ndarrays' );
187+
}
188+
b.pass( 'benchmark finished' );
189+
b.end();
190+
});

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
{{alias}}( x, dim, strict, writable )
3+
Returns an array containing a truncated view of an input ndarray and the
4+
last element along a specified dimension.
5+
6+
Parameters
7+
----------
8+
x: ndarray
9+
Input array.
10+
11+
dim: integer
12+
Dimension along which to perform the operation.
13+
14+
strict: boolean
15+
Boolean indicating whether to enforce strict bounds checking.
16+
17+
writable: boolean
18+
Boolean indicating whether a returned ndarray should be writable. This
19+
parameter only applies to ndarray constructors which support read-only
20+
instances.
21+
22+
Returns
23+
-------
24+
out: array
25+
Output array.
26+
27+
Examples
28+
--------
29+
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
30+
<ndarray>
31+
> var y = {{alias}}( x, 1, false, false )
32+
<ndarray>
33+
> {{alias:@stdlib/ndarray/to-array}}( y )
34+
[ [ 2 ], [ 4 ] ]
35+
36+
See Also
37+
--------

0 commit comments

Comments
 (0)