Skip to content
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

feat: add accessor protocol support and refactor stats/base/nanmin #6211

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open
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
59 changes: 24 additions & 35 deletions lib/node_modules/@stdlib/stats/base/nanmin/README.md
Original file line number Diff line number Diff line change
@@ -36,33 +36,29 @@ limitations under the License.
var nanmin = require( '@stdlib/stats/base/nanmin' );
```

#### nanmin( N, x, stride )
#### nanmin( N, x, strideX )

Computes the minimum value of a strided array `x`, ignoring `NaN` values.
Computes the minimum value of a strided array, ignoring `NaN` values.

```javascript
var x = [ 1.0, -2.0, NaN, 2.0 ];
var N = x.length;

var v = nanmin( N, x, 1 );
var v = nanmin( 4, x, 1 );
// returns -2.0
```

The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
- **stride**: index increment for `x`.
- **strideX**: stride length for `x`.

The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the minimum value of every other element in `x`,
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum value of every other element in `x`,

```javascript
var floor = require( '@stdlib/math/base/special/floor' );

var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ];
var N = floor( x.length / 2 );

var v = nanmin( N, x, 2 );
var v = nanmin( 5, x, 2 );
// returns -2.0
```

@@ -72,42 +68,35 @@ Note that indexing is relative to the first index. To introduce an offset, use [

```javascript
var Float64Array = require( '@stdlib/array/float64' );
var floor = require( '@stdlib/math/base/special/floor' );

var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 4.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var N = floor( x0.length / 2 );

var v = nanmin( N, x1, 2 );
var v = nanmin( 4, x1, 2 );
// returns -2.0
```

#### nanmin.ndarray( N, x, stride, offset )
#### nanmin.ndarray( N, x, strideX, offsetX )

Computes the minimum value of a strided array, ignoring `NaN` values and using alternative indexing semantics.

```javascript
var x = [ 1.0, -2.0, NaN, 2.0 ];
var N = x.length;

var v = nanmin.ndarray( N, x, 1, 0 );
var v = nanmin.ndarray( 4, x, 1, 0 );
// returns -2.0
```

The function has the following additional parameters:

- **offset**: starting index for `x`.
- **offsetX**: starting index for `x`.

While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum value for every other value in `x` starting from the second value
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the minimum value for every other element in `x` starting from the second element

```javascript
var floor = require( '@stdlib/math/base/special/floor' );

var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 2.0, 3.0, 4.0 ];
var N = floor( x.length / 2 );

