All files / fliplr/lib main.js

88.88% Statements 64/72
100% Branches 1/1
0% Functions 0/1
88.88% Lines 64/72

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 731x 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) 2023 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 MultiSlice = require( '@stdlib/slice/multi' );
var reverseDimension = require( '@stdlib/ndarray/base/reverse-dimension' );
var slice = require( '@stdlib/ndarray/base/slice' );
var ndims = require( '@stdlib/ndarray/base/ndims' );
 
 
// MAIN //
 
/**
* Returns a view of an input ndarray in which the order of elements along the last dimension is reversed.
*
* @param {ndarray} x - input array
* @param {boolean} writable - boolean indicating whether a returned array should be writable
* @returns {ndarray} ndarray view
*
* @example
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var getShape = require( '@stdlib/ndarray/shape' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var shape = [ 3, 2 ];
* var strides = [ 2, 1 ];
* var offset = 0;
*
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* var sh = getShape( x );
* // returns [ 3, 2 ]
*
* var y = fliplr( x, false );
* // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
*
* sh = getShape( y );
* // returns [ 3, 2 ]
*/
function fliplr( x, writable ) {
	// Check whether we were provided a zero-dimensional array...
	if ( ndims( x ) === 0 ) {
		// Nothing to reverse so just return a new view:
		return slice( x, new MultiSlice(), true, writable );
	}
	return reverseDimension( x, -1, writable );
}
 
 
// EXPORTS //
 
module.exports = fliplr;