Usage

`javascript
var nditerSubarrays = require( '@stdlib/ndarray-iter-subarrays' );
`

#### nditerSubarrays( x, ndims\[, options] )

Returns an iterator which iterates over each subarray in a stack of subarrays.

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

var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
// returns

var iter = nditerSubarrays( x, 2 );

var v = iter.next().value;
// returns

var arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]

v = iter.next().value;
// returns

arr = ndarray2array( v );
// returns [ [ 5, 6 ], [ 7, 8 ] ]

// ...
`

The function accepts the following options:

- readonly: boolean indicating whether returned [ndarray][@stdlib/ndarray/ctor] views should be read-only. In order to return writable [ndarray][@stdlib/ndarray/ctor] views, the input [ndarray][@stdlib/ndarray/ctor] must be writable. If the input [ndarray][@stdlib/ndarray/ctor] is read-only, setting this option to false raises an exception. Default: true.

By default, the iterator returns [ndarray][@stdlib/ndarray/ctor] views which are read-only. To return writable [views][@stdlib/ndarray/slice], set the readonly option to false.

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

var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
// returns

var iter = nditerSubarrays( x, 2, {
'readonly': false
});

var v = iter.next().value;
// returns

var arr = ndarray2array( v );
// returns [ [ 1, 2 ], [ 3, 4 ] ]

v.set( 0, 0, 10 );

arr = ndarray2array( v );
// returns [ [ 10, 2 ], [ 3, 4 ] ]
`

The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:

- next: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the [iterator][mdn-iterator-protocol] is finished.
- return: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.