Package Exports

@stdlib/ndarray-base-iteration-order
@stdlib/ndarray-base-iteration-order/dist
@stdlib/ndarray-base-iteration-order/dist/index.js
@stdlib/ndarray-base-iteration-order/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/ndarray-base-iteration-order) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Iteration Order

Given a stride array, determine array iteration order.

Installation

npm install @stdlib/ndarray-base-iteration-order

Usage

var iterationOrder = require( '@stdlib/ndarray-base-iteration-order' );

iterationOrder( strides )

Returns the array iteration order.

var o = iterationOrder( [ 2, 1 ] );
// returns 1

o = iterationOrder( [ -2, 1 ] );
// returns 0

o = iterationOrder( [ -2, -1 ] );
// returns -1

The function returns one of the following values:

0: unordered (strides are of mixed sign).
1: left-to-right iteration order (strides are all nonnegative).
-1: right-to-left iteration order (strides are all negative).

Examples

var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
var randu = require( '@stdlib/random-base-randu' );
var iterationOrder = require( '@stdlib/ndarray-base-iteration-order' );

var strides;
var shape;
var out;
var i;
var j;

shape = [ 0, 0, 0 ];
shape[ 0 ] = discreteUniform( 1, 10 );
shape[ 1 ] = discreteUniform( 1, 10 );
shape[ 2 ] = discreteUniform( 1, 10 );

strides = shape2strides( shape, 'row-major' );

for ( i = 0; i < 100; i++ ) {
    j = discreteUniform( 0, shape.length-1 );
    strides[ j ] *= ( randu() < 0.5 ) ? -1 : 1;
    out = iterationOrder( strides );
    console.log( 'strides: %s => %d', strides.join( ',' ), out );
}

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.

@stdlib/ndarray-base-iteration-order