Skip to content

Commit e55fddc

Browse files
headlessNodeheadlessNode
authored
feat: add blas/ext/base/gcusome
PR-URL: #12182 Reviewed-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#545
1 parent 7f321d8 commit e55fddc

15 files changed

Lines changed: 2305 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/blas/ext/base/gcusome/README.md‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 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+
# gcusome
22+
23+
> Cumulatively test whether at least `k` elements in a strided array are truthy.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var gcusome = require( '@stdlib/blas/ext/base/gcusome' );
37+
```
38+
39+
#### gcusome( N, k, x, strideX, out, strideOut )
40+
41+
Cumulatively tests whether at least `k` elements in a strided array are truthy.
42+
43+
```javascript
44+
var x = [ 0, 0, 1, 1, 1 ];
45+
var out = [ false, false, false, false, false ];
46+
47+
gcusome( x.length, 2, x, 1, out, 1 );
48+
// out => [ false, false, false, true, true ]
49+
```
50+
51+
The function has the following parameters:
52+
53+
- **N**: number of indexed elements.
54+
- **k**: minimum number of truthy elements.
55+
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
56+
- **strideX**: stride length for `x`.
57+
- **out**: output [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
58+
- **strideOut**: stride length for `out`.
59+
60+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to cumulatively test every other element:
61+
62+
```javascript
63+
var x = [ 0, 0, 1, 0, 1, 0, 1, 0 ];
64+
var out = [ false, false, false, false ];
65+
66+
gcusome( 4, 2, x, 2, out, 1 );
67+
// out => [ false, false, true, true ]
68+
```
69+
70+
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
71+
72+
<!-- eslint-disable stdlib/capitalized-comments -->
73+
74+
```javascript
75+
var Uint8Array = require( '@stdlib/array/uint8' );
76+
77+
// Initial arrays...
78+
var x0 = new Uint8Array( [ 0, 0, 1, 0, 1, 1 ] );
79+
var o0 = new Uint8Array( x0.length );
80+
81+
// Create offset views...
82+
var x1 = new Uint8Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
83+
var o1 = new Uint8Array( o0.buffer, o0.BYTES_PER_ELEMENT*3 ); // start at 4th element
84+
85+
gcusome( 3, 2, x1, 2, o1, 1 );
86+
// o0 => <Uint8Array>[ 0, 0, 0, 0, 0, 0 ]
87+
```
88+
89+
#### gcusome.ndarray( N, k, x, strideX, offsetX, out, strideOut, offsetOut )
90+
91+
Cumulatively tests whether at least `k` elements in a strided array are truthy using alternative indexing semantics.
92+
93+
```javascript
94+
var x = [ 0, 0, 1, 1, 1 ];
95+
var out = [ false, false, false, false, false ];
96+
97+
gcusome.ndarray( x.length, 2, x, 1, 0, out, 1, 0 );
98+
// out => [ false, false, false, true, true ]
99+
```
100+
101+
The function has the following additional parameters:
102+
103+
- **offsetX**: starting index for `x`.
104+
- **offsetOut**: starting index for `out`.
105+
106+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to cumulatively test every other element starting from the third element:
107+
108+
```javascript
109+
var x = [ 0, 0, 1, 0, 1, 0, 1, 0 ];
110+
var out = [ false, false, false ];
111+
112+
gcusome.ndarray( 3, 2, x, 2, 2, out, 1, 0 );
113+
// out => [ false, true, true ]
114+
```
115+
116+
</section>
117+
118+
<!-- /.usage -->
119+
120+
<section class="notes">
121+
122+
## Notes
123+
124+
- If `N <= 0`, both functions return `out` unchanged.
125+
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
126+
127+
</section>
128+
129+
<!-- /.notes -->
130+
131+
<section class="examples">
132+
133+
## Examples
134+
135+
<!-- eslint no-undef: "error" -->
136+
137+
```javascript
138+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
139+
var filled = require( '@stdlib/array/base/filled' );
140+
var gcusome = require( '@stdlib/blas/ext/base/gcusome' );
141+
142+
var x = bernoulli( 10, 0.5, {
143+
'dtype': 'generic'
144+
});
145+
console.log( x );
146+
147+
var out = filled( false, x.length );
148+
gcusome( x.length, 2, x, 1, out, 1 );
149+
console.log( out );
150+
```
151+
152+
</section>
153+
154+
<!-- /.examples -->
155+
156+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
157+
158+
<section class="related">
159+
160+
</section>
161+
162+
<!-- /.related -->
163+
164+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
165+
166+
<section class="links">
167+
168+
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
169+
170+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
171+
172+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
173+
174+
<!-- <related-links> -->
175+
176+
<!-- </related-links> -->
177+
178+
</section>
179+
180+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/gcusome/benchmark/benchmark.js‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 bernoulli = require( '@stdlib/random/array/bernoulli' );
25+
var isBoolean = require( '@stdlib/assert/is-boolean' );
26+
var filled = require( '@stdlib/array/base/filled' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var format = require( '@stdlib/string/format' );
29+
var pkg = require( './../package.json' ).name;
30+
var gcusome = require( './../lib/main.js' );
31+
32+
33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'generic'
37+
};
38+
39+
40+
// FUNCTIONS //
41+
42+
/**
43+
* Creates a benchmark function.
44+
*
45+
* @private
46+
* @param {PositiveInteger} len - array length
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len ) {
50+
var out = filled( false, len );
51+
var x = bernoulli( len, 0.5, options );
52+
return benchmark;
53+
54+
/**
55+
* Benchmark function.
56+
*
57+
* @private
58+
* @param {Benchmark} b - benchmark instance
59+
*/
60+
function benchmark( b ) {
61+
var v;
62+
var i;
63+
64+
b.tic();
65+
for ( i = 0; i < b.iterations; i++ ) {
66+
v = gcusome( len, len-1, x, 1, out, 1 );
67+
if ( typeof v[ i%len ] !== 'boolean' ) {
68+
b.fail( 'should return boolean' );
69+
}
70+
}
71+
b.toc();
72+
if ( !isBoolean( v[ i%len ] ) ) {
73+
b.fail( 'should return boolean' );
74+
}
75+
b.pass( 'benchmark finished' );
76+
b.end();
77+
}
78+
}
79+
80+
81+
// MAIN //
82+
83+
/**
84+
* Main execution sequence.
85+
*
86+
* @private
87+
*/
88+
function main() {
89+
var len;
90+
var min;
91+
var max;
92+
var f;
93+
var i;
94+
95+
min = 1; // 10^min
96+
max = 6; // 10^max
97+
98+
for ( i = min; i <= max; i++ ) {
99+
len = pow( 10, i );
100+
f = createBenchmark( len );
101+
bench( format( '%s:len=%d', pkg, len ), f );
102+
}
103+
}
104+
105+
main();

‎lib/node_modules/@stdlib/blas/ext/base/gcusome/benchmark/benchmark.ndarray.js‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 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 bernoulli = require( '@stdlib/random/array/bernoulli' );
25+
var isBoolean = require( '@stdlib/assert/is-boolean' );
26+
var filled = require( '@stdlib/array/base/filled' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var format = require( '@stdlib/string/format' );
29+
var pkg = require( './../package.json' ).name;
30+
var gcusome = require( './../lib/ndarray.js' );
31+
32+
33+
// VARIABLES //
34+
35+
var options = {
36+
'dtype': 'generic'
37+
};
38+
39+
40+
// FUNCTIONS //
41+
42+
/**
43+
* Creates a benchmark function.
44+
*
45+
* @private
46+
* @param {PositiveInteger} len - array length
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len ) {
50+
var out = filled( false, len );
51+
var x = bernoulli( len, 0.5, options );
52+
return benchmark;
53+
54+
/**
55+
* Benchmark function.
56+
*
57+
* @private
58+
* @param {Benchmark} b - benchmark instance
59+
*/
60+
function benchmark( b ) {
61+
var v;
62+
var i;
63+
64+
b.tic();
65+
for ( i = 0; i < b.iterations; i++ ) {
66+
v = gcusome( len, len-1, x, 1, 0, out, 1, 0 );
67+
if ( typeof v[ i%len ] !== 'boolean' ) {
68+
b.fail( 'should return boolean' );
69+
}
70+
}
71+
b.toc();
72+
if ( !isBoolean( v[ i%len ] ) ) {
73+
b.fail( 'should return boolean' );
74+
}
75+
b.pass( 'benchmark finished' );
76+
b.end();
77+
}
78+
}
79+
80+
81+
// MAIN //
82+
83+
/**
84+
* Main execution sequence.
85+
*
86+
* @private
87+
*/
88+
function main() {
89+
var len;
90+
var min;
91+
var max;
92+
var f;
93+
var i;
94+
95+
min = 1; // 10^min
96+
max = 6; // 10^max
97+
98+
for ( i = min; i <= max; i++ ) {
99+
len = pow( 10, i );
100+
f = createBenchmark( len );
101+
bench( format( '%s:len=%d', pkg, len ), f );
102+
}
103+
}
104+
105+
main();

0 commit comments

Comments
 (0)