All files / transpose/lib main.js

73.03% Statements 65/89
100% Branches 1/1
0% Functions 0/1
73.03% Lines 65/89

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 901x 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 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2022 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 strides2offset = require( '@stdlib/ndarray/base/strides2offset' );
var getDType = require( '@stdlib/ndarray/base/dtype' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var getStrides = require( '@stdlib/ndarray/base/strides' );
var getOrder = require( '@stdlib/ndarray/base/order' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
 
 
// MAIN //
 
/**
* Transpose a matrix (or a stack of matrices).
*
* @param {ndarray} x - input array
* @throws {Error} must provide an array with two or more dimensions
* @returns {ndarray} ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] );
* // returns <ndarray>
*
* var sh = x.shape;
* // returns [ 2, 3 ]
*
* var y = transpose( x );
* // returns <ndarray>
*
* sh = y.shape;
* // returns [ 3, 2 ]
*
* var bool = ( x.data === y.data );
* // returns true
*
* bool = ( x.get( 0, 1 ) === y.get( 1, 0 ) );
* // returns true
*/
function transpose( x ) {
	var tmp;
	var sh;
	var st;
	var N;

	sh = getShape( x, true );
	N = sh.length;
	if ( N < 2 ) {
		throw new Error( 'invalid argument. Must provide an ndarray having two or more dimensions.' );
	}
	st = getStrides( x, true );

	tmp = sh[ N-2 ];
	sh[ N-2 ] = sh[ N-1 ];
	sh[ N-1 ] = tmp;

	tmp = st[ N-2 ];
	st[ N-2 ] = st[ N-1 ];
	st[ N-1 ] = tmp;

	// FIXME: handling of offset seems incorrect. Should also handle READ-ONLY arrays.
	return new x.constructor( getDType( x ), getData( x ), sh, st, strides2offset( sh, st ), getOrder( x ) ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = transpose;