Skip to content

Commit 062031d

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent a8e48f2 commit 062031d

File tree

12 files changed

+2118
-0
lines changed

12 files changed

+2118
-0
lines changed

‎CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,7 @@ This release closes the following issue:
562562

563563
##### Features
564564

565+
- [`4289f78`](https://github.com/stdlib-js/stdlib/commit/4289f78da1d67c5671151413b4673ec32ede26c2) - add `nditerStacks` to namespace
565566
- [`873b085`](https://github.com/stdlib-js/stdlib/commit/873b085ae0183426f3e8e831a50a42e2df3ba13d) - add `nditerSubarrays` to namespace
566567
- [`46aec25`](https://github.com/stdlib-js/stdlib/commit/46aec25aac5d4a0c8a3fd7b719dd6a080e59beb8) - add `nditerSelectDimension` to namespace
567568

@@ -597,6 +598,28 @@ This release closes the following issue:
597598

598599
<!-- /.package -->
599600

601+
<section class="package" id="ndarray-iter-stacks-unreleased">
602+
603+
#### [@stdlib/ndarray/iter/stacks](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/stacks)
604+
605+
<details>
606+
607+
<section class="features">
608+
609+
##### Features
610+
611+
- [`d256bd9`](https://github.com/stdlib-js/stdlib/commit/d256bd93e03a245d45b732ba4d8ab60e47d378d6) - add `ndarray/iter/stacks`
612+
613+
</section>
614+
615+
<!-- /.features -->
616+
617+
</details>
618+
619+
</section>
620+
621+
<!-- /.package -->
622+
600623
<section class="package" id="ndarray-iter-subarrays-unreleased">
601624

602625
#### [@stdlib/ndarray/iter/subarrays](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/subarrays)
@@ -883,6 +906,8 @@ A total of 4 people contributed to this release. Thank you to the following cont
883906

884907
<details>
885908

909+
- [`4289f78`](https://github.com/stdlib-js/stdlib/commit/4289f78da1d67c5671151413b4673ec32ede26c2) - **feat:** add `nditerStacks` to namespace _(by Athan Reines)_
910+
- [`d256bd9`](https://github.com/stdlib-js/stdlib/commit/d256bd93e03a245d45b732ba4d8ab60e47d378d6) - **feat:** add `ndarray/iter/stacks` _(by Athan Reines)_
886911
- [`7a4424b`](https://github.com/stdlib-js/stdlib/commit/7a4424bd81e212e9c7534520213b696c0c64c644) - **docs:** fix comment _(by Athan Reines)_
887912
- [`873b085`](https://github.com/stdlib-js/stdlib/commit/873b085ae0183426f3e8e831a50a42e2df3ba13d) - **feat:** add `nditerSubarrays` to namespace _(by Athan Reines)_
888913
- [`fd9a5c2`](https://github.com/stdlib-js/stdlib/commit/fd9a5c2e29508ab5b393e2273ddb7463be6affb3) - **feat:** add `ndarray/iter/subarrays` _(by Athan Reines)_

‎iter/lib/index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,15 @@ setReadOnly( ns, 'nditerRows', require( './../../iter/rows' ) );
117117
*/
118118
setReadOnly( ns, 'nditerSelectDimension', require( './../../iter/select-dimension' ) );
119119

120+
/**
121+
* @name nditerStacks
122+
* @memberof ns
123+
* @readonly
124+
* @type {Function}
125+
* @see {@link module:@stdlib/ndarray/iter/stacks}
126+
*/
127+
setReadOnly( ns, 'nditerStacks', require( './../../iter/stacks' ) );
128+
120129
/**
121130
* @name nditerSubarrays
122131
* @memberof ns

‎iter/stacks/README.md

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# nditerStacks
22+
23+
> Create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var nditerStacks = require( '@stdlib/ndarray/iter/stacks' );
41+
```
42+
43+
#### nditerStacks( x, dims\[, options] )
44+
45+
Returns an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.
46+
47+
```javascript
48+
var array = require( '@stdlib/ndarray/array' );
49+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
50+
51+
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
52+
// returns <ndarray>
53+
54+
var iter = nditerStacks( x, [ 1, 2 ] );
55+
56+
var v = iter.next().value;
57+
// returns <ndarray>
58+
59+
var arr = ndarray2array( v );
60+
// returns [ [ 1, 2 ], [ 3, 4 ] ]
61+
62+
v = iter.next().value;
63+
// returns <ndarray>
64+
65+
arr = ndarray2array( v );
66+
// returns [ [ 5, 6 ], [ 7, 8 ] ]
67+
68+
// ...
69+
```
70+
71+
The function accepts the following `options`:
72+
73+
- **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`.
74+
75+
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`.
76+
77+
```javascript
78+
var array = require( '@stdlib/ndarray/array' );
79+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
80+
81+
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
82+
// returns <ndarray>
83+
84+
var iter = nditerStacks( x, [ 1, 2 ], {
85+
'readonly': false
86+
});
87+
88+
var v = iter.next().value;
89+
// returns <ndarray>
90+
91+
var arr = ndarray2array( v );
92+
// returns [ [ 1, 2 ], [ 3, 4 ] ]
93+
94+
v.set( 0, 0, 10 );
95+
96+
arr = ndarray2array( v );
97+
// returns [ [ 10, 2 ], [ 3, 4 ] ]
98+
```
99+
100+
The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
101+
102+
- **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.
103+
- **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
104+
105+
</section>
106+
107+
<!-- /.usage -->
108+
109+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
110+
111+
<section class="notes">
112+
113+
## Notes
114+
115+
- The input [`ndarray`][@stdlib/ndarray/ctor] must have at least `dims.length+1` dimensions.
116+
- The list of provided index dimensions must be unique and resolve to index dimensions sorted in ascending order (i.e., the function does **not** allow rearranging [`ndarray`][@stdlib/ndarray/ctor] dimensions by specifying an arbitrary index order).
117+
- If an environment supports `Symbol.iterator`, the returned iterator is iterable.
118+
- A returned iterator does **not** copy a provided [`ndarray`][@stdlib/ndarray/ctor]. To ensure iterable reproducibility, copy the input [`ndarray`][@stdlib/ndarray/ctor] **before** creating an iterator. Otherwise, any changes to the contents of input [`ndarray`][@stdlib/ndarray/ctor] will be reflected in the returned iterator.
119+
- In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an ndarray's `@@iterator` method, regardless of whether this method is defined.
120+
121+
</section>
122+
123+
<!-- /.notes -->
124+
125+
<!-- Package usage examples. -->
126+
127+
<section class="examples">
128+
129+
## Examples
130+
131+
<!-- eslint no-undef: "error" -->
132+
133+
```javascript
134+
var array = require( '@stdlib/ndarray/array' );
135+
var zeroTo = require( '@stdlib/array/base/zero-to' );
136+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
137+
var nditerStacks = require( '@stdlib/ndarray/iter/stacks' );
138+
139+
// Define an input array:
140+
var x = array( zeroTo( 27 ), {
141+
'shape': [ 3, 3, 3 ]
142+
});
143+
144+
// Create an iterator for iterating over matrices:
145+
var it = nditerStacks( x, [ 1, 2 ] );
146+
147+
// Perform manual iteration...
148+
var v;
149+
while ( true ) {
150+
v = it.next();
151+
if ( v.done ) {
152+
break;
153+
}
154+
console.log( ndarray2array( v.value ) );
155+
}
156+
157+
// Create an iterator for iterating over matrices:
158+
it = nditerStacks( x, [ 0, 2 ] );
159+
160+
// Perform manual iteration...
161+
while ( true ) {
162+
v = it.next();
163+
if ( v.done ) {
164+
break;
165+
}
166+
console.log( ndarray2array( v.value ) );
167+
}
168+
169+
// Create an iterator for iterating over matrices:
170+
it = nditerStacks( x, [ 0, 1 ] );
171+
172+
// Perform manual iteration...
173+
while ( true ) {
174+
v = it.next();
175+
if ( v.done ) {
176+
break;
177+
}
178+
console.log( ndarray2array( v.value ) );
179+
}
180+
```
181+
182+
</section>
183+
184+
<!-- /.examples -->
185+
186+
<!-- 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. -->
187+
188+
<section class="references">
189+
190+
</section>
191+
192+
<!-- /.references -->
193+
194+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
195+
196+
<section class="related">
197+
198+
</section>
199+
200+
<!-- /.related -->
201+
202+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
203+
204+
<section class="links">
205+
206+
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
207+
208+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
209+
210+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
211+
212+
</section>
213+
214+
<!-- /.links -->

‎iter/stacks/benchmark/benchmark.js

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
25+
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
26+
var array = require( './../../../array' );
27+
var pkg = require( './../package.json' ).name;
28+
var nditerStacks = require( './../lib' );
29+
30+
31+
// MAIN //
32+
33+
bench( pkg, function benchmark( b ) {
34+
var iter;
35+
var x;
36+
var i;
37+
38+
x = array( [ [ [ 1, 2, 3, 4 ] ] ] );
39+
40+
b.tic();
41+
for ( i = 0; i < b.iterations; i++ ) {
42+
iter = nditerStacks( x, [ 1, 2 ] );
43+
if ( typeof iter !== 'object' ) {
44+
b.fail( 'should return an object' );
45+
}
46+
}
47+
b.toc();
48+
if ( !isIteratorLike( iter ) ) {
49+
b.fail( 'should return an iterator protocol-compliant object' );
50+
}
51+
b.pass( 'benchmark finished' );
52+
b.end();
53+
});
54+
55+
bench( pkg+'::iteration', function benchmark( b ) {
56+
var xbuf;
57+
var iter;
58+
var x;
59+
var z;
60+
var i;
61+
62+
xbuf = [];
63+
xbuf.length = b.iterations + 1;
64+
x = array( xbuf, {
65+
'shape': [ xbuf.length, 1, 1 ],
66+
'dtype': 'generic',
67+
'copy': false
68+
});
69+
70+
iter = nditerStacks( x, [ 1, 2 ] );
71+
72+
b.tic();
73+
for ( i = 0; i < b.iterations; i++ ) {
74+
z = iter.next().value;
75+
if ( typeof z !== 'object' ) {
76+
b.fail( 'should return an ndarray' );
77+
}
78+
}
79+
b.toc();
80+
if ( !isndarrayLike( z ) ) {
81+
b.fail( 'should return an ndarray' );
82+
}
83+
b.pass( 'benchmark finished' );
84+
b.end();
85+
});

0 commit comments

Comments
 (0)