@stdlib/ndarray-base-to-array
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    ndarray2array

    NPM version Build Status Coverage Status dependencies

    Convert an ndarray buffer to a generic array.

    Installation

    npm install @stdlib/ndarray-base-to-array

    Usage

    var ndarray2array = require( '@stdlib/ndarray-base-to-array' );

    ndarray2array( buffer, shape, strides, offset, order )

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

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

    The order parameter specifies whether an array is row-major (C-style) or column-major (Fortran-style).

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

    The offset parameter specifies the location of the first indexed element based on the strides array.

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

    Examples

    var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
    var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
    var dicreteUniform = require( '@stdlib/random-base-discrete-uniform' );
    var ndarray2array = require( '@stdlib/ndarray-base-to-array' );
    
    // Create a data buffer:
    var buffer = [];
    var i;
    for ( i = 0; i < 27; i++ ) {
        buffer.push( i );
    }
    
    // Specify array meta data:
    var shape = [ 3, 3, 3 ];
    var order = 'column-major';
    var ndims = shape.length;
    
    // Compute array meta data:
    var strides = shape2strides( shape, order );
    var offset = strides2offset( shape, strides );
    
    // Print array information:
    console.log( '' );
    console.log( 'Dims: %s', shape.join( 'x' ) );
    
    // Random flip strides and convert an ndarray to a nested array...
    var arr;
    var j;
    for ( i = 0; i < 20; i++ ) {
        j = dicreteUniform( 0, ndims-1 );
        strides[ j ] *= -1;
        offset = strides2offset( shape, strides );
    
        console.log( '' );
        console.log( 'Strides: %s', strides.join( ',' ) );
        console.log( 'Offset: %d', offset );
    
        arr = ndarray2array( buffer, shape, strides, offset, order );
        console.log( JSON.stringify( arr ) );
    }

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/ndarray-base-to-array

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    9

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    44.7 kB

    Total Files

    10

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser