Skip to content

Commit 77e393b

Browse files
headlessNodeheadlessNode
committed
feat: add ndarray/shift
--- 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 ---
1 parent 0562a32 commit 77e393b

File tree

10 files changed

+1329
-0
lines changed

10 files changed

+1329
-0
lines changed

‎lib/node_modules/@stdlib/ndarray/shift/README.md‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
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+
# shift
22+
23+
> Return an array containing a read-only truncated view of an input [`ndarray`][@stdlib/ndarray/ctor] and a read-only view of the first element(s) along a specific 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 shift = require( '@stdlib/ndarray/shift' );
41+
```
42+
43+
#### shift( x\[, options] )
44+
45+
Returns an array containing a **read-only** truncated view of an input [`ndarray`][@stdlib/ndarray/ctor] and a **read-only** view of the first element(s) along a specific dimension.
46+
47+
```javascript
48+
var ndarray = require( '@stdlib/ndarray/ctor' );
49+
var getShape = require( '@stdlib/ndarray/shape' );
50+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
51+
52+
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
53+
var shape = [ 3, 2 ];
54+
var strides = [ 2, 1 ];
55+
var offset = 0;
56+
57+
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
58+
// returns <ndarray>
59+
60+
var sh = getShape( x );
61+
// returns [ 3, 2 ]
62+
63+
var arr = ndarray2array( x );
64+
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
65+
66+
var y = shift( x );
67+
// returns [ <ndarray>, <ndarray> ]
68+
69+
arr = ndarray2array( y[ 0 ] );
70+
// returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
71+
72+
arr = ndarray2array( y[ 1 ] );
73+
// returns [ [ 1.0, 2.0 ] ]
74+
```
75+
76+
The function accepts the following arguments:
77+
78+
- **x**: input ndarray.
79+
- **options**: function options (_optional_).
80+
81+
The function supports the following `options`:
82+
83+
- **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`. Default: `0`.
84+
85+
By default, the function performs operation along the first dimension of the input [`ndarray`][@stdlib/ndarray/ctor]. To perform operation along any other input [`ndarray`][@stdlib/ndarray/ctor], provide the `dim` option.
86+
87+
```javascript
88+
var ndarray = require( '@stdlib/ndarray/ctor' );
89+
var getShape = require( '@stdlib/ndarray/shape' );
90+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
91+
92+
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
93+
var shape = [ 3, 2 ];
94+
var strides = [ 2, 1 ];
95+
var offset = 0;
96+
97+
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
98+
// returns <ndarray>
99+
100+
var sh = getShape( x );
101+
// returns [ 3, 2 ]
102+
103+
var arr = ndarray2array( x );
104+
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
105+
106+
var opts = {
107+
'dim': 1
108+
};
109+
110+
var y = shift( x, opts );
111+
// returns [ <ndarray>, <ndarray> ]
112+
113+
arr = ndarray2array( y[ 0 ] );
114+
// returns [ [ 2.0 ], [ 4.0 ], [ 6.0 ] ]
115+
116+
arr = ndarray2array( y[ 1 ] );
117+
// returns [ [ 1.0 ], [ 3.0 ], [ 5.0 ] ]
118+
```
119+
120+
</section>
121+
122+
<!-- /.usage -->
123+
124+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
125+
126+
<section class="notes">
127+
128+
</section>
129+
130+
<!-- /.notes -->
131+
132+
<!-- Package usage examples. -->
133+
134+
<section class="examples">
135+
136+
## Examples
137+
138+
<!-- eslint no-undef: "error" -->
139+
140+
```javascript
141+
var array = require( '@stdlib/ndarray/array' );
142+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
143+
var zeroTo = require( '@stdlib/array/base/zero-to' );
144+
var shift = require( '@stdlib/ndarray/shift' );
145+
146+
// Create a linear ndarray buffer:
147+
var buf = zeroTo( 27 );
148+
149+
// Create an ndarray which is a stack of three 3x3 matrices:
150+
var x = array( buf, {
151+
'shape': [ 3, 3, 3 ]
152+
});
153+
154+
// Perform the operation:
155+
var y = shift( x );
156+
// returns [ <ndarray>, <ndarray> ]
157+
158+
console.log( ndarray2array( y[ 0 ] ) );
159+
console.log( ndarray2array( y[ 1 ] ) );
160+
```
161+
162+
</section>
163+
164+
<!-- /.examples -->
165+
166+
<!-- 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. -->
167+
168+
<section class="references">
169+
170+
</section>
171+
172+
<!-- /.references -->
173+
174+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
175+
176+
<section class="related">
177+
178+
</section>
179+
180+
<!-- /.related -->
181+
182+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
183+
184+
<section class="links">
185+
186+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
187+
188+
</section>
189+
190+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/shift/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 shift = 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 = shift( values[ i%values.length ] );
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 = shift( values[ i%values.length ] );
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 = shift( values[ i%values.length ] );
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 = shift( values[ i%values.length ] );
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 = shift( values[ i%values.length ] );
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)