Skip to content

feat: add stats/array/nanmin-by #7255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
155 changes: 155 additions & 0 deletions lib/node_modules/@stdlib/stats/array/nanmin-by/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
<!--

@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.

-->

# nanminBy

> Calculate the minimum value of an array via a callback function, ignoring `NaN` values.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var nanminBy = require( '@stdlib/stats/array/nanmin-by' );
```

#### nanminBy( x, clbk\[, thisArg] )

Computes the minimum value of an array via a callback function, ignoring `NaN` values.

```javascript
function accessor( v ) {
return v * 2.0;
}

var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0, NaN ];

var v = nanminBy( x, accessor );
// returns -10.0
```

The function has the following parameters:

- **x**: input array.
- **clbk**: callback function.
- **thisArg**: execution context (_optional_).

The invoked callback is provided three arguments:

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

To set the callback execution context, provide a `thisArg`.

```javascript
function accessor( v ) {
this.count += 1;
return v * 2.0;
}

var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0, NaN ];

var context = {
'count': 0
};

var v = nanminBy( x, accessor, context );
// returns -10.0

var cnt = context.count;
// returns 10
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If provided an empty array, the function returns `NaN`.
- A provided callback function should return a numeric value.
- If a provided callback function returns `NaN`, the value is **ignored**.
- If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is **ignored**.
- The function supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var nanminBy = require( '@stdlib/stats/array/nanmin-by' );

function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -50.0, 50.0 );
}

function accessor( v ) {
return v * 2.0;
}

var x = filledarrayBy( 10, 'float64', rand );
console.log( x );

var v = nanminBy( x, accessor );
console.log( v );
```

</section>

<!-- /.examples -->

<!-- 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/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor

</section>

<!-- /.links -->
115 changes: 115 additions & 0 deletions lib/node_modules/@stdlib/stats/array/nanmin-by/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/**
* @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 uniform = require( '@stdlib/random/base/uniform' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
var nanminBy = require( './../lib' );


// FUNCTIONS //

/**
* Accessor function.
*
* @private
* @param {number} value - array element
* @returns {number} accessed value
*/
function accessor( value ) {
return value * 2.0;
}

/**
* Returns a random number.
*
* @private
* @returns {number} random number
*/
function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -10.0, 10.0 );
}

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filledarrayBy( len, 'generic', rand );
return benchmark;

function benchmark( b ) {
var v;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = nanminBy( x, accessor );
if ( isnan( v ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( v ) ) {
b.fail( 'should not return NaN' );
}
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+':len='+len, f );
}
}

main();
46 changes: 46 additions & 0 deletions lib/node_modules/@stdlib/stats/array/nanmin-by/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@

{{alias}}( x, clbk[, thisArg] )
Computes the minimum value of an array via a callback function, ignoring
`NaN` values.

If provided an empty array, the function returns `NaN`.

The callback function is provided three arguments:

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

The callback function should return a numeric value.

If the callback function returns `NaN`, the value is ignored.

If the callback function does not return any value (or equivalently,
explicitly returns `undefined`), the value is ignored.

Parameters
----------
x: Array|TypedArray
Input array.

clbk: Function
Callback function.

thisArg: any (optional)
Execution context.

Returns
-------
out: number
Minimum value.

Examples
--------
> function accessor( v ) { return v * 2.0; };
> var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, -1.0, -3.0 ];
> {{alias}}( x, accessor )
-10.0

See Also
--------

Loading