All files main.js

100% Statements 71/71
100% Branches 6/6
100% Functions 1/1
100% Lines 71/71

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 721x 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 15x 15x 15x 15x 15x 10x 10x 15x 2x 2x 3x 3x 3x 3x 3x 15x 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 isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var ndims = require( '@stdlib/ndarray/ndims' );
var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' );
var transpose = require( '@stdlib/ndarray/base/transpose' );
var emptyLike = require( '@stdlib/ndarray/empty-like' );
var assign = require( '@stdlib/ndarray/base/assign' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns a new ndarray containing the elements of an input ndarray but whose last two dimensions are transposed.
*
* @param {ndarray} x - input array
* @throws {TypeError} first argument must be an ndarray
* @throws {RangeError} must provide an ndarray having two or more dimensions
* @returns {ndarray} output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] );
* // returns <ndarray>[ [ 1, 2, 3 ], [ 4, 5, 6 ] ]
*
* var y = toTransposed( x );
* // returns <ndarray>[ [ 1, 4 ], [ 2, 5 ], [ 3, 6 ] ]
*/
function toTransposed( x ) {
	var out;
	var bv;
 
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
	}
	if ( ndims( x ) < 2 ) {
		throw new RangeError( 'invalid argument. Must provide an ndarray having two or more dimensions.' );
	}
	bv = ndarraylike2ndarray( x );
	bv = transpose( bv, false );
	out = emptyLike( bv );
	assign( [ bv, out ] );
	return out;
}
 
 
// EXPORTS //
 
module.exports = toTransposed;