<section class="intro">

</section>

<section class="usage">

var strided2array2d = require( '@stdlib/array/base/strided2array2d' );

Converts a strided array to a two-dimensional nested array.

var x = [ 1, 2, 3, 4, 5, 6 ];

var arr = strided2array2d( x, [ 3, 2 ], [ 2, 1 ], 0 );

arr = strided2array2d( x, [ 3, 2 ], [ 1, 3 ], 0 );

The function accepts the following arguments:

- **x**: input array.

- **shape**: array shape.

- **strides**: dimension strides.

- **offset**: index of the first indexed value in the input array.

</section>

<section class="notes">

- The function assumes that the input array is [compatible][@stdlib/ndarray/base/assert/is-buffer-length-compatible] with the specified array shape, dimension strides, and index offset.

</section>

<section class="examples">

var zeroTo = require( '@stdlib/array/base/zero-to' );

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

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

var strided2array2d = require( '@stdlib/array/base/strided2array2d' );

var shape = [ 3, 3 ];

var x = zeroTo( numel( shape ) );

console.log( x );

var y = strided2array2d( x, shape, shape2strides( shape, 'row-major' ), 0 );

console.log( y );

y = strided2array2d( x, shape, shape2strides( shape, 'column-major' ), 0 );

console.log( y );

</section>

<section class="related">

</section>

<section class="links">

[@stdlib/ndarray/base/assert/is-buffer-length-compatible]: https://github.com/stdlib-js/stdlib

</section>

var bench = require( '@stdlib/bench' );

var isnan = require( '@stdlib/math/base/assert/is-nan' );

var pow = require( '@stdlib/math/base/special/pow' );

var floor = require( '@stdlib/math/base/special/floor' );

var zeroTo = require( './../../../base/zero-to' );

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

var orders = require( '@stdlib/ndarray/orders' );

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

var pkg = require( './../package.json' ).name;

var strided2array2d = require( './../lib' );

var ORDERS = orders();

function createBenchmark( shape, order ) {

var strides = shape2strides( shape, order );

var x = zeroTo( numel( shape ) );

return benchmark;

/**

function benchmark( b ) {

var out;

var i0;

var i1;

var i;

b.tic();

for ( i = 0; i < b.iterations; i++ ) {

out = strided2array2d( x, shape, strides, 0 );

i1 = i % shape[ 0 ];

i0 = i % shape[ 1 ];

if ( isnan( out[ i1 ][ i0 ] ) ) {

b.fail( 'should not return NaN' );

}

}

b.toc();

i1 = i % shape[ 0 ];

i0 = i % shape[ 1 ];

if ( isnan( out[ i1 ][ i0 ] ) ) {

b.fail( 'should not return NaN' );

}

b.pass( 'benchmark finished' );

b.end();

}

function main() {

var min;

var max;

var ord;

var sh;

var N;

var f;

var i;

var j;

min = 1; // 10^min

max = 6; // 10^max

for ( j = 0; j < ORDERS.length; j++ ) {

for ( i = min; i <= max; i++ ) {

N = floor( pow( pow( 10, i ), 1.0/2.0 ) );

sh = [ N, N ];

ord = ORDERS[ j ];

f = createBenchmark( sh, ord );

bench( pkg+'::square_matrix:size='+numel( sh )+',order='+ord, f );

}

}

{{alias}}( x, shape, strides, offset )

Converts a strided array to a two-dimensional nested array.

The function assumes that the input array is compatible with the specified

array shape, dimension strides, and index offset.

Parameters

----------

x: ArrayLikeObject

Input array.

shape: Array<integer>

Array shape.

strides: Array<integer>

Dimension strides.

offset: integer

Index of the first indexed value in the input array.

Examples

--------

> var x = [ 1.0, 2.0, 3.0, 4.0 ];

> var y = {{alias}}( x, [ 2, 2 ], [ 2, 1 ], 0 )

[ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]

See Also

--------

import { Array2D, ArrayLike } from '@stdlib/types/array';

import { Shape2D, Strides2D } from '@stdlib/types/ndarray';

declare function strided2array2d<T = unknown>( x: ArrayLike<T>, shape: Shape2D, strides: Strides2D, offset: number ): Array2D<T>;

export = strided2array2d;