Skip to content

Commit b85bc6f

Browse files
kgrytekgryte
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop
2 parents bef69f1 + 70e9b6c commit b85bc6f

File tree

12 files changed

+1160
-4
lines changed

12 files changed

+1160
-4
lines changed

‎.github/workflows/namespace_declarations.yml‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,11 @@ jobs:
110110
# Process each namespace:
111111
while IFS= read -r namespace; do
112112
if [ -n "$namespace" ] && [[ $namespace != *"_tools"* ]]; then
113-
branch_name="update-$(echo "$namespace" | sed 's/@stdlib\///' | sed 's/\//-/g')-declarations"
113+
# Namespace without the '@stdlib/' scope for display in commit messages and PR titles:
114+
display_namespace="${namespace#@stdlib/}"
115+
116+
# Branch name slug with slashes replaced by dashes:
117+
branch_name="update-${display_namespace//\//-}-declarations"
114118
git checkout -b "$branch_name"
115119
116120
# Generate declarations for this namespace:
@@ -122,13 +126,13 @@ jobs:
122126
git add lib/node_modules/@stdlib
123127
124128
# Commit changes:
125-
git commit -m "feat: update \`${namespace}\` TypeScript declarations" --signoff
129+
git commit -m "feat: update \`${display_namespace}\` TypeScript declarations" --signoff
126130
127131
# Push branch and create PR:
128132
git push origin "$branch_name"
129133
130134
gh pr create \
131-
--title "feat: update \`${namespace}\` TypeScript declarations" \
135+
--title "feat: update \`${display_namespace}\` TypeScript declarations" \
132136
--body "This PR updates TypeScript declarations for the \`${namespace}\` namespace.
133137
134138
## Reviewer Checklist

‎lib/node_modules/@stdlib/blas/ext/sorthp/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas/ext/sorthp",
33
"version": "0.0.0",
4-
"description": "Sorth an input ndarray along one or more ndarray dimensions using heapsort.",
4+
"description": "Sort an input ndarray along one or more ndarray dimensions using heapsort.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

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

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
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 a view of the last element(s) 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, writable )
44+
45+
Returns an array containing a truncated view of an input ndarray and a view of the last element(s) 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 );
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. 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`.
79+
- **writable**: boolean indicating whether a returned ndarray should be writable.
80+
81+
</section>
82+
83+
<!-- /.usage -->
84+
85+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
86+
87+
<section class="notes">
88+
89+
## Notes
90+
91+
- The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
92+
93+
</section>
94+
95+
<!-- /.notes -->
96+
97+
<!-- Package usage examples. -->
98+
99+
<section class="examples">
100+
101+
## Examples
102+
103+
<!-- eslint no-undef: "error" -->
104+
105+
```javascript
106+
var array = require( '@stdlib/ndarray/array' );
107+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
108+
var zeroTo = require( '@stdlib/array/base/zero-to' );
109+
var pop = require( '@stdlib/ndarray/base/pop' );
110+
111+
// Create a linear data buffer:
112+
var buf = zeroTo( 27 );
113+
114+
// Create an ndarray:
115+
var x = array( buf, {
116+
'shape': [ 3, 3, 3 ]
117+
});
118+
console.log( ndarray2array( x ) );
119+
120+
// Remove the last row from each matrix:
121+
var y = pop( x, 1, false );
122+
123+
console.log( ndarray2array( y[ 0 ] ) );
124+
console.log( ndarray2array( y[ 1 ] ) );
125+
```
126+
127+
</section>
128+
129+
<!-- /.examples -->
130+
131+
<!-- 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. -->
132+
133+
<section class="references">
134+
135+
</section>
136+
137+
<!-- /.references -->
138+
139+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
140+
141+
<section class="related">
142+
143+
</section>
144+
145+
<!-- /.related -->
146+
147+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
148+
149+
<section class="links">
150+
151+
</section>
152+
153+
<!-- /.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) 2025 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, stdlib/line-closing-bracket-spacing */
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, stdlib/line-closing-bracket-spacing */
48+
49+
b.tic();
50+
for ( i = 0; i < b.iterations; i++ ) {
51+
v = pop( values[ i%values.length ], 0, 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, stdlib/line-closing-bracket-spacing */
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, stdlib/line-closing-bracket-spacing */
80+
81+
b.tic();
82+
for ( i = 0; i < b.iterations; i++ ) {
83+
v = pop( values[ i%values.length ], 0, 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, stdlib/line-closing-bracket-spacing */
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, stdlib/line-closing-bracket-spacing */
112+
113+
b.tic();
114+
for ( i = 0; i < b.iterations; i++ ) {
115+
v = pop( values[ i%values.length ], 0, 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, stdlib/line-closing-bracket-spacing */
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, stdlib/line-closing-bracket-spacing */
144+
145+
b.tic();
146+
for ( i = 0; i < b.iterations; i++ ) {
147+
v = pop( values[ i%values.length ], 0, 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, stdlib/line-closing-bracket-spacing */
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, stdlib/line-closing-bracket-spacing */
176+
177+
b.tic();
178+
for ( i = 0; i < b.iterations; i++ ) {
179+
v = pop( values[ i%values.length ], 0, 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+
});

0 commit comments

Comments
 (0)