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 | 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) 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 rot90 = require( '@stdlib/ndarray/base/rot90' );
var assign = require( '@stdlib/ndarray/base/assign' );
// MAIN //
/**
* Returns a new ndarray where an ndarray is rotated 90 degrees in a specified plane.
*
* ## Notes
*
* - If `k > 0`, the function rotates the plane from the first specified dimension toward the second specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane counterclockwise.
* - If `k < 0`, the function rotates the plane from the second specified dimension toward the first specified dimension. This means that, for a two-dimensional ndarray and `dims = [0, 1]`, the function rotates the plane clockwise.
* - Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
*
* @param {ndarray} x - input array
* @param {IntegerArray} dims - dimension indices defining the plane of rotation
* @param {integer} k - number of times to rotate by 90 degrees
* @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} output array
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
*
* var y = toRot90( x, [ 0, 1 ], 1 );
* // returns <ndarray>[ [ 2, 4 ], [ 1, 3 ] ]
*/
function toRot90( x, dims, k ) {
var out;
var xr;
// Create a rotated view of the input ndarray:
xr = rot90( x, dims, k, false );
// Create an output ndarray having the same shape and data type as the rotated view:
out = emptyLike( xr );
// Assign the elements of the rotated view to the output ndarray:
assign( [ xr, out ] );
return out;
}
// EXPORTS //
module.exports = toRot90;
|