diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/README.md b/lib/node_modules/@stdlib/stats/incr/nanmrss/README.md new file mode 100644 index 000000000000..ae88b0ef2f9f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/README.md @@ -0,0 +1,186 @@ + + +# incrnanmrss + +> Compute a moving [residual sum of squares][residual-sum-of-squares] (RSS) incrementally, ignoring `NaN` calues. + +
+ +For a window of size `W`, the [residual sum of squares][residual-sum-of-squares] (also referred to as the **sum of squared residuals** (SSR) and the **sum of squared errors** (SSE)) is defined as + + + +```math +\mathop{\mathrm{RSS}} = \sum_{i=0}^{W-1} (y_i - x_i)^2 +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var incrnanmrss = require( '@stdlib/stats/incr/nanmrss' ); +``` + +#### incrnanmrss( window ) + +Returns an accumulator `function` which incrementally computes a moving [residual sum of squares][residual-sum-of-squares]. The `window` parameter defines the number of values over which to compute the moving [residual sum of squares][residual-sum-of-squares], ignoring `NaN` values. + +```javascript +var accumulator = incrnanmrss( 3 ); +``` + +#### accumulator( \[x, y] ) + +If provided input values `x` and `y`, the accumulator function returns an updated [residual sum of squares][residual-sum-of-squares]. If not provided input values `x` and `y`, the accumulator function returns the current [residual sum of squares][residual-sum-of-squares]. + +```javascript +var accumulator = incrnanmrss( 3 ); + +var r = accumulator(); +// returns null + +// Fill the window... +r = accumulator( 2.0, 3.0 ); // [(2.0,3.0)] +// returns 1.0 + +// Fill the window... +r = accumulator( NaN, 3.0 ); // [(2.0,3.0), ( NaN, 3.0)] +// returns 1.0 + +// Fill the window... +r = accumulator( 2.0, NaN ); // [(2.0,3.0), ( NaN, 3.0), ( 2.0, NaN )] +// returns 1.0 + +// Fill the window... +r = accumulator( NaN, NaN ); // [(2.0,3.0)] +// returns 1.0 + +r = accumulator( -1.0, 4.0 ); // [(2.0,3.0), (-1.0,4.0)] +// returns 26.0 + +r = accumulator( 3.0, 9.0 ); // [(2.0,3.0), (-1.0,4.0), (3.0,9.0)] +// returns 62.0 + +// Window begins sliding... +r = accumulator( -7.0, 3.0 ); // [(-1.0,4.0), (3.0,9.0), (-7.0,3.0)] +// returns 161.0 + +r = accumulator( -5.0, -3.0 ); // [(3.0,9.0), (-7.0,3.0), (-5.0,-3.0)] +// returns 140.0 + +r = accumulator(); +// returns 140.0 +``` + +
+ + + +
+ +## Notes + +- Input values are **not** type checked. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function. +- As `W` (x,y) pairs are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values. + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var incrnanmrss = require( '@stdlib/stats/incr/nanmrss' ); + +var accumulator; +var v1; +var v2; +var i; + +// Initialize an accumulator: +accumulator = incrnanmrss( 5 ); + +// For each simulated datum, update the moving residual sum of squares... +for ( i = 0; i < 100; i++ ) { + v1 = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ); + v2 = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ); + accumulator( v1, v2 ); +} +console.log( accumulator() ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanmrss/benchmark/benchmark.js new file mode 100644 index 000000000000..59e0712908da --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/benchmark/benchmark.js @@ -0,0 +1,69 @@ +/** +* @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 randu = require( '@stdlib/random/base/randu' ); +var pkg = require( './../package.json' ).name; +var incrnanmrss = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanmrss( (i%5)+1 ); + if ( typeof f !== 'function' ) { + b.fail( 'should return a function' ); + } + } + b.toc(); + if ( typeof f !== 'function' ) { + b.fail( 'should return a function' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::accumulator', function benchmark( b ) { + var acc; + var v; + var i; + + acc = incrnanmrss( 5 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = acc( randu()-0.5, randu()-0.5 ); + if ( v !== v ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( v !== v ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/img/equation_residual_sum_of_squares.svg b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/img/equation_residual_sum_of_squares.svg new file mode 100644 index 000000000000..3d39639ab430 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/img/equation_residual_sum_of_squares.svg @@ -0,0 +1,52 @@ + +upper R upper S upper S equals sigma-summation Underscript i equals 0 Overscript upper W minus 1 Endscripts left-parenthesis y Subscript i Baseline minus x Subscript i Baseline right-parenthesis squared + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/repl.txt new file mode 100644 index 000000000000..256b89602fbc --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/repl.txt @@ -0,0 +1,51 @@ + +{{alias}}( W ) + Returns an accumulator function which incrementally computes a moving + residual sum of squares (RSS), ignoring `NaN` values. + + The `W` parameter defines the number of values over which to compute the + moving residual sum of squares. + + If provided a value, the accumulator function returns an updated moving + residual sum of squares. If not provided a value, the accumulator function + returns the current moving residual sum of squares. + + As `W` values are needed to fill the window buffer, the first `W-1` returned + values are calculated from smaller sample sizes. Until the window is full, + each returned value is calculated from all provided values. + + Parameters + ---------- + W: integer + Window size. + + Returns + ------- + acc: Function + Accumulator function. + + Examples + -------- + > var accumulator = {{alias}}( 3 ); + > var r = accumulator() + null + > r = accumulator( 2.0, 3.0 ) + 1.0 + > r = accumulator( NaN, 3.0 ) + 1.0 + > r = accumulator( 2.0, NaN ) + 1.0 + > r = accumulator( NaN, NaN ) + 1.0 + > r = accumulator( -5.0, 2.0 ) + 50.0 + > r = accumulator( 3.0, 2.0 ) + 51.0 + > r = accumulator( 5.0, -2.0 ) + 99.0 + > r = accumulator() + 99.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/types/index.d.ts new file mode 100644 index 000000000000..26bfe8ce5f1b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/types/index.d.ts @@ -0,0 +1,79 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/// + +/** +* If provided arguments, returns an updated residual sum of squares; otherwise, returns the current residual sum of squares, ignoring `NaN` values. +* +* @param x - value +* @param y - value +* @returns residual sum of squares +*/ +type accumulator = ( x?: number, y?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes a moving residual sum of squares, ignoring `NaN` values. +* +* ## Notes +* +* - The `W` parameter defines the number of values over which to compute the moving residual sum of squares. +* - As `W` values are needed to fill the window buffer, the first `W-1` returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values. +* +* @param W - window size +* @throws must provide a positive integer +* @returns accumulator function +* +* @example +* var accumulator = incrmrss( 3 ); +* +* var r = accumulator(); +* // returns null +* +* r = accumulator( 2.0, 3.0 ); +* // returns 1.0 +* +* r = accumulator( NaN, NaN ); +* // returns 1.0 +* +* r = accumulator( 2.0, NaN ); +* // returns 1.0 +* +* r = accumulator( NaN, 3.0 ); +* // returns 1.0 +* +* r = accumulator( -5.0, 2.0 ); +* // returns 50.0 +* +* r = accumulator( 3.0, 2.0 ); +* // returns 51.0 +* +* r = accumulator( 5.0, -2.0 ); +* // returns 99.0 +* +* r = accumulator(); +* // returns 99.0 +*/ +declare function incrnanmrss( W: number ): accumulator; + + +// EXPORTS // + +export = incrnanmrss; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/types/test.ts new file mode 100644 index 000000000000..77d1f992fd79 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/docs/types/test.ts @@ -0,0 +1,74 @@ +/* +* @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. +*/ + +import incrnanmrss = require( './index' ); + + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanmrss( 3 ); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided an argument that is not a number... +{ + incrnanmrss( '5' ); // $ExpectError + incrnanmrss( true ); // $ExpectError + incrnanmrss( false ); // $ExpectError + incrnanmrss( null ); // $ExpectError + incrnanmrss( undefined ); // $ExpectError + incrnanmrss( [] ); // $ExpectError + incrnanmrss( {} ); // $ExpectError + incrnanmrss( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an invalid number of arguments... +{ + incrnanmrss(); // $ExpectError + incrnanmrss( 2, 3 ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanmrss( 3 ); + + acc(); // $ExpectType number | null + acc( 3.14, 2.0 ); // $ExpectType number | null +} + +// The compiler throws an error if the returned accumulator function is provided invalid arguments... +{ + const acc = incrnanmrss( 3 ); + + acc( '5', 1.0 ); // $ExpectError + acc( true, 1.0 ); // $ExpectError + acc( false, 1.0 ); // $ExpectError + acc( null, 1.0 ); // $ExpectError + acc( [], 1.0 ); // $ExpectError + acc( {}, 1.0 ); // $ExpectError + acc( ( x: number ): number => x, 1.0 ); // $ExpectError + + acc( 3.14, '5' ); // $ExpectError + acc( 3.14, true ); // $ExpectError + acc( 3.14, false ); // $ExpectError + acc( 3.14, null ); // $ExpectError + acc( 3.14, [] ); // $ExpectError + acc( 3.14, {} ); // $ExpectError + acc( 3.14, ( x: number ): number => x ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanmrss/examples/index.js new file mode 100644 index 000000000000..8a2b9d6e37d5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/examples/index.js @@ -0,0 +1,41 @@ +/** +* @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'; + +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var incrnanmrss = require( './../lib' ); + +var accumulator; +var rss; +var v1; +var v2; +var i; + +// Initialize an accumulator: +accumulator = incrnanmrss( 5 ); + +// For each simulated datum, update the moving residual sum of squares... +console.log( '\nValue\tValue\tRSS\n' ); +for ( i = 0; i < 100; i++ ) { + v1 = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ); + v2 = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ); + rss = accumulator( v1, v2 ); + console.log( '%s\t%s\t%s', ((Number.isNaN(v1)) ? 'NaN' : v1.toFixed(3)), ((Number.isNaN(v2)) ? 'NaN' : v2.toFixed(3)), (((rss !== null) && (!Number.isNaN(rss))) ? rss.toFixed(3) : 'null')); +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanmrss/lib/index.js new file mode 100644 index 000000000000..fc5efd0ae1e6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/lib/index.js @@ -0,0 +1,66 @@ +/** +* @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'; + +/** +* Compute a moving residual sum of squares (RSS) incrementally, ignoring `NaN` values. +* +* @module @stdlib/stats/incr/nanmrss +* +* @example +* var incrnanmrss = require( '@stdlib/stats/incr/nanmrss' ); +* +* var accumulator = incrnanmrss( 3 ); +* +* var r = accumulator(); +* // returns null +* +* r = accumulator( 2.0, 3.0 ); +* // returns 1.0 +* +* r = accumulator( NaN, 3.0 ); +* // returns 1.0 +* +* r = accumulator( 2.0, NaN ); +* // returns 1.0 +* +* r = accumulator( NaN, NaN ); +* // returns 1.0 +* +* r = accumulator( -5.0, 2.0 ); +* // returns 50.0 +* +* r = accumulator( 3.0, 2.0 ); +* // returns 51.0 +* +* r = accumulator( 5.0, -2.0 ); +* // returns 99.0 +* +* r = accumulator(); +* // returns 99.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanmrss/lib/main.js new file mode 100644 index 000000000000..e747f79f06a2 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/lib/main.js @@ -0,0 +1,89 @@ +/** +* @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var incrmrss = require( '@stdlib/stats/incr/mrss' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes a moving residual sum of squares, ignoring `NaN` values. +* +* @param {PositiveInteger} W - window size +* @throws {TypeError} must provide a positive integer +* @returns {Function} accumulator function +* +* @example +* var accumulator = incrnanmrss( 3 ); +* +* var r = accumulator(); +* // returns null +* +* r = accumulator( 2.0, 3.0 ); +* // returns 1.0 +* +* r = accumulator( NaN, 3.0 ); +* // returns 1.0 +* +* r = accumulator( 2.0, NaN ); +* // returns 1.0 +* +* r = accumulator( NaN, NaN ); +* // returns 1.0 +* +* r = accumulator( -5.0, 2.0 ); +* // returns 50.0 +* +* r = accumulator( 3.0, 2.0 ); +* // returns 51.0 +* +* r = accumulator( 5.0, -2.0 ); +* // returns 99.0 +* +* r = accumulator(); +* // returns 99.0 +*/ +function incrnanmrss( W ) { + var mrss = incrmrss( W ); + return accumulator; + + /** + * If provided input values, the accumulator function returns an updated residual sum of squares. If not provided input values, the accumulator function returns the current residual sum of squares. + * + * @private + * @param {number} [x] - input value + * @param {number} [y] - input value + * @returns {(number|null)} residual sum of squares or null + */ + function accumulator( x, y ) { + if ( arguments.length === 0 || isnan( x ) || isnan( y ) ) { + return mrss(); + } + return mrss( ( ( isnan( x ) ) ? 0 : x), ( ( isnan( y ) ) ? 0 : y ) ); + } +} + + +// EXPORTS // + +module.exports = incrnanmrss; diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/package.json b/lib/node_modules/@stdlib/stats/incr/nanmrss/package.json new file mode 100644 index 000000000000..85952d1d4618 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/package.json @@ -0,0 +1,91 @@ +{ + "name": "@stdlib/stats/incr/nanmrss", + "version": "0.0.0", + "description": "Compute a moving residual sum of squares (RSS) incrementally, ignoring `NaN` values.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "error", + "err", + "rss", + "ssr", + "sse", + "residuals", + "sum", + "total", + "squares", + "deviation", + "difference", + "diff", + "delta", + "incremental", + "accumulator", + "sliding window", + "sliding", + "window", + "moving", + "time series", + "timeseries", + "forecasting", + "forecast", + "model", + "selection", + "evaluation", + "prediction", + "manhattan", + "cityblock", + "city-block", + "distance", + "dist" + ] +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanmrss/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanmrss/test/test.js new file mode 100644 index 000000000000..f620072da62b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanmrss/test/test.js @@ -0,0 +1,135 @@ +/** +* @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 tape = require( 'tape' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var incrnanmrss = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanmrss, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function throws an error if not provided a positive integer', function test( t ) { + var values; + var i; + + values = [ + '5', + -5.0, + 0.0, + 3.14, + true, + null, + void 0, + NaN, + [], + {}, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + incrnanmrss( value ); + }; + } +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.equal( typeof incrnanmrss( 3 ), 'function', 'returns a function' ); + t.end(); +}); + +tape( 'the accumulator function computes a moving residual sum of squares incrementally', function test( t ) { + var expected; + var actual; + var delta; + var data; + var acc; + var tol; + var N; + var i; + + data = [ + [ 2.0, 3.0 ], + [ NaN, 3.0 ], + [ 2.0, NaN ], + [ 3.0, -1.0 ], + [ 2.0, 5.0 ], + [ 4.0, -4.0 ], + [ NaN, NaN ], + [ 3.0, 0.0 ], + [ -4.0, 5.0 ] + ]; + N = data.length; + + acc = incrnanmrss( 3 ); + + expected = [ 1.0, 1.0, 1.0, 17.0, 26.0, 89.0, 89.0, 82.0, 154.0 ]; + for ( i = 0; i < N; i++ ) { + actual = acc( data[i][0], data[i][1] ); + if ( actual === expected[i] ) { + t.equal( actual, expected[i], 'returns expected value' ); + } else { + delta = abs( expected[i] - actual ); + tol = 1.0 * EPS * abs( expected[i] ); + t.equal( delta <= tol, true, 'within tolerance. Actual: '+actual+'. Expected: '+expected[i]+'. Delta: '+delta+'. Tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'if not provided an input value, the accumulator function returns the current residual sum of squares', function test( t ) { + var data; + var acc; + var i; + + data = [ + [ 2.0, 3.0 ], + [ NaN, 5.0 ], + [ 3.0, -5.0 ], + [ 1.0, NaN ], + [ 1.0, 10.0 ] + ]; + acc = incrnanmrss( 2 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[i][0], data[i][1] ); + } + t.equal( acc(), 145.0, 'returns expected value' ); + t.end(); +}); + +tape( 'if data has yet to be provided, the accumulator function returns `null`', function test( t ) { + var acc = incrnanmrss( 3 ); + t.equal( acc(), null, 'returns null' ); + t.end(); +});