External module "ndarray/base/bind2vind/docs/types/index.d"

Export assignment bind2vind

• bind2vind(shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number, order: Order, idx: number, mode: Mode): number

• Converts a linear index in an underlying data buffer to a linear index in an array view.

  throws

  linear index must not exceed array dimensions

  Parameters

  • shape: ArrayLike<number>

    array shape

  • strides: ArrayLike<number>

    stride array

  • offset: number

    location of the first indexed value based on the stride array

  • order: Order

    specifies whether an array is row-major (C-style) or column-major (Fortran-style)

  • idx: number

    linear index in an underlying data buffer

  • mode: Mode

    specifies how to handle a linear index which exceeds array dimensions

  Returns number

  linear index in an array view

  Example

  var shape = [ 3, 3 ];
  var strides = [ -3, 1 ];
  var offset = 6;
  var order = 'row-major';
  var mode = 'throw';
  
  var ind = bind2vind( shape, strides, offset, order, 7, mode );
  // returns 1