All files / to-reversed-dimensions/lib main.js

77.94% Statements 53/68
100% Branches 1/1
0% Functions 0/1
77.94% Lines 53/68

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 691x 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 emptyLike = require( '@stdlib/ndarray/base/empty-like' );
var reverseDimensions = require( '@stdlib/ndarray/base/reverse-dimensions' );
var assign = require( '@stdlib/ndarray/base/assign' );
 
 
// MAIN //
 
/**
* Returns a new ndarray where the order of elements of an input ndarray along specified dimensions is reversed.
*
* @param {ndarray} x - input array
* @param {IntegerArray} dims - indices of dimensions to reverse
* @throws {TypeError} first argument must be an ndarray having one or more dimensions
* @throws {RangeError} dimension index exceeds the number of dimensions
* @throws {Error} must provide unique dimension indices
* @returns {ndarray} output array
*
* @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 = toReversedDimensions( x, [ 0, 1 ] );
* // returns <ndarray>[ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
*/
function toReversedDimensions( x, dims ) {
	var out;
	var xr;

	// Create a reversed view of the input ndarray:
	xr = reverseDimensions( x, dims, false );

	// Create an output ndarray having the same shape and data type as the reversed view:
	out = emptyLike( xr );

	// Assign the elements of the reversed view to the output ndarray:
	assign( [ xr, out ] );

	return out;
}
 
 
// EXPORTS //
 
module.exports = toReversedDimensions;