All files main.js

100% Statements 84/84
100% Branches 8/8
100% Functions 1/1
100% Lines 84/84

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 851x 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 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 1x 1x 28x 28x 29x 8x 8x 20x 20x 29x 26x 26x 20x 20x 29x 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 args2multislice = require( '@stdlib/slice/base/args2multislice' );
var Slice = require( '@stdlib/slice/ctor' );
var slice = require( '@stdlib/ndarray/base/slice' );
var nulls = require( '@stdlib/array/base/nulls' );
var ndims = require( '@stdlib/ndarray/base/ndims' );
var toNormalizedIndices = require( '@stdlib/ndarray/base/to-unique-normalized-indices' );
var isIntegerArray = require( '@stdlib/assert/is-integer-array' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns a view of an input ndarray in which the order of elements along specified dimensions is reversed.
*
* @param {ndarray} x - input array
* @param {IntegerArray} dims - indices of dimension to reverse
* @param {boolean} writable - boolean indicating whether a returned array should be writable
* @throws {TypeError} first argument must be an ndarray having one or more dimensions
* @throws {RangeError} dimension index exceeds the number of dimensions
* @returns {ndarray} ndarray view
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* var y = reverseDimensions( x, [ 0, 1 ], false );
* // returns <ndarray>[ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
*/
function reverseDimensions( x, dims, writable ) {
	var args;
	var N;
	var d;
	var i;
 
	// Retrieve the number of array dimensions:
	N = ndims( x );
 
	// Check whether we were provided a zero-dimensional array...
	if ( N === 0 ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray having one or more dimensions. Number of dimensions: %d.', N ) );
	}
	// Normalize the dimension index...
	d = toNormalizedIndices( dims, N-1 );
	if ( !isIntegerArray( d ) ) {
		throw new RangeError( format( 'invalid argument. Dimension index exceeds the number of dimensions. Number of dimensions: %d. Value: `%s`.', N, dims ) );
	}
	// Define a list of MultiSlice constructor arguments:
	args = nulls( N );
	for ( i = 0; i < d.length; i++ ) {
		args[ d[ i ] ] = new Slice( null, null, -1 );
	}
	// Return a new array view:
	return slice( x, args2multislice( args ), true, writable );
}
 
 
// EXPORTS //
 
module.exports = reverseDimensions;