feat: add blas/ext/circshift

lib/node_modules/@stdlib/blas/ext/circshift/README.md

@@ -0,0 +1,156 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 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.
+
+-->
+
+# circshift
+
+> Circularly shift the elements of an input [ndarray][@stdlib/ndarray/ctor] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions by a specified number of positions.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var circshift = require( '@stdlib/blas/ext/circshift' );
+```
+
+#### circshift( x, k\[, options] )
+
+Circularly shifts the elements of an input [ndarray][@stdlib/ndarray/ctor] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions by a specified number of positions.
+
+```javascript
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+
+var y = circshift( x, 2 );
+// returns <ndarray>
+
+var arr = ndarray2array( y );
+// returns [ 4.0, 5.0, 1.0, 2.0, 3.0 ]
+
+var bool = ( x === y );
+// returns true
+```
+
+The function has the following parameters:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **k**: number of positions to shift. May be either a numeric scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, an [ndarray][@stdlib/ndarray/ctor] for `k` must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], an [ndarray][@stdlib/ndarray/ctor] for `k` must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor].
+-   **options**: function options (_optional_).
+
+The function accepts the following options:
+
+-   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
+
+By default, the function circularly shifts all elements. To perform the operation over specific dimensions, provide a `dims` option.
+
+```javascript
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0 ], {
+    'shape': [ 2, 2 ],
+    'order': 'row-major'
+});
+
+var v = ndarray2array( x );
+// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
+
+var y = circshift( x, 1, {
+    'dims': [ 0 ]
+});
+// returns <ndarray>
+
+v = ndarray2array( y );
+// returns [ [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The input [ndarray][@stdlib/ndarray/ctor] is shifted **in-place** (i.e., the input [ndarray][@stdlib/ndarray/ctor] is **mutated**).
+-   A positive `k` shifts elements to the right (toward higher indices). A negative `k` shifts elements to the left (toward lower indices). If `k` is zero, the input [ndarray][@stdlib/ndarray/ctor] is left unchanged.
+-   The function iterates over [ndarray][@stdlib/ndarray/ctor] elements according to the memory layout of the input [ndarray][@stdlib/ndarray/ctor]. Accordingly, performance degradation is possible when operating over multiple dimensions of a large non-contiguous multi-dimensional input [ndarray][@stdlib/ndarray/ctor]. In such scenarios, one may want to copy an input [ndarray][@stdlib/ndarray/ctor] to contiguous memory before performing the circular shift.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarray = require( '@stdlib/ndarray/ctor' );
+var circshift = require( '@stdlib/blas/ext/circshift' );
+
+// Generate an array of random numbers:
+var xbuf = discreteUniform( 25, -20, 20, {
+    'dtype': 'generic'
+});
+
+// Wrap in an ndarray:
+var x = new ndarray( 'generic', xbuf, [ 5, 5 ], [ 5, 1 ], 0, 'row-major' );
+console.log( ndarray2array( x ) );
+
+// Perform operation:
+circshift( x, 2, {
+    'dims': [ 0 ]
+});
+
+// Print the results:
+console.log( ndarray2array( x ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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">
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
+[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/circshift/benchmark/benchmark.js

@@ -0,0 +1,106 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var circshift = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = uniform( len, -50.0, 50.0, options );
+	x = new ndarray( options.dtype, x, [ len ], [ 1 ], 0, 'row-major' );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var o;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			o = circshift( x, ( i%len ) + 1 );
+			if ( typeof o !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( isnan( o.get( i%len ) ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:dtype=%s,len=%d', pkg, options.dtype, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/circshift/docs/repl.txt

@@ -0,0 +1,49 @@
+
+{{alias}}( x, k[, options] )
+    Circularly shifts the elements of an input ndarray along one or more
+    ndarray dimensions by a specified number of positions.
+
+    A positive `k` shifts elements to the right (toward higher indices). A
+    negative `k` shifts elements to the left (toward lower indices). If `k` is
+    zero, the input ndarray is left unchanged.
+
+    The function circularly shifts an input ndarray in-place and thus mutates
+    an input ndarray.
+
+    Parameters
+    ----------
+    x: ndarray
+        Input array.
+
+    k: ndarray|number
+        Number of positions to shift. May be either a scalar value or an
+        ndarray having an integer data type. If provided an ndarray, the value
+        must have a shape which is broadcast compatible with the complement of
+        the shape defined by `options.dims`. For example, given the input shape
+        `[2, 3, 4]` and `options.dims=[0]`, an ndarray for `k` must have a
+        shape which is broadcast compatible with the shape `[3, 4]`. Similarly,
+        when performing the operation over all elements in a provided input
+        ndarray, an ndarray for `k` must be a zero-dimensional ndarray.
+
+    options: Object (optional)
+        Function options.
+
+    options.dims: Array<integer> (optional)
+        List of dimensions over which to perform operation. If not provided, the
+        function performs the operation over all elements in a provided input
+        ndarray.
+
+    Returns
+    -------
+    out: ndarray
+        Input array.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/array}}( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+    > var y = {{alias}}( x, 2 );
+    > {{alias:@stdlib/ndarray/to-array}}( y )
+    [ 4.0, 5.0, 1.0, 2.0, 3.0 ]
+
+    See Also
+    --------

lib/node_modules/@stdlib/blas/ext/circshift/docs/types/index.d.ts

@@ -0,0 +1,85 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { ArrayLike } from '@stdlib/types/array';
+import { typedndarray, integerndarray } from '@stdlib/types/ndarray';
+
+/**
+* Number of positions to shift.
+*/
+type K = integerndarray | number;
+
+
+/**
+* Interface defining options.
+*/
+interface Options {
+	/**
+	* List of dimensions over which to perform operation.
+	*/
+	dims?: ArrayLike<number>;
+}
+
+/**
+* Circularly shifts the elements of an input ndarray along one or more ndarray dimensions by a specified number of positions.
+*/
+type Circshift = <T = unknown>( x: typedndarray<T>, k: K, options?: Options ) => typedndarray<T>;
+
+/**
+* Circularly shifts the elements of an input ndarray along one or more ndarray dimensions by a specified number of positions.
+*
+* ## Notes
+*
+* -   The input ndarray is shifted **in-place** (i.e., the input ndarray is **mutated**).
+* -   A positive `k` shifts elements to the right (toward higher indices). A negative `k` shifts elements to the left (toward lower indices). If `k` is zero, the input ndarray is left unchanged.
+*
+* @param x - input ndarray
+* @param k - number of positions to shift
+* @param options - function options
+* @returns output ndarray
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var ndarray = require( '@stdlib/ndarray/ctor' );
+*
+* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+* var x = new ndarray( 'float64', xbuf, [ 3, 1, 2 ], [ 2, 2, 1 ], 0, 'row-major' );
+*
+* var y = circshift( x, 2 );
+* // returns <ndarray>[ [ [ 5.0, 6.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ]
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var ndarray = require( '@stdlib/ndarray/ctor' );
+*
+* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+* var x = new ndarray( 'float64', xbuf, [ 3, 1, 2 ], [ 2, 2, 1 ], 0, 'row-major' );
+*
+* var y = circshift( x, -1 );
+* // returns <ndarray>[ [ [ 2.0, 3.0 ] ], [ [ 4.0, 5.0 ] ], [ [ 6.0, 1.0 ] ] ]
+*/
+declare const circshift: Circshift;
+
+
+// EXPORTS //
+
+export = circshift;