Skip to content

Commit fdf402d

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add blas/ext/base/ndarray/gcircshift
PR-URL: #11178 Closes: stdlib-js/metr-issue-tracker#256 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 8892296 commit fdf402d

File tree

10 files changed

+860
-0
lines changed

10 files changed

+860
-0
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gcircshift/README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 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+
# gcircshift
22+
23+
> Circularly shift the elements of a one-dimensional ndarray by a specified number of positions.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var gcircshift = require( '@stdlib/blas/ext/base/ndarray/gcircshift' );
37+
```
38+
39+
#### gcircshift( arrays )
40+
41+
Circularly shifts the elements of a one-dimensional ndarray by a specified number of positions.
42+
43+
```javascript
44+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
45+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
46+
47+
var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
48+
var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
49+
50+
var k = scalar2ndarray( 2, {
51+
'dtype': 'generic'
52+
});
53+
54+
var out = gcircshift( [ x, k ] );
55+
// returns <ndarray>[ 4.0, 5.0, 1.0, 2.0, 3.0 ]
56+
```
57+
58+
The function has the following parameters:
59+
60+
- **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the number of positions to shift.
61+
62+
</section>
63+
64+
<!-- /.usage -->
65+
66+
<section class="notes">
67+
68+
## Notes
69+
70+
- The input ndarray is shifted **in-place** (i.e., the input ndarray is **mutated**).
71+
72+
</section>
73+
74+
<!-- /.notes -->
75+
76+
<section class="examples">
77+
78+
## Examples
79+
80+
<!-- eslint no-undef: "error" -->
81+
82+
```javascript
83+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
84+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
85+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
86+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
87+
var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
88+
var gcircshift = require( '@stdlib/blas/ext/base/ndarray/gcircshift' );
89+
90+
var xbuf = discreteUniform( 10, -100, 100, {
91+
'dtype': 'generic'
92+
});
93+
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
94+
console.log( ndarray2array( x ) );
95+
96+
var k = scalar2ndarray( 3, {
97+
'dtype': 'generic'
98+
});
99+
console.log( 'Shift:', ndarraylike2scalar( k ) );
100+
101+
gcircshift( [ x, k ] );
102+
console.log( ndarray2array( x ) );
103+
```
104+
105+
</section>
106+
107+
<!-- /.examples -->
108+
109+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
110+
111+
<section class="related">
112+
113+
</section>
114+
115+
<!-- /.related -->
116+
117+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
118+
119+
<section class="links">
120+
121+
</section>
122+
123+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gcircshift/benchmark/benchmark.js‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 uniform = require( '@stdlib/random/array/uniform' );
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var format = require( '@stdlib/string/format' );
27+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
28+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
29+
var pkg = require( './../package.json' ).name;
30+
var gcircshift = require( './../lib' );
31+
32+
33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'generic'
37+
};
38+
39+
40+
// FUNCTIONS //
41+
42+
/**
43+
* Creates a benchmark function.
44+
*
45+
* @private
46+
* @param {PositiveInteger} len - array length
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len ) {
50+
var xbuf;
51+
var x;
52+
var k;
53+
54+
xbuf = uniform( len, 0.0, 100.0, options );
55+
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
56+
57+
k = scalar2ndarray( 3, options );
58+
59+
return benchmark;
60+
61+
/**
62+
* Benchmark function.
63+
*
64+
* @private
65+
* @param {Benchmark} b - benchmark instance
66+
*/
67+
function benchmark( b ) {
68+
var out;
69+
var i;
70+
71+
b.tic();
72+
for ( i = 0; i < b.iterations; i++ ) {
73+
out = gcircshift( [ x, k ] );
74+
if ( typeof out !== 'object' ) {
75+
b.fail( 'should return an ndarray' );
76+
}
77+
}
78+
b.toc();
79+
if ( xbuf[ i%len ] !== xbuf[ i%len ] ) {
80+
b.fail( 'should not return NaN' );
81+
}
82+
b.pass( 'benchmark finished' );
83+
b.end();
84+
}
85+
}
86+
87+
88+
// MAIN //
89+
90+
/**
91+
* Main execution sequence.
92+
*
93+
* @private
94+
*/
95+
function main() {
96+
var len;
97+
var min;
98+
var max;
99+
var f;
100+
var i;
101+
102+
min = 1; // 10^min
103+
max = 6; // 10^max
104+
105+
for ( i = min; i <= max; i++ ) {
106+
len = pow( 10, i );
107+
f = createBenchmark( len );
108+
bench( format( '%s:len=%d', pkg, len ), f );
109+
}
110+
}
111+
112+
main();

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gcircshift/docs/repl.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
{{alias}}( arrays )
3+
Circularly shifts the elements of a one-dimensional ndarray by a specified
4+
number of positions.
5+
6+
The input ndarray is shifted *in-place* (i.e., the input ndarray is
7+
*mutated*).
8+
9+
Parameters
10+
----------
11+
arrays: ArrayLikeObject<ndarray>
12+
Array-like object containing the following ndarrays:
13+
14+
- a one-dimensional input ndarray.
15+
- a zero-dimensional ndarray specifying the number of positions to
16+
shift.
17+
18+
Returns
19+
-------
20+
out: ndarray
21+
Input ndarray.
22+
23+
Examples
24+
--------
25+
> var xbuf = [ 1.0, 2.0, 3.0, 4.0 ];
26+
> var dt = 'generic';
27+
> var sh = [ xbuf.length ];
28+
> var sx = [ 1 ];
29+
> var ox = 0;
30+
> var ord = 'row-major';
31+
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
32+
> var k = {{alias:@stdlib/ndarray/from-scalar}}( 2, { 'dtype': dt } );
33+
> {{alias}}( [ x, k ] )
34+
<ndarray>[ 3.0, 4.0, 1.0, 2.0 ]
35+
36+
See Also
37+
--------

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gcircshift/docs/types/index.d.ts‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { typedndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Circularly shifts the elements of a one-dimensional ndarray by a specified number of positions.
27+
*
28+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the number of positions to shift
29+
* @returns input ndarray
30+
*
31+
* @example
32+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
33+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
34+
*
35+
* var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
36+
* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
37+
*
38+
* var k = scalar2ndarray( 2, {
39+
* 'dtype': 'generic'
40+
* });
41+
*
42+
* var out = gcircshift( [ x, k ] );
43+
* // returns <ndarray>[ 4.0, 5.0, 1.0, 2.0, 3.0 ]
44+
*/
45+
declare function gcircshift<T extends typedndarray<unknown> = typedndarray<unknown>>( arrays: [ T, typedndarray<number> ] ): T;
46+
47+
48+
// EXPORTS //
49+
50+
export = gcircshift;

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gcircshift/docs/types/test.ts‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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+
/* eslint-disable space-in-parens */
20+
21+
import zeros = require( '@stdlib/ndarray/zeros' );
22+
import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
23+
import gcircshift = require( './index' );
24+
25+
26+
// TESTS //
27+
28+
// The function returns an ndarray...
29+
{
30+
const x = zeros( [ 10 ], {
31+
'dtype': 'generic'
32+
});
33+
const k = scalar2ndarray( 2, {
34+
'dtype': 'generic'
35+
});
36+
37+
gcircshift( [ x, k ] ); // $ExpectType genericndarray<number>
38+
}
39+
40+
// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
41+
{
42+
gcircshift( '10' ); // $ExpectError
43+
gcircshift( 10 ); // $ExpectError
44+
gcircshift( true ); // $ExpectError
45+
gcircshift( false ); // $ExpectError
46+
gcircshift( null ); // $ExpectError
47+
gcircshift( undefined ); // $ExpectError
48+
gcircshift( [] ); // $ExpectError
49+
gcircshift( {} ); // $ExpectError
50+
gcircshift( ( x: number ): number => x ); // $ExpectError
51+
}
52+
53+
// The compiler throws an error if the function is provided an unsupported number of arguments...
54+
{
55+
const x = zeros( [ 10 ], {
56+
'dtype': 'generic'
57+
});
58+
const k = scalar2ndarray( 2, {
59+
'dtype': 'generic'
60+
});
61+
62+
gcircshift(); // $ExpectError
63+
gcircshift( [ x, k ], {} ); // $ExpectError
64+
}

0 commit comments

Comments
 (0)