var v = nanmin.ndarray( N, x, 2, 1 );
var v = nanmin.ndarray( 5, x, 2, 1 );
// returns -2.0
```

@@ -120,6 +109,7 @@ var v = nanmin.ndarray( N, x, 2, 1 );
## Notes

- If `N <= 0`, both functions return `NaN`.
- 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]).
- Depending on the environment, the typed versions ([`dnanmin`][@stdlib/stats/strided/dnanmin], [`snanmin`][@stdlib/stats/strided/snanmin], etc.) are likely to be significantly more performant.

</section>
@@ -133,22 +123,19 @@ var v = nanmin.ndarray( N, x, 2, 1 );
<!-- eslint no-undef: "error" -->

```javascript
var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var Float64Array = require( '@stdlib/array/float64' );
var uniform = require( '@stdlib/random/base/uniform' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var nanmin = require( '@stdlib/stats/base/nanmin' );

var x;
var i;

x = new Float64Array( 10 );
for ( i = 0; i < x.length; i++ ) {
if ( randu() < 0.2 ) {
x[ i ] = NaN;
} else {
x[ i ] = round( (randu()*100.0) - 50.0 );
function rand() {
if ( bernoulli( 0.8 ) < 1 ) {
return NaN;
}
return uniform( -50.0, 50.0 );
}

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

var v = nanmin( x.length, x, 1 );
@@ -184,6 +171,8 @@ console.log( v );

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

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

<!-- <related-links> -->

[@stdlib/stats/strided/dnanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmin
31 changes: 18 additions & 13 deletions lib/node_modules/@stdlib/stats/base/nanmin/benchmark/benchmark.js
Original file line number Diff line number Diff line change
@@ -21,15 +21,30 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/base/uniform' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
var nanmin = require( './../lib/nanmin.js' );
var nanmin = require( './../lib/main.js' );


// FUNCTIONS //

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

/**
* Creates a benchmark function.
*
@@ -38,17 +53,7 @@ var nanmin = require( './../lib/nanmin.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = [];
for ( i = 0; i < len; i++ ) {
if ( randu() < 0.2 ) {
x.push( NaN );
} else {
x.push( ( randu()*20.0 ) - 10.0 );
}
}
var x = filledarrayBy( len, 'generic', rand );
return benchmark;

function benchmark( b ) {
Original file line number Diff line number Diff line change
@@ -21,7 +21,9 @@
// MODULES //

var bench = require( '@stdlib/bench' );
var randu = require( '@stdlib/random/base/randu' );
var uniform = require( '@stdlib/random/base/uniform' );
var filledarrayBy = require( '@stdlib/array/filled-by' );
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var pkg = require( './../package.json' ).name;
@@ -30,6 +32,19 @@ var nanmin = require( './../lib/ndarray.js' );

// FUNCTIONS //

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

/**
* Creates a benchmark function.
*
@@ -38,17 +53,7 @@ var nanmin = require( './../lib/ndarray.js' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = [];
for ( i = 0; i < len; i++ ) {
if ( randu() < 0.2 ) {
x.push( NaN );
} else {
x.push( ( randu()*20.0 ) - 10.0 );
}
}
var x = filledarrayBy( len, 'generic', rand );
return benchmark;

function benchmark( b ) {
36 changes: 16 additions & 20 deletions lib/node_modules/@stdlib/stats/base/nanmin/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

{{alias}}( N, x, stride )
{{alias}}( N, x, strideX )
Computes the minimum value of a strided array, ignoring `NaN` values.

The `N` and `stride` parameters determine which elements in `x` are accessed
at runtime.
The `N` and stride parameters determine which elements in the strided array
are accessed at runtime.

Indexing is relative to the first index. To introduce an offset, use a typed
array view.
@@ -18,8 +18,8 @@
x: Array<number>|TypedArray
Input array.

stride: integer
Index increment.
strideX: integer
Stride length.

Returns
-------
@@ -30,25 +30,22 @@
--------
// Standard Usage:
> var x = [ 1.0, -2.0, NaN, 2.0 ];
> {{alias}}( x.length, x, 1 )
> {{alias}}( 4, x, 1 )
-2.0

// Using `N` and `stride` parameters:
// Using `N` and stride parameters:
> x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ];
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> var stride = 2;
> {{alias}}( N, x, stride )
> {{alias}}( 4, x, 2 )
-2.0

// Using view offsets:
> var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] );
> var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
> N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
> stride = 2;
> {{alias}}( N, x1, stride )
> {{alias}}( 4, x1, 2 )
-2.0

{{alias}}.ndarray( N, x, stride, offset )

{{alias}}.ndarray( N, x, strideX, offsetX )
Computes the minimum value of a strided array, ignoring `NaN` values and
using alternative indexing semantics.

@@ -64,10 +61,10 @@
x: Array<number>|TypedArray
Input array.

stride: integer
Index increment.
strideX: integer
Stride length.

offset: integer
offsetX: integer
Starting index.

Returns
@@ -79,13 +76,12 @@
--------
// Standard Usage:
> var x = [ 1.0, -2.0, NaN, 2.0 ];
> {{alias}}.ndarray( x.length, x, 1, 0 )
> {{alias}}.ndarray( 4, x, 1, 0 )
-2.0

// Using offset parameter:
> var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ];
> var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
> {{alias}}.ndarray( N, x, 2, 1 )
> {{alias}}.ndarray( 4, x, 2, 1 )
-2.0

See Also
19 changes: 12 additions & 7 deletions lib/node_modules/@stdlib/stats/base/nanmin/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -20,7 +20,12 @@

/// <reference types="@stdlib/types"/>

import { NumericArray } from '@stdlib/types/array';
import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';

/**
* Input array.
*/
type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;

/**
* Interface describing `nanmin`.
@@ -31,7 +36,7 @@ interface Routine {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns minimum value
*
* @example
@@ -40,15 +45,15 @@ interface Routine {
* var v = nanmin( x.length, x, 1 );
* // returns -2.0
*/
( N: number, x: NumericArray, stride: number ): number;
( N: number, x: InputArray, strideX: number ): number;

/**
* Computes the minimum value of a strided array, ignoring `NaN` values and using alternative indexing semantics.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param offset - starting index
* @param strideX - stride length
* @param offsetX - starting index
* @returns minimum value
*
* @example
@@ -57,15 +62,15 @@ interface Routine {
* var v = nanmin.ndarray( x.length, x, 1, 0 );
* // returns -2.0
*/
ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;
ndarray( N: number, x: InputArray, strideX: number, offsetX: number ): number;
}

/**
* Computes the minimum value of a strided array, ignoring `NaN` values.
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns minimum value
*
* @example
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/stats/base/nanmin/docs/types/test.ts
21 changes: 9 additions & 12 deletions lib/node_modules/@stdlib/stats/base/nanmin/examples/index.js
14 changes: 9 additions & 5 deletions lib/node_modules/@stdlib/stats/base/nanmin/lib/index.js
21 changes: 18 additions & 3 deletions lib/node_modules/@stdlib/stats/base/nanmin/lib/main.js
28 changes: 16 additions & 12 deletions lib/node_modules/@stdlib/stats/base/nanmin/lib/ndarray.js
110 changes: 100 additions & 10 deletions lib/node_modules/@stdlib/stats/base/nanmin/test/test.ndarray.js