Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "ndarray/base/to-array/docs/types/index.d"

Index

Functions

Functions

Export assignment ndarray2array

  • Converts an ndarray buffer to a generic array (which may include nested arrays).

    Parameters

    • buffer: ArrayLike<any> | Buffer

      data buffer

    • shape: ArrayLike<number>

      array shape

    • strides: ArrayLike<number>

      array strides

    • offset: number

      index offset

    • order: Order

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

    Returns Array < any >

    array (which may include nested arrays)

    Example

    var buffer = [ 1, 2, 3, 4 ];
    var shape = [ 2, 2 ];
    var order = 'row-major';
    var strides = [ 2, 1 ];
    var offset = 0;
    
    var out = ndarray2array( buffer, shape, strides, offset, order );
    // returns [ [ 1, 2 ], [ 3, 4 ] ]