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 | 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 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 2x 2x 14x 14x 14x 16x 3x 3x 16x 3x 3x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 8x 16x 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 getDType = require( '@stdlib/ndarray/base/dtype' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var getStrides = require( '@stdlib/ndarray/base/strides' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getOrder = require( '@stdlib/ndarray/base/order' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var toUniqueNormalizedIndices = require( '@stdlib/ndarray/base/to-unique-normalized-indices' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Returns a view of an input ndarray in which two specified dimensions are swapped.
*
* @param {ndarray} x - input array
* @param {IntegerArray} dims - indices of dimensions to swap
* @param {boolean} writable - boolean indicating whether a returned ndarray should be writable
* @throws {TypeError} first argument must be an ndarray having two or more dimensions
* @throws {RangeError} specified dimension index is out-of-bounds
* @throws {Error} must provide two unique dimension indices
* @returns {ndarray} ndarray view
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
* // returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ]
*
* var y = swapDimensions( x, [ 0, 1 ], false );
* // returns <ndarray>[ [ [ 1, 2 ], [ 5, 6 ] ], [ [ 3, 4 ], [ 7, 8 ] ] ]
*/
function swapDimensions( x, dims, writable ) {
var tmp;
var sh;
var st;
var d1;
var d2;
var d;
var N;
sh = getShape( x, true );
N = sh.length;
if ( N < 2 ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray having two or more dimensions. Number of dimensions: %d.', N ) );
}
// Normalize dimension indices:
d = toUniqueNormalizedIndices( dims, N-1 );
if ( d === null ) {
throw new RangeError( format( 'invalid argument. Specified dimension index is out-of-bounds. Must be on the interval: [-%u, %u]. Value: `[%s]`.', N, N-1, join( dims, ', ' ) ) );
}
if ( d.length !== dims.length || d.length !== 2 ) {
throw new Error( format( 'invalid argument. Must provide two unique dimension indices. Value: `[%s]`.', join( dims, ', ' ) ) );
}
st = getStrides( x, true );
d1 = d[ 0 ];
d2 = d[ 1 ];
// Swap shapes:
tmp = sh[ d1 ];
sh[ d1 ] = sh[ d2 ];
sh[ d2 ] = tmp;
// Swap strides:
tmp = st[ d1 ];
st[ d1 ] = st[ d2 ];
st[ d2 ] = tmp;
return new x.constructor( getDType( x ), getData( x ), sh, st, getOffset( x ), getOrder( x ), { // eslint-disable-line max-len
'readonly': !writable
});
}
// EXPORTS //
module.exports = swapDimensions;
|