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 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | 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 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 152x 24x 24x 10x 10x 14x 24x 6x 6x 6x 8x 8x 88x 88x 88x 88x 152x 41x 30x 41x 11x 11x 39x 39x 47x 47x 39x 39x 24x 24x 47x 8x 8x 76x 152x 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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
var maybeBroadcastArray = require( '@stdlib/ndarray/base/maybe-broadcast-array' );
var nonCoreShape = require( '@stdlib/ndarray/base/complement-shape' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var defaults = require( '@stdlib/ndarray/defaults' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
// VARIABLES //
var DEFAULT_DTYPE = defaults.get( 'dtypes.integer' );
// MAIN //
/**
* Circularly shifts the elements of an input ndarray along one or more ndarray dimensions by a specified number of positions.
*
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|number)} k - 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 either an ndarray-like object or a numeric value
* @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} output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* // Define the shape of the input array:
* var sh = [ 3, 1, 2 ];
*
* // Define the array strides:
* var sx = [ 2, 2, 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* // Perform operation:
* var out = circshift( x, 2 );
* // returns <ndarray>[ [ [ 5.0, 6.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ]
*/
function circshift( x, k ) {
var nargs;
var opts;
var ord;
var sh;
var o;
nargs = arguments.length;
ord = getOrder( x );
o = k;
// Case: circshift( x, k )
if ( nargs === 2 ) {
// Case: circshift( x, k_scalar )
if ( isNumber( o ) ) {
return base( x, broadcastScalar( o, DEFAULT_DTYPE, [], ord ) );
}
// Case: circshift( x, k_ndarray )
if ( isndarrayLike( o ) ) {
// As the operation is performed across all dimensions, `o` is assumed to be a zero-dimensional ndarray...
return base( x, o );
}
throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or a numeric scalar value. Value: `%s`.', o ) );
}
// Case: circshift( x, k, opts )
opts = arguments[ 2 ];
// Case: circshift( x, k_scalar, opts )
if ( isNumber( o ) ) {
if ( hasOwnProp( opts, 'dims' ) ) {
sh = nonCoreShape( getShape( x ), opts.dims );
} else {
sh = [];
}
o = broadcastScalar( o, DEFAULT_DTYPE, sh, getOrder( x ) );
}
// Case: circshift( x, k_ndarray, opts )
else if ( isndarrayLike( o ) ) {
// When not provided `dims`, the operation is performed across all dimensions and `o` is assumed to be a zero-dimensional ndarray; when `dims` is provided, we need to broadcast `o` to match the shape of the non-core dimensions...
if ( hasOwnProp( opts, 'dims' ) ) {
o = maybeBroadcastArray( o, nonCoreShape( getShape( x ), opts.dims ) ); // eslint-disable-line max-len
}
} else {
throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or a numeric scalar value. Value: `%s`.', o ) );
}
return base( x, o, opts );
}
// EXPORTS //
module.exports = circshift;
|