External module "ndarray/base/iteration-order/docs/types/index.d"

Export assignment iterationOrder

• iterationOrder(strides: ArrayLike<number>): number

• Returns array iteration order.

  Notes

  • Return value key:

    • 0: unordered (i.e., strides of mixed sign; e.g., [ 9, -3, 1 ])
    • 1: ordered left-to-right (i.e., all nonnegative strides)
    • -1: ordered right-to-left (i.e., all negative strides)

  Parameters

  • strides: ArrayLike<number>

    stride array

  Returns number

  iteration order

  Example

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