Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 149 additions & 0 deletions lib/node_modules/@stdlib/array/base/count-ifs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
<!--

@license Apache-2.0

Copyright (c) 2025 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.

-->

# countIfs

> Count the number of elements in the input arrays which pass the tests implemented by the predicate functions.

<!-- 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 countIfs = require( '@stdlib/array/base/count-ifs' );
```

#### countIfs( x0, predicate0\[, x1, predicate1\[, x2, predicate2, ...]] )

Counts the number of elements in the input arrays which pass the tests implemented by the predicate functions.

```javascript
function predicate0( value ) {
return ( value > 0 );
}

function predicate1( value ) {
return ( value < 3 );
}

var x0 = [ 0, 1, 0, 1, 2 ];
var x1 = [ 2, 3, 1, 2, 5 ];

var out = countIfs( x0, predicate0, x1, predicate1 );
// returns 1
```

The `predicate` function is provided three arguments:

- **value**: current array element.
- **index**: current array element index.
- **arr**: input array.

</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

- The function assumes that all input arrays have the same length.
- The function supports array-like objects supporting the accessor protocol (e.g., [`Complex128Array`][@stdlib/array/complex128], [`Complex64Array`][@stdlib/array/complex64], etc).

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
var isNegativeInteger = require( '@stdlib/assert/is-negative-integer' ).isPrimitive;
var naryFunction = require( '@stdlib/utils/nary-function' );
var countIfs = require( '@stdlib/array/base/count-ifs' );

var x = discreteUniform( 10, -5, 5, {
'dtype': 'int32'
});
// returns <Int32Array>

var y = discreteUniform( 10, -5, 5, {
'dtype': 'int32'
});
// returns <Int32Array>

var out = countIfs( x, naryFunction( isPositiveInteger, 1 ), y, naryFunction( isNegativeInteger, 1 ) ); // eslint-disable-line max-len
// returns <number>

console.log( x );
console.log( y );
console.log( out );
```

</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">

[@stdlib/array/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128

[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var pkg = require( './../package.json' ).name;
var countIfs = require( './../lib' );


// FUNCTIONS //

/**
* First predicate function.
*
* @private
* @param {number} v - value
* @returns {boolean} result
*/
function predicate0( v ) {
return v > 0.0;
}

/**
* Second predicate function.
*
* @private
* @param {number} v - value
* @returns {boolean} result
*/
function predicate1( v ) {
return v < 0.0;
}

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x0 = bernoulli( len, 0.5, {
'dtype': 'generic'
});
var x1 = bernoulli( len, 0.5, {
'dtype': 'generic'
});
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 = countIfs( x0, predicate0, x1, predicate1 );
if ( typeof out !== 'number' ) {
b.fail( 'should return a number' );
}
}
b.toc();
if ( !isNonNegativeInteger( out ) ) {
b.fail( 'should return a nonnegative integer' );
}
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();
39 changes: 39 additions & 0 deletions lib/node_modules/@stdlib/array/base/count-ifs/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

{{alias}}( x0, predicate0[, x1, predicate1[, x2, predicate2, ...]] )
Counts the number of elements in the input arrays which pass the tests
implemented by the predicate functions.

The predicate function is provided three arguments:

- value: current array element.
- index: current array element index.
- arr: the input array.

Parameters
----------
x0: ArrayLikeObject
First input array.

predicate0: Function
First predicate function.

x1: ArrayLikeObject (optional)
Second input array.

predicate1: Function (optional)
Second predicate function.

Returns
-------
out: integer
Result.

Examples
--------
> function f1( v ) { return ( v > 0 ); };
> function f2( v ) { return ( v < 0 ); };
> var out = {{alias}}( [ 0, 1, 1 ], f1, [ 1, -1, -1 ], f2 )
2

See Also
--------
Loading