Auto-generated commit

base/any/README.md

@@ -0,0 +1,118 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# any
+
+> Test whether at least one element in an array is truthy.
+
+<!-- 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 any = require( '@stdlib/array/base/any' );
+```
+
+#### any( x )
+
+Tests whether at least one element in an array is truthy.
+
+```javascript
+var x = [ 0, 0, 1, 0 ];
+
+var bool = any( x );
+// returns true
+```
+
+</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 provided an empty array, the function returns `false`.
+-   The function does **not** skip `undefined` elements and is thus not optimized for sparse arrays.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
+var any = require( '@stdlib/array/base/any' );
+
+var x = bernoulli( 10, 0.1, {
+    'dtype': 'int8'
+} );
+// returns <Int8Array>
+
+var out = any( x );
+// returns <boolean>
+```
+
+</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">
+
+</section>
+
+<!-- /.links -->

base/any/benchmark/benchmark.length.js

@@ -0,0 +1,96 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 pow = require( '@stdlib/math/base/special/pow' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var zeros = require( './../../../base/zeros' );
+var pkg = require( './../package.json' ).name;
+var any = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = zeros( len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = any( x );
+			if ( typeof out !== 'boolean' ) {
+				b.fail( 'should return a boolean' );
+			}
+		}
+		b.toc();
+		if ( !isBoolean( out ) ) {
+			b.fail( 'should return a boolean' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+
+		f = createBenchmark( len );
+		bench( pkg+':dtype=generic,len='+len, f );
+	}
+}
+
+main();

base/any/docs/repl.txt

@@ -0,0 +1,28 @@
+
+{{alias}}( x )
+    Tests whether at least one element in an array is truthy.
+
+    The function returns immediately upon encountering a truthy value.
+
+    If provided an empty array, the function returns `false`.
+
+    Parameters
+    ----------
+    x: Array|TypedArray|Object
+        Input array.
+
+    Returns
+    -------
+    bool: boolean
+        The function returns `true` if at least one element is truthy;
+        otherwise, the function returns `false`.
+
+    Examples
+    --------
+    > var x = [ 0, 0, 1, 0 ];
+    > var out = {{alias}}( x )
+    true
+
+    See Also
+    --------
+

base/any/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Tests whether at least one element in an array is truthy.
+*
+* ## Notes
+*
+* -   The function immediately returns upon encountering a truthy value.
+* -   If provided an empty collection, the function returns `false`.
+*
+* @param x - input array
+* @returns boolean indicating whether at least one element is truthy
+*
+* @example
+* var x = [ 0, 0, 1, 0 ];
+*
+* var out = any( x );
+* // returns true
+*/
+declare function any<T = unknown>( x: Collection<T> | AccessorArrayLike<T> ): boolean;
+
+
+// EXPORTS //
+
+export = any;

base/any/docs/types/test.ts

@@ -0,0 +1,52 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+import toAccessorArray = require( './../../../../base/to-accessor-array' );
+import any = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	any( [ 1, 2, 3 ] ); // $ExpectType boolean
+	any( new Float64Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Float32Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Int32Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Int16Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Int8Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Uint32Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Uint16Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Uint8Array( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( new Uint8ClampedArray( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+	any( toAccessorArray( [ 1, 2, 3 ] ) ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a collection...
+{
+	any( 2 ); // $ExpectError
+	any( false ); // $ExpectError
+	any( true ); // $ExpectError
+	any( {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	any(); // $ExpectError
+	any( [ 1, 2, 3 ], {}, 3 ); // $ExpectError
+}

base/any/examples/index.js

@@ -0,0 +1,33 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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';
+
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
+var any = require( './../lib' );
+
+var x = bernoulli( 10, 0.1, {
+	'dtype': 'int8'
+} );
+// returns <Int8Array>
+
+var out = any( x );
+// returns <boolean>
+
+console.log( x );
+console.log( out );