All files main.js

100% Statements 92/92
100% Branches 15/15
100% Functions 1/1
100% Lines 92/92

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 931x 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 70x 70x 70x 70x 70x 10x 10x 60x 60x 70x 54x 9x 9x 54x 21x 10x 10x 11x 11x 54x 24x 9x 9x 15x 15x 54x 32x 70x 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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isCollection = require( '@stdlib/assert/is-collection' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var base = require( '@stdlib/ndarray/base/rot90' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns a read-only view of an input ndarray rotated 90 degrees in a specified plane.
*
* @param {ndarray} x - input array
* @param {Options} [options] - function options
* @param {integer} [options.k=1] - number of times to rotate by 90 degrees
* @param {IntegerArray} [options.dims=[-2,-1]] - dimension indices defining the plane of rotation
* @throws {TypeError} first argument must be an ndarray
* @throws {TypeError} options argument must be an object
* @throws {TypeError} `k` option must be an integer
* @throws {TypeError} `dims` option must be an array-like object of integers
* @throws {RangeError} must provide exactly two dimension indices
* @throws {RangeError} input ndarray must have at least two dimensions
* @throws {RangeError} must provide valid dimension indices
* @throws {Error} must provide unique dimension indices
* @returns {ndarray} ndarray view
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]
*
* var y = rot90( x );
* // returns <ndarray>[ [ 2.0, 4.0 ], [ 1.0, 3.0 ] ]
*/
function rot90( x, options ) {
	var dims;
	var k;
 
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
	}
	dims = [ -2, -1 ];
	k = 1;
	if ( arguments.length > 1 ) {
		if ( !isPlainObject( options ) ) {
			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
		}
		if ( hasOwnProp( options, 'k' ) ) {
			if ( !isInteger( options.k ) ) {
				throw new TypeError( format( 'invalid option. `%s` option must be an integer. Option: `%s`.', 'k', options.k ) );
			}
			k = options.k;
		}
		if ( hasOwnProp( options, 'dims' ) ) {
			if ( !isCollection( options.dims ) ) {
				throw new TypeError( format( 'invalid option. `%s` option must be an array-like object. Option: `%s`.', 'dims', options.dims ) );
			}
			dims = options.dims;
		}
	}
	return base( x, dims, k, false );
}
 
 
// EXPORTS //
 
module.exports = rot90;