Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/ndarray-base-to-array

Convert an ndarray buffer to a generic array.
https://github.com/stdlib-js/ndarray-base-to-array

array base convert javascript multidimensional ndarray nested node node-js nodejs stdlib toarray transform types util utilities utility utils view

Last synced: 23 days ago
JSON representation

Convert an ndarray buffer to a generic array.

Awesome Lists containing this project

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!



# ndarray2array



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Convert an ndarray buffer to a generic array.



## Installation



```bash

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

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

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).



```javascript

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).



```javascript

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.



```javascript

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



```javascript

var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );

var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );

var discreteUniform = 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' ) );



// Randomly flip strides and convert an ndarray to a nested array...

var arr;

var j;

for ( i = 0; i < 20; i++ ) {

    j = discreteUniform( 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][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-to-array.svg

[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-to-array



[test-image]: https://github.com/stdlib-js/ndarray-base-to-array/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/ndarray-base-to-array/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-to-array/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-to-array?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/ndarray-base-to-array/tree/deno

[deno-readme]: https://github.com/stdlib-js/ndarray-base-to-array/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/ndarray-base-to-array/tree/umd

[umd-readme]: https://github.com/stdlib-js/ndarray-base-to-array/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/ndarray-base-to-array/tree/esm

[esm-readme]: https://github.com/stdlib-js/ndarray-base-to-array/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/ndarray-base-to-array/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-to-array/main/LICENSE