@stdlib/ndarray-base-order
v0.2.1
Published
Return the layout order of a provided ndarray.
Downloads
2,027
Readme
order
Return the layout order of a provided ndarray.
Installation
npm install @stdlib/ndarray-base-order
Usage
var order = require( '@stdlib/ndarray-base-order' );
order( x )
Returns the layout order of a provided ndarray.
var zeros = require( '@stdlib/ndarray-zeros' );
var x = zeros( [ 3, 2, 3 ], {
'order': 'row-major'
});
// returns <ndarray>
var out = order( x );
// returns 'row-major'
Examples
var zeros = require( '@stdlib/ndarray-zeros' );
var slice = require( '@stdlib/ndarray-slice' );
var E = require( '@stdlib/slice-multi' );
var S = require( '@stdlib/slice-ctor' );
var order = require( '@stdlib/ndarray-base-order' );
// Create an array:
var x = zeros( [ 10, 10, 10, 10 ] );
// returns <ndarray>
// Define some slices:
var slices = [
// :,:,:,:
E( null, null, null, null ),
// 5:10,4,2:4,::-1
E( S( 5, 10 ), 4, S( 2, 4 ), S( null, null, -1 ) ),
// :,:,2,:
E( null, null, 2, null ),
// 1,2,3,:
E( 1, 2, 3, null ),
// 1,3,::2,4::2
E( 1, 3, S( null, null, 2 ), S( 4, null, 2 ) )
];
// Determine the layout order for each slice...
var s;
var i;
for ( i = 0; i < slices.length; i++ ) {
s = slice( x, slices[ i ] );
console.log( '%s => %s', s.order, order( s ) );
}
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.