diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/README.md new file mode 100644 index 000000000000..91a2dc8e7dfe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/README.md @@ -0,0 +1,125 @@ + + +# scircshift + +> Circularly shift the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions. + +
+ +
+ + + +
+ +## Usage + +```javascript +var scircshift = require( '@stdlib/blas/ext/base/ndarray/scircshift' ); +``` + +#### scircshift( arrays ) + +Circularly shifts the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + +var k = scalar2ndarray( 2, { + 'dtype': 'generic' +}); + +var out = scircshift( [ x, k ] ); +// returns [ 4.0, 5.0, 1.0, 2.0, 3.0 ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the number of positions to shift. + +
+ + + +
+ +## Notes + +- The input ndarray is shifted **in-place** (i.e., the input ndarray is **mutated**). + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +var scircshift = require( '@stdlib/blas/ext/base/ndarray/scircshift' ); + +var xbuf = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var k = scalar2ndarray( 3, { + 'dtype': 'generic' +}); +console.log( 'Shift:', ndarraylike2scalar( k ) ); + +scircshift( [ x, k ] ); +console.log( ndarray2array( x ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/benchmark/benchmark.js new file mode 100644 index 000000000000..941b98d93321 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/benchmark/benchmark.js @@ -0,0 +1,112 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var pkg = require( './../package.json' ).name; +var scircshift = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var x; + var k; + + xbuf = uniform( len, 0.0, 100.0, options ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + + k = scalar2ndarray( 3, options ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = scircshift( [ x, k ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( xbuf[ i%len ] !== xbuf[ 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:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/repl.txt new file mode 100644 index 000000000000..6ae2e64989d3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/repl.txt @@ -0,0 +1,37 @@ + +{{alias}}( arrays ) + Circularly shifts the elements of a one-dimensional single-precision + floating-point ndarray by a specified number of positions. + + The input ndarray is shifted *in-place* (i.e., the input ndarray is + *mutated*). + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a zero-dimensional ndarray specifying the number of positions to + shift. + + Returns + ------- + out: ndarray + Input ndarray. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var dt = 'float32'; + > var sh = [ xbuf.length ]; + > var sx = [ 1 ]; + > var ox = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); + > var k = {{alias:@stdlib/ndarray/from-scalar}}( 2, { 'dtype': dt } ); + > {{alias}}( [ x, k ] ) + [ 3.0, 4.0, 1.0, 2.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/types/index.d.ts new file mode 100644 index 000000000000..0a64d78fbd20 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/types/index.d.ts @@ -0,0 +1,51 @@ +/* +* @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 + +/// + +import { typedndarray, float32ndarray } from '@stdlib/types/ndarray'; + +/** +* Circularly shifts the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions. +* +* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the number of positions to shift +* @returns input ndarray +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var k = scalar2ndarray( 2, { +* 'dtype': 'generic' +* }); +* +* var out = scircshift( [ x, k ] ); +* // returns [ 4.0, 5.0, 1.0, 2.0, 3.0 ] +*/ +declare function scircshift( arrays: [ float32ndarray, typedndarray ] ): float32ndarray; + + +// EXPORTS // + +export = scircshift; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/types/test.ts new file mode 100644 index 000000000000..f2832c146bdc --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/docs/types/test.ts @@ -0,0 +1,64 @@ +/* +* @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. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +import scircshift = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + const k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + scircshift( [ x, k ] ); // $ExpectType float32ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + scircshift( '10' ); // $ExpectError + scircshift( 10 ); // $ExpectError + scircshift( true ); // $ExpectError + scircshift( false ); // $ExpectError + scircshift( null ); // $ExpectError + scircshift( undefined ); // $ExpectError + scircshift( [] ); // $ExpectError + scircshift( {} ); // $ExpectError + scircshift( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + const k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + scircshift(); // $ExpectError + scircshift( [ x, k ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/examples/index.js new file mode 100644 index 000000000000..dbd9490f912f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/examples/index.js @@ -0,0 +1,40 @@ +/** +* @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'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +var scircshift = require( './../lib' ); + +var xbuf = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var k = scalar2ndarray( 3, { + 'dtype': 'generic' +}); +console.log( 'Shift:', ndarraylike2scalar( k ) ); + +scircshift( [ x, k ] ); +console.log( ndarray2array( x ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/lib/index.js new file mode 100644 index 000000000000..236fd0534b18 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/lib/index.js @@ -0,0 +1,50 @@ +/** +* @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'; + +/** +* Circularly shift the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions. +* +* @module @stdlib/blas/ext/base/ndarray/scircshift +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var scircshift = require( '@stdlib/blas/ext/base/ndarray/scircshift' ); +* +* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var k = scalar2ndarray( 2, { +* 'dtype': 'generic' +* }); +* +* var out = scircshift( [ x, k ] ); +* // returns [ 4.0, 5.0, 1.0, 2.0, 3.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/lib/main.js new file mode 100644 index 000000000000..cb91d7307896 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/lib/main.js @@ -0,0 +1,67 @@ +/** +* @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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/ext/base/scircshift' ).ndarray; + + +// MAIN // + +/** +* Circularly shifts the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions. +* +* @param {ArrayLikeObject} arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the number of positions to shift +* @returns {ndarray} input ndarray +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var k = scalar2ndarray( 2, { +* 'dtype': 'generic' +* }); +* +* var out = scircshift( [ x, k ] ); +* // returns [ 4.0, 5.0, 1.0, 2.0, 3.0 ] +*/ +function scircshift( arrays ) { + var x; + var k; + + x = arrays[ 0 ]; + k = ndarraylike2scalar( arrays[ 1 ] ); + strided( numelDimension( x, 0 ), k, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len + return x; +} + + +// EXPORTS // + +module.exports = scircshift; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/package.json new file mode 100644 index 000000000000..dc4d1f3325ad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/scircshift", + "version": "0.0.0", + "description": "Circularly shift the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "extended", + "circshift", + "circular", + "shift", + "rotate", + "rotation", + "strided", + "array", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/test/test.js new file mode 100644 index 000000000000..7bb7344d9518 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/scircshift/test/test.js @@ -0,0 +1,252 @@ +/** +* @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 tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var scircshift = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof scircshift, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( scircshift.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function circularly shifts elements of a one-dimensional ndarray (right shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function circularly shifts elements of a one-dimensional ndarray (left shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -2, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of elements to shift is zero', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 0, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray is empty', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [] ), [ 0 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray contains a single element', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 7.0 ] ), [ 1 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 3, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 7.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (right shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 5, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (left shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -5, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports shifting elements in multiple cycles (right shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 7, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports shifting elements in multiple cycles (left shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float32', new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -7, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride', function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + x = ndarray( 'float32', xbuf, [ 5 ], [ -1 ], 4, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-zero offset', function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float32Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + x = ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 1, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 0.0, 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride and non-zero offset', function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float32Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = ndarray( 'float32', xbuf, [ 5 ], [ -2 ], 9, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = scircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float32Array( [ 0.0, 5.0, 2.0, 7.0, 4.0, 9.0, 6.0, 1.0, 8.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +});