Orders
List of ndarray orders.
Usage
var orders = require( '@stdlib/ndarray/orders' );
orders()
Returns a list of ndarray orders.
var out = orders();
// returns [ 'row-major', 'column-major' ]
The output array
contains the following orders:
row-major
: row-major (C-style) order.column-major
: column-major (Fortran-style) order.
Examples
var indexOf = require( '@stdlib/utils/index-of' );
var orders = require( '@stdlib/ndarray/orders' );
var ORDERS = orders();
var bool;
function isOrder( str ) {
if ( indexOf( ORDERS, str ) === -1 ) {
return false;
}
return true;
}
bool = isOrder( 'row-major' );
// returns true
bool = isOrder( 'column-major' );
// returns true
bool = isOrder( 'beep' );
// returns false