Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Oct 4, 2023
1 parent cdd0063 commit 1050214
Show file tree
Hide file tree
Showing 15 changed files with 1,699 additions and 7 deletions.
2 changes: 1 addition & 1 deletion dist/index.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dist/index.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion iter/columns/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ interface Options {
*
* // ...
*/
declare function nditerColumns( src: ndarray, options?: Options ): Iterator<ndarray>;
declare function nditerColumns( x: ndarray, options?: Options ): Iterator<ndarray>;


// EXPORTS //
Expand Down
180 changes: 180 additions & 0 deletions iter/indices/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
<!--
@license Apache-2.0
Copyright (c) 2023 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# nditerIndices

> Create an iterator which returns indices for use indexing into an [`ndarray`][@stdlib/ndarray/ctor] having a specified shape.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var nditerIndices = require( '@stdlib/ndarray/iter/indices' );
```

#### nditerIndices( shape\[, options] )

Returns an iterator which returns indices for use indexing into an [`ndarray`][@stdlib/ndarray/ctor] having a specified `shape`.

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

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

var iter = nditerIndices( x.shape );

var v = iter.next().value;
// returns [ 0, 0, 0 ]

v = iter.next().value;
// returns [ 0, 0, 1 ]

v = iter.next().value;
// returns [ 0, 1, 0 ]

// ...
```

The function accepts the following `options`:

- **order**: index iteration order. By default, the returned [iterator][mdn-iterator-protocol] iterates over the last dimensions first, thus corresponding to iteration over contiguous data stored in row-major order. Must be either `'row-major'` or `'column-major'`.

By default, the iterator returns indices such that the last dimensions are iterated over first. To return indices according to a specified order, set the `order` option.

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

var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ], {
'order': 'row-major'
});
// returns <ndarray>

var iter = nditerIndices( x.shape, {
'order': 'column-major'
});

var v = iter.next().value;
// returns [ 0, 0, 0 ]

v = iter.next().value;
// returns [ 1, 0, 0 ]

v = iter.next().value;
// returns [ 0, 1, 0 ]

// ...
```

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.

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

## Notes

- If an environment supports `Symbol.iterator`, the returned iterator is iterable.

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var array = require( '@stdlib/ndarray/array' );
var zeroTo = require( '@stdlib/array/base/zero-to' );
var nditerIndices = require( '@stdlib/ndarray/iter/indices' );

// Define an input array:
var x = array( zeroTo( 27 ), {
'shape': [ 3, 3, 3 ]
});

// Create an iterator for generating indices:
var it = nditerIndices( x.shape );

// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( v.done ) {
break;
}
console.log( x.get.apply( x, v.value ) );
}
```

</section>

<!-- /.examples -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol

[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor

</section>

<!-- /.links -->
85 changes: 85 additions & 0 deletions iter/indices/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives;
var array = require( './../../../array' );
var pkg = require( './../package.json' ).name;
var nditerIndices = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var iter;
var x;
var i;

x = array( [ [ 1, 2, 3, 4 ] ] );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
iter = nditerIndices( x.shape );
if ( typeof iter !== 'object' ) {
b.fail( 'should return an object' );
}
}
b.toc();
if ( !isIteratorLike( iter ) ) {
b.fail( 'should return an iterator protocol-compliant object' );
}
b.pass( 'benchmark finished' );
b.end();
});

bench( pkg+'::iteration', function benchmark( b ) {
var xbuf;
var iter;
var x;
var z;
var i;

xbuf = [];
xbuf.length = b.iterations + 1;
x = array( xbuf, {
'shape': [ xbuf.length, 1 ],
'dtype': 'generic',
'copy': false
});

iter = nditerIndices( x.shape );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
z = iter.next().value;
if ( typeof z !== 'object' ) {
b.fail( 'should return an array' );
}
}
b.toc();
if ( !isNonNegativeIntegerArray( z ) ) {
b.fail( 'should return an array' );
}
b.pass( 'benchmark finished' );
b.end();
});
47 changes: 47 additions & 0 deletions iter/indices/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@

{{alias}}( shape[, options] )
Returns an iterator which returns indices for use indexing into an ndarray
having a specified shape.

If an environment supports Symbol.iterator, the returned iterator is
iterable.

Parameters
----------
shape: Array<integer>
Input shape.

options: Object (optional)
Options.

options.order: string (optional)
Index iteration order. By default, the returned iterator iterates over
the last dimensions first, thus corresponding to iteration over
contiguous data stored in row-major order. Must be either 'row-major'
or 'column-major'.

Returns
-------
iterator: Object
Iterator.

iterator.next(): Function
Returns an iterator protocol-compliant object containing the next
iterated value (if one exists) and a boolean flag indicating whether the
iterator is finished.

iterator.return( [value] ): Function
Finishes an iterator and returns a provided value.

Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] );
> var it = {{alias}}( x.shape );
> var v = it.next().value
[ 0, 0 ]
> v = it.next().value
[ 0, 1 ]

See Also
--------

Loading

0 comments on commit 1050214

Please sign in to comment.