Skip to content

Commit a35a9be

Browse files
Girish-GargGirish-Garg
committed
feat: add incremental maximum absolute value accumulator ignoring NaN values
1 parent 4b27caa commit a35a9be

File tree

10 files changed

+722
-0
lines changed

10 files changed

+722
-0
lines changed

‎lib/node_modules/@stdlib/stats/incr/nanmaxabs/README.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2018 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+
# incrnanmaxabs
22+
23+
> Compute a maximum absolute value incrementally.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var incrnanmaxabs = require( '@stdlib/stats/incr/nanmaxabs' );
31+
```
32+
33+
#### incrnanmaxabs()
34+
35+
Returns an accumulator `function` which incrementally computes a maximum absolute value.
36+
37+
```javascript
38+
var accumulator = incrnanmaxabs();
39+
```
40+
41+
#### accumulator( \[x] )
42+
43+
If provided an input value `x`, the accumulator function returns an updated maximum absolute value. If not provided an input value `x`, the accumulator function returns the current maximum absolute value.
44+
45+
```javascript
46+
var accumulator = incrnanmaxabs();
47+
48+
var max = accumulator( 2.0 );
49+
// returns 2.0
50+
51+
max = accumulator( 1.0 );
52+
// returns 2.0
53+
54+
max = accumulator( -3.0 );
55+
// returns 3.0
56+
57+
max = accumulator( NaN ); //Ignored
58+
// returns 3.0
59+
60+
max = accumulator();
61+
// returns 3.0
62+
```
63+
64+
</section>
65+
66+
<!-- /.usage -->
67+
68+
<section class="notes">
69+
70+
## Notes
71+
72+
- Input values are type checked. If provided `NaN` or any value which results in `NaN`, it will be ignored but you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
73+
74+
</section>
75+
76+
<!-- /.notes -->
77+
78+
<section class="examples">
79+
80+
## Examples
81+
82+
<!-- eslint no-undef: "error" -->
83+
84+
```javascript
85+
var randu = require( '@stdlib/random/base/randu' );
86+
var incrnanmaxabs = require( './../lib' );
87+
88+
var accumulator;
89+
var max;
90+
var v;
91+
var i;
92+
93+
// Initialize an accumulator:
94+
accumulator = incrnanmaxabs();
95+
96+
// For each simulated datum, update the max absolute value...
97+
for ( i = 0; i < 100; i++ ) {
98+
v = ( randu() < 0.2 ) ? NaN : (randu() * 100.0) - 50.0;
99+
max = accumulator( v );
100+
}
101+
console.log( accumulator() );
102+
```
103+
104+
</section>
105+
106+
<!-- /.examples -->
107+
108+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
109+
110+
<section class="related">
111+
112+
* * *
113+
114+
## See Also
115+
116+
- <span class="package-name">[`@stdlib/stats/incr/max`][@stdlib/stats/incr/max]</span><span class="delimiter">: </span><span class="description">compute a maximum value incrementally.</span>
117+
- <span class="package-name">[`@stdlib/stats/incr/minabs`][@stdlib/stats/incr/minabs]</span><span class="delimiter">: </span><span class="description">compute a minimum absolute value incrementally.</span>
118+
- <span class="package-name">[`@stdlib/stats/incr/mmaxabs`][@stdlib/stats/incr/mmaxabs]</span><span class="delimiter">: </span><span class="description">compute a moving maximum absolute value incrementally.</span>
119+
120+
</section>
121+
122+
<!-- /.related -->
123+
124+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
125+
126+
<section class="links">
127+
128+
<!-- <related-links> -->
129+
130+
[@stdlib/stats/incr/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/max
131+
132+
[@stdlib/stats/incr/minabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/minabs
133+
134+
[@stdlib/stats/incr/mmaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmaxabs
135+
136+
<!-- </related-links> -->
137+
138+
</section>
139+
140+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/incr/nanmaxabs/benchmark/benchmark.js‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2018 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 randu = require( '@stdlib/random/base/randu' );
25+
var pkg = require( './../package.json' ).name;
26+
var incrnanmaxabs = require( './../lib' );
27+
28+
29+
// MAIN //
30+
31+
bench( pkg, function benchmark( b ) {
32+
var f;
33+
var i;
34+
b.tic();
35+
for ( i = 0; i < b.iterations; i++ ) {
36+
f = incrnanmaxabs();
37+
if ( typeof f !== 'function' ) {
38+
b.fail( 'should return a function' );
39+
}
40+
}
41+
b.toc();
42+
if ( typeof f !== 'function' ) {
43+
b.fail( 'should return a function' );
44+
}
45+
b.pass( 'benchmark finished' );
46+
b.end();
47+
});
48+
49+
bench( pkg+'::accumulator', function benchmark( b ) {
50+
var acc;
51+
var v;
52+
var i;
53+
54+
acc = incrnanmaxabs();
55+
56+
b.tic();
57+
for ( i = 0; i < b.iterations; i++ ) {
58+
v = acc( randu()-0.5 );
59+
if ( v !== v ) {
60+
b.fail( 'should not return NaN' );
61+
}
62+
}
63+
b.toc();
64+
if ( v !== v ) {
65+
b.fail( 'should not return NaN' );
66+
}
67+
b.pass( 'benchmark finished' );
68+
b.end();
69+
});

‎lib/node_modules/@stdlib/stats/incr/nanmaxabs/docs/repl.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
{{alias}}()
3+
Returns an accumulator function which incrementally computes a maximum
4+
absolute value.
5+
6+
If provided a value, the accumulator function returns an updated maximum
7+
absolute value. If not provided a value, the accumulator function returns
8+
the current maximum absolute value.
9+
10+
If provided `NaN`, it will be ignored.
11+
12+
Returns
13+
-------
14+
acc: Function
15+
Accumulator function.
16+
17+
Examples
18+
--------
19+
> var accumulator = {{alias}}();
20+
> var m = accumulator()
21+
null
22+
> m = accumulator( 3.14 )
23+
3.14
24+
> m = accumulator( -5.0 )
25+
5.0
26+
> m = accumulator( 10.1 )
27+
10.1
28+
> m = accumulator( NaN )
29+
10.1
30+
> m = accumulator()
31+
10.1
32+
33+
See Also
34+
--------
35+

‎lib/node_modules/@stdlib/stats/incr/nanmaxabs/docs/types/index.d.ts‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2019 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+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
/**
24+
* If provided a value, returns an updated maximum absolute value; otherwise, returns the current maximum absolute value.
25+
*
26+
* ## Notes
27+
*
28+
* - If provided `NaN` or a value which, when used in computations, results in `NaN`, it will be ignored.
29+
*
30+
* @param x - value
31+
* @returns maximum absolute value
32+
*/
33+
type accumulator = ( x?: number ) => number | null;
34+
35+
/**
36+
* Returns an accumulator function which incrementally computes a maximum absolute value.
37+
*
38+
* @returns accumulator function
39+
*
40+
* @example
41+
* var accumulator = incrmaxabs();
42+
*
43+
* var v = accumulator();
44+
* // returns null
45+
*
46+
* v = accumulator( 2.0 );
47+
* // returns 2.0
48+
*
49+
* v = accumulator( -3.0 );
50+
* // returns 3.0
51+
*
52+
* v = accumulator( 1.0 );
53+
* // returns 3.0
54+
*
55+
* v = accumulator( NaN );
56+
* // returns 3.0
57+
*
58+
* v = accumulator();
59+
* // returns 3.0
60+
*/
61+
declare function incrmaxabs(): accumulator;
62+
63+
64+
// EXPORTS //
65+
66+
export = incrmaxabs;

‎lib/node_modules/@stdlib/stats/incr/nanmaxabs/docs/types/test.ts‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2019 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+
import incrnanmaxabs = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The function returns an accumulator function...
25+
{
26+
incrnanmaxabs(); // $ExpectType accumulator
27+
}
28+
29+
// The compiler throws an error if the function is provided arguments...
30+
{
31+
incrnanmaxabs( '5' ); // $ExpectError
32+
incrnanmaxabs( 5 ); // $ExpectError
33+
incrnanmaxabs( true ); // $ExpectError
34+
incrnanmaxabs( false ); // $ExpectError
35+
incrnanmaxabs( null ); // $ExpectError
36+
incrnanmaxabs( undefined ); // $ExpectError
37+
incrnanmaxabs( [] ); // $ExpectError
38+
incrnanmaxabs( {} ); // $ExpectError
39+
incrnanmaxabs( ( x: number ): number => x ); // $ExpectError
40+
}
41+
42+
// The function returns an accumulator function which returns an accumulated result...
43+
{
44+
const acc = incrnanmaxabs();
45+
46+
acc(); // $ExpectType number | null
47+
acc( 3.14 ); // $ExpectType number | null
48+
}
49+
50+
// The compiler throws an error if the returned accumulator function is provided invalid arguments...
51+
{
52+
const acc = incrnanmaxabs();
53+
54+
acc( '5' ); // $ExpectError
55+
acc( true ); // $ExpectError
56+
acc( false ); // $ExpectError
57+
acc( null ); // $ExpectError
58+
acc( [] ); // $ExpectError
59+
acc( {} ); // $ExpectError
60+
acc( ( x: number ): number => x ); // $ExpectError
61+
}

0 commit comments

Comments
 (0)