Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @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 dtypes = require( '@stdlib/ndarray/dtypes' );
var gcircshift = require( '@stdlib/blas/ext/base/ndarray/gcircshift' );
var dcircshift = require( '@stdlib/blas/ext/base/ndarray/dcircshift' );
var scircshift = require( '@stdlib/blas/ext/base/ndarray/scircshift' );
var factory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
// VARIABLES //
var idtypes0 = dtypes( 'all' ); // input ndarray
var idtypes1 = dtypes( 'real_and_generic' ); // k ndarray
var odtypes = dtypes( 'all' );
var table = {
'types': [
'float64', // input/output
'float32' // input/output
// FIXME: add `complex64` and `complex128` once `zcircshift` and `ccircshift` are added
],
'fcns': [
dcircshift,
scircshift
],
'default': gcircshift
};
var options = {
'strictTraversalOrder': true
};
// MAIN //
/**
* Circularly shifts the elements of an input ndarray by a specified number of positions along one or more ndarray dimensions.
*
* @private
* @name circshift
* @type {Function}
* @param {ndarray} x - input ndarray
* @param {ndarray} k - ndarray containing the number of positions to shift
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} second argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension indices must not exceed input ndarray bounds
* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
* @throws {Error} must provide valid options
* @returns {ndarray} input ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
*
* var k = scalar2ndarray( 2, {
* 'dtype': 'int32'
* });
*
* var y = circshift( x, k );
* // returns <ndarray>[ 4.0, 5.0, 1.0, 2.0, 3.0 ]
*/
var circshift = factory( table, [ idtypes0, idtypes1 ], odtypes, options );
// EXPORTS //
module.exports = circshift;
|