Skip to content

Commit fda2bf6

Browse files
kgrytekgryte
committed
feat: add ndarray/iter/rows 
1 parent 657a07f commit fda2bf6

File tree

10 files changed

+1505
-0
lines changed

10 files changed

+1505
-0
lines changed

‎lib/node_modules/@stdlib/ndarray/iter/rows/README.md‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2023 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+
# nditerRows
22+
23+
> Create an iterator which iterates over each row in a matrix (or stack of matrices).
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 nditerRows = require( '@stdlib/ndarray/iter/rows' );
41+
```
42+
43+
#### nditerRows( x\[, options] )
44+
45+
Returns an iterator which iterates over each row in a matrix (or stack of matrices).
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 = nditerRows( x );
55+
56+
var v = iter.next().value;
57+
// returns <ndarray>
58+
59+
var arr = ndarray2array( v );
60+
// returns [ 1, 2 ]
61+
62+
v = iter.next().value;
63+
// returns <ndarray>
64+
65+
arr = ndarray2array( v );
66+
// returns [ 3, 4 ]
67+
68+
v = iter.next().value;
69+
// returns <ndarray>
70+
71+
arr = ndarray2array( v );
72+
// returns [ 5, 6 ]
73+
74+
// ...
75+
```
76+
77+
The function accepts the following `options`:
78+
79+
- **readonly**: boolean indicating whether returned [`ndarray`][@stdlib/ndarray/ctor] views should be read-only. Default: `true`.
80+
81+
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`.
82+
83+
```javascript
84+
var array = require( '@stdlib/ndarray/array' );
85+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
86+
87+
var x = array( [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 5, 6 ], [ 7, 8 ] ] ] );
88+
// returns <ndarray>
89+
90+
var iter = nditerRows( x, {
91+
'readonly': false
92+
});
93+
94+
var v = iter.next().value;
95+
// returns <ndarray>
96+
97+
var arr = ndarray2array( v );
98+
// returns [ 1, 2 ]
99+
100+
v.set( 0, 10 );
101+
102+
arr = ndarray2array( v );
103+
// returns [ 10, 2 ]
104+
```
105+
106+
The returned iterator protocol-compliant object has the following properties:
107+
108+
- **next**: function which returns an iterator 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 is finished.
109+
- **return**: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.
110+
111+
</section>
112+
113+
<!-- /.usage -->
114+
115+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
116+
117+
<section class="notes">
118+
119+
## Notes
120+
121+
- If an environment supports `Symbol.iterator`, the returned iterator is iterable.
122+
- 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.
123+
- In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an ndarray's `@@iterator` method, regardless of whether this method is defined.
124+
125+
</section>
126+
127+
<!-- /.notes -->
128+
129+
<!-- Package usage examples. -->
130+
131+
<section class="examples">
132+
133+
## Examples
134+
135+
<!-- eslint no-undef: "error" -->
136+
137+
```javascript
138+
var array = require( '@stdlib/ndarray/array' );
139+
var zeroTo = require( '@stdlib/array/base/zero-to' );
140+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
141+
var nditerRows = require( '@stdlib/ndarray/iter/rows' );
142+
143+
// Define an input array:
144+
var x = array( zeroTo( 27 ), {
145+
'shape': [ 3, 3, 3 ]
146+
});
147+
148+
// Create an iterator for iterating over rows:
149+
var it = nditerRows( x );
150+
151+
// Perform manual iteration...
152+
var v;
153+
while ( true ) {
154+
v = it.next();
155+
if ( v.done ) {
156+
break;
157+
}
158+
console.log( ndarray2array( v.value ) );
159+
}
160+
```
161+
162+
</section>
163+
164+
<!-- /.examples -->
165+
166+
<!-- 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. -->
167+
168+
<section class="references">
169+
170+
</section>
171+
172+
<!-- /.references -->
173+
174+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
175+
176+
<section class="related">
177+
178+
</section>
179+
180+
<!-- /.related -->
181+
182+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
183+
184+
<section class="links">
185+
186+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
187+
188+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
189+
190+
</section>
191+
192+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/iter/rows/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) 2023 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( '@stdlib/ndarray/array' );
27+
var pkg = require( './../package.json' ).name;
28+
var nditerRows = 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 = nditerRows( x );
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 ],
66+
'dtype': 'generic',
67+
'copy': false
68+
});
69+
70+
iter = nditerRows( x );
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+
});

‎lib/node_modules/@stdlib/ndarray/iter/rows/docs/repl.txt‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
2+
{{alias}}( x[, options] )
3+
Returns an iterator which iterates over each row in a matrix (or stack of
4+
matrices).
5+
6+
If an environment supports Symbol.iterator, the returned iterator is
7+
iterable.
8+
9+
If an environment supports Symbol.iterator, the function explicitly does not
10+
invoke an ndarray's `@@iterator` method, regardless of whether this method
11+
is defined.
12+
13+
Parameters
14+
----------
15+
x: ndarray
16+
Input ndarray for which to create the iterator.
17+
18+
options: Object (optional)
19+
Options.
20+
21+
options.readonly: boolean (optional)
22+
Boolean indicating whether returned ndarray views should be read-only.
23+
Default: true.
24+
25+
Returns
26+
-------
27+
iterator: Object
28+
Iterator.
29+
30+
iterator.next(): Function
31+
Returns an iterator protocol-compliant object containing the next
32+
iterated value (if one exists) and a boolean flag indicating whether the
33+
iterator is finished.
34+
35+
iterator.return( [value] ): Function
36+
Finishes an iterator and returns a provided value.
37+
38+
Examples
39+
--------
40+
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] );
41+
> var it = {{alias}}( x );
42+
> var v = it.next().value;
43+
> {{alias:@stdlib/ndarray/to-array}}( v )
44+
[ 1, 2 ]
45+
> v = it.next().value;
46+
> {{alias:@stdlib/ndarray/to-array}}( v )
47+
[ 3, 4 ]
48+
49+
See Also
50+
--------
51+

0 commit comments

Comments
 (0)