Skip to content

Commit bfd8b02

Browse files
headlessNodeheadlessNode
committed
feat: add ndarray/base/any
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 8da4e68 commit bfd8b02

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+8512
-0
lines changed

‎lib/node_modules/@stdlib/ndarray/base/any/README.md

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 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+
# any
22+
23+
> Test whether at least one element in an ndarray is 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 any = require( '@stdlib/ndarray/base/any' );
37+
```
38+
39+
#### any( arrays )
40+
41+
Tests whether at least one element in an ndarray is truthy.
42+
43+
<!-- eslint-disable max-len -->
44+
45+
```javascript
46+
var Float64Array = require( '@stdlib/array/float64' );
47+
48+
// Create a data buffer:
49+
var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
50+
51+
// Define the shape of the input array:
52+
var shape = [ 3, 1, 2 ];
53+
54+
// Define the array strides:
55+
var sx = [ 4, 4, 1 ];
56+
57+
// Define the index offset:
58+
var ox = 0;
59+
60+
// Create the input ndarray-like object:
61+
var x = {
62+
'dtype': 'float64',
63+
'data': xbuf,
64+
'shape': shape,
65+
'strides': sx,
66+
'offset': ox,
67+
'order': 'row-major'
68+
};
69+
70+
// Test elements:
71+
var out = any( [ x ] );
72+
// returns true
73+
```
74+
75+
The function accepts the following arguments:
76+
77+
- **arrays**: array-like object containing an input ndarray.
78+
79+
The provided ndarray should be an `object` with the following properties:
80+
81+
- **dtype**: data type.
82+
- **data**: data buffer.
83+
- **shape**: dimensions.
84+
- **strides**: stride lengths.
85+
- **offset**: index offset.
86+
- **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
87+
88+
</section>
89+
90+
<!-- /.usage -->
91+
92+
<section class="notes">
93+
94+
## Notes
95+
96+
- For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing the operation in order to achieve better performance.
97+
- If provided an empty ndarray, the function returns `false`.
98+
99+
</section>
100+
101+
<!-- /.notes -->
102+
103+
<section class="examples">
104+
105+
## Examples
106+
107+
<!-- eslint no-undef: "error" -->
108+
109+
```javascript
110+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
111+
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
112+
var any = require( '@stdlib/ndarray/base/any' );
113+
114+
var x = {
115+
'dtype': 'generic',
116+
'data': bernoulli( 10, 0.9, {
117+
'dtype': 'generic'
118+
}),
119+
'shape': [ 5, 2 ],
120+
'strides': [ 2, 1 ],
121+
'offset': 0,
122+
'order': 'row-major'
123+
};
124+
console.log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
125+
126+
var out = any( [ x ] );
127+
console.log( out );
128+
```
129+
130+
</section>
131+
132+
<!-- /.examples -->
133+
134+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
135+
136+
<section class="related">
137+
138+
</section>
139+
140+
<!-- /.related -->
141+
142+
<section class="links">
143+
144+
</section>
145+
146+
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/base/any/benchmark/benchmark.1d_columnmajor.js

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var zeros = require( '@stdlib/array/zeros' );
27+
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
28+
var pkg = require( './../package.json' ).name;
29+
var any = require( './../lib' );
30+
31+
32+
// VARIABLES //
33+
34+
var types = [ 'float64' ];
35+
var order = 'column-major';
36+
37+
38+
// FUNCTIONS //
39+
40+
/**
41+
* Creates a benchmark function.
42+
*
43+
* @private
44+
* @param {PositiveInteger} len - ndarray length
45+
* @param {NonNegativeIntegerArray} shape - ndarray shape
46+
* @param {string} xtype - ndarray data type
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len, shape, xtype ) {
50+
var x;
51+
52+
x = zeros( len, xtype );
53+
x = {
54+
'dtype': xtype,
55+
'data': x,
56+
'shape': shape,
57+
'strides': shape2strides( shape, order ),
58+
'offset': 0,
59+
'order': order
60+
};
61+
return benchmark;
62+
63+
/**
64+
* Benchmark function.
65+
*
66+
* @private
67+
* @param {Benchmark} b - benchmark instance
68+
*/
69+
function benchmark( b ) {
70+
var out;
71+
var i;
72+
73+
b.tic();
74+
for ( i = 0; i < b.iterations; i++ ) {
75+
out = any( [ x ] );
76+
if ( typeof out !== 'boolean' ) {
77+
b.fail( 'should return a boolean' );
78+
}
79+
}
80+
b.toc();
81+
if ( !isBoolean( out ) ) {
82+
b.fail( 'should return a boolean' );
83+
}
84+
b.pass( 'benchmark finished' );
85+
b.end();
86+
}
87+
}
88+
89+
90+
// MAIN //
91+
92+
/**
93+
* Main execution sequence.
94+
*
95+
* @private
96+
*/
97+
function main() {
98+
var len;
99+
var min;
100+
var max;
101+
var sh;
102+
var t1;
103+
var f;
104+
var i;
105+
var j;
106+
107+
min = 1; // 10^min
108+
max = 6; // 10^max
109+
110+
for ( j = 0; j < types.length; j++ ) {
111+
t1 = types[ j ];
112+
for ( i = min; i <= max; i++ ) {
113+
len = pow( 10, i );
114+
115+
sh = [ len ];
116+
f = createBenchmark( len, sh, t1 );
117+
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+order+',xtype='+t1, f );
118+
}
119+
}
120+
}
121+
122+
main();

‎lib/node_modules/@stdlib/ndarray/base/any/benchmark/benchmark.1d_rowmajor.js

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
25+
var pow = require( '@stdlib/math/base/special/pow' );
26+
var zeros = require( '@stdlib/array/zeros' );
27+
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
28+
var pkg = require( './../package.json' ).name;
29+
var any = require( './../lib' );
30+
31+
32+
// VARIABLES //
33+
34+
var types = [ 'float64' ];
35+
var order = 'row-major';
36+
37+
38+
// FUNCTIONS //
39+
40+
/**
41+
* Creates a benchmark function.
42+
*
43+
* @private
44+
* @param {PositiveInteger} len - ndarray length
45+
* @param {NonNegativeIntegerArray} shape - ndarray shape
46+
* @param {string} xtype - ndarray data type
47+
* @returns {Function} benchmark function
48+
*/
49+
function createBenchmark( len, shape, xtype ) {
50+
var x;
51+
52+
x = zeros( len, xtype );
53+
x = {
54+
'dtype': xtype,
55+
'data': x,
56+
'shape': shape,
57+
'strides': shape2strides( shape, order ),
58+
'offset': 0,
59+
'order': order
60+
};
61+
return benchmark;
62+
63+
/**
64+
* Benchmark function.
65+
*
66+
* @private
67+
* @param {Benchmark} b - benchmark instance
68+
*/
69+
function benchmark( b ) {
70+
var out;
71+
var i;
72+
73+
b.tic();
74+
for ( i = 0; i < b.iterations; i++ ) {
75+
out = any( [ x ] );
76+
if ( typeof out !== 'boolean' ) {
77+
b.fail( 'should return a boolean' );
78+
}
79+
}
80+
b.toc();
81+
if ( !isBoolean( out ) ) {
82+
b.fail( 'should return a boolean' );
83+
}
84+
b.pass( 'benchmark finished' );
85+
b.end();
86+
}
87+
}
88+
89+
90+
// MAIN //
91+
92+
/**
93+
* Main execution sequence.
94+
*
95+
* @private
96+
*/
97+
function main() {
98+
var len;
99+
var min;
100+
var max;
101+
var sh;
102+
var t1;
103+
var f;
104+
var i;
105+
var j;
106+
107+
min = 1; // 10^min
108+
max = 6; // 10^max
109+
110+
for ( j = 0; j < types.length; j++ ) {
111+
t1 = types[ j ];
112+
for ( i = min; i <= max; i++ ) {
113+
len = pow( 10, i );
114+
115+
sh = [ len ];
116+
f = createBenchmark( len, sh, t1 );
117+
bench( pkg+':ndims='+sh.length+',len='+len+',shape=['+sh.join(',')+'],xorder='+order+',xtype='+t1, f );
118+
}
119+
}
120+
}
121+
122+
main();

0 commit comments

Comments
 (0)