time-to-botec/js/node_modules/@stdlib/ndarray/base/to-array/docs/repl.txt

42 lines
914 B
Plaintext
Raw Normal View History

{{alias}}( buffer, shape, strides, offset, order )
Converts an ndarray buffer to a generic array.
Parameters
----------
buffer: ArrayLike|TypedArray|Buffer
Array buffer.
shape: ArrayLike
Array shape.
strides: ArrayLike
Stride array.
offset: integer
Location of the first indexed value based on the stride array.
order: string
Specifies whether an array is row-major (C-style) or column-major
(Fortran-style).
Returns
-------
out: Array|Array<Array>
Generic array (which may include nested arrays).
Examples
--------
> var b = [ 1, 2, 3, 4 ];
> var d = [ 2, 2 ];
> var s = [ 2, 1 ];
> var o = 0;
> var out = {{alias}}( b, d, s, o, 'row-major' )
[ [ 1, 2 ], [ 3, 4 ] ]
> out = {{alias}}( b, d, s, o, 'column-major' )
[ [ 1, 3 ], [ 2, 4 ] ]
See Also
--------