Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 1, 2023
1 parent 059563e commit fce78d9
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 237 deletions.
1 change: 1 addition & 0 deletions .github/.keepalive
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2023-11-01T02:40:58.404Z
12 changes: 10 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,11 @@ jobs:
fi
# Trim leading and trailing whitespace:
dep=$(echo "$dep" | xargs)
version="^$(npm view $dep version)"
version="$(npm view $dep version)"
if [[ -z "$version" ]]; then
continue
fi
version="^$version"
jq -r --arg dep "$dep" --arg version "$version" '.dependencies[$dep] = $version' package.json > package.json.tmp
mv package.json.tmp package.json
done
Expand All @@ -192,7 +196,11 @@ jobs:
fi
# Trim leading and trailing whitespace:
dep=$(echo "$dep" | xargs)
version="^$(npm view $dep version)"
version="$(npm view $dep version)"
if [[ -z "$version" ]]; then
continue
fi
version="^$version"
jq -r --arg dep "$dep" --arg version "$version" '.devDependencies[$dep] = $version' package.json > package.json.tmp
mv package.json.tmp package.json
done
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ Stephannie Jiménez Gacha <steff456@hotmail.com>
Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
orimiles5 <97595296+orimiles5@users.noreply.github.com>
rei2hu <reimu@reimu.ws>
Robert Gislason <gztown2216@yahoo.com>
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
},
"dependencies": {
"@stdlib/assert-is-positive-integer": "^0.1.0",
"@stdlib/math-base-special-sqrt": "^0.1.0",
"@stdlib/math-base-special-sqrt": "^0.1.1",
"@stdlib/stats-incr-mmean": "^0.1.0",
"@stdlib/string-format": "^0.1.1",
"@stdlib/types": "^0.1.0"
Expand All @@ -47,7 +47,7 @@
"@stdlib/bench": "^0.1.0",
"@stdlib/constants-float64-eps": "^0.1.1",
"@stdlib/math-base-assert-is-nan": "^0.1.1",
"@stdlib/math-base-special-abs": "^0.1.0",
"@stdlib/math-base-special-abs": "^0.1.1",
"@stdlib/random-base-randu": "^0.1.0",
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
"istanbul": "^0.4.1",
Expand Down
237 changes: 4 additions & 233 deletions test/dist/test.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
* Copyright (c) 2023 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.
Expand All @@ -21,242 +21,13 @@
// MODULES //

var tape = require( 'tape' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var abs = require( '@stdlib/math-base-special-abs' );
var sqrt = require( '@stdlib/math-base-special-sqrt' );
var EPS = require( '@stdlib/constants-float64-eps' );
var incrmrmse = require( './../../dist' );
var main = require( './../../dist' );


// TESTS //

tape( 'main export is a function', function test( t ) {
tape( 'main export is defined', function test( t ) {
t.ok( true, __filename );
t.strictEqual( typeof incrmrmse, '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() {
incrmrmse( value );
};
}
});

tape( 'the function returns an accumulator function', function test( t ) {
t.equal( typeof incrmrmse( 3 ), 'function', 'returns a function' );
t.end();
});

tape( 'the accumulator function computes a moving root mean squared error 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 ],
[ 3.0, -1.0 ],
[ 2.0, 5.0 ],
[ 4.0, -4.0 ],
[ 3.0, 0.0 ],
[ -4.0, 5.0 ]
];
N = data.length;

acc = incrmrmse( 3 );

expected = [
1.0,
sqrt( 17.0/2.0 ),
sqrt( 26.0/3.0 ),
sqrt( 89.0/3.0 ),
sqrt( 82.0/3.0 ),
sqrt( 154.0/3.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 root mean squared error', function test( t ) {
var data;
var acc;
var i;

data = [
[ 2.0, 3.0 ],
[ 3.0, -5.0 ],
[ 1.0, 10.0 ]
];
acc = incrmrmse( 2 );
for ( i = 0; i < data.length; i++ ) {
acc( data[i][0], data[i][1] );
}
t.equal( acc(), sqrt( 145.0/2.0 ), 'returns expected value' );
t.end();
});

tape( 'if data has yet to be provided, the accumulator function returns `null`', function test( t ) {
var acc = incrmrmse( 3 );
t.equal( acc(), null, 'returns null' );
t.end();
});

tape( 'if provided `NaN`, the accumulated value is `NaN` for at least `W` invocations', function test( t ) {
var expected;
var data;
var acc;
var v;
var i;

expected = [
NaN,
NaN,
NaN,
NaN,
NaN,
NaN,
0.0,
NaN,
NaN,
NaN,
0.0,
NaN,
NaN,
NaN,
NaN,
NaN,
NaN,
NaN,
NaN
];

data = [
[ NaN, 3.14 ], // NaN
[ 3.14, 3.14 ], // NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ NaN, 3.14 ], // 3.14, 3.14, NaN
[ 3.14, 3.14 ], // 3.14, NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ 3.14, 3.14 ], // 3.14, 3.14, 3.14
[ NaN, 3.14 ], // 3.14, 3.14, NaN
[ 3.14, 3.14 ], // 3.14, NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ 3.14, 3.14 ], // 3.14, 3.14, 3.14
[ NaN, 3.14 ], // 3.14, 3.14, NaN
[ 3.14, 3.14 ], // 3.14, NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ NaN, 3.14 ], // 3.14, 3.14, NaN
[ NaN, 3.14 ], // 3.14, NaN, NaN
[ NaN, 3.14 ], // NaN, NaN, NaN
[ NaN, 3.14 ], // NaN, NaN, NaN
[ 3.14, 3.14 ] // NaN, NaN, 3.14
];

acc = incrmrmse( 3 );

for ( i = 0; i < data.length; i++ ) {
v = acc( data[i][0], data[i][1] );
if ( isnan( expected[ i ] ) ) {
t.equal( isnan( v ), true, 'returns expected value for window '+i );
t.equal( isnan( acc() ), true, 'returns expected value for window '+i );
} else {
t.equal( v, expected[ i ], 'returns expected value for window '+i );
t.equal( acc(), expected[ i ], 'returns expected value for window '+i );
}
}

expected = [
NaN,
NaN,
NaN,
NaN,
NaN,
NaN,
0.0,
NaN,
NaN,
NaN,
0.0,
NaN,
NaN,
NaN,
NaN,
NaN,
NaN,
NaN,
NaN
];

data = [
[ 3.14, NaN ], // NaN
[ 3.14, 3.14 ], // NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ 3.14, NaN ], // 3.14, 3.14, NaN
[ 3.14, 3.14 ], // 3.14, NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ 3.14, 3.14 ], // 3.14, 3.14, 3.14
[ 3.14, NaN ], // 3.14, 3.14, NaN
[ 3.14, 3.14 ], // 3.14, NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ 3.14, 3.14 ], // 3.14, 3.14, 3.14
[ 3.14, NaN ], // 3.14, 3.14, NaN
[ 3.14, 3.14 ], // 3.14, NaN, 3.14
[ 3.14, 3.14 ], // NaN, 3.14, 3.14
[ 3.14, NaN ], // 3.14, 3.14, NaN
[ 3.14, NaN ], // 3.14, NaN, NaN
[ 3.14, NaN ], // NaN, NaN, NaN
[ 3.14, NaN ], // NaN, NaN, NaN
[ 3.14, 3.14 ] // NaN, NaN, 3.14
];

acc = incrmrmse( 3 );

for ( i = 0; i < data.length; i++ ) {
v = acc( data[i][0], data[i][1] );
if ( isnan( expected[ i ] ) ) {
t.equal( isnan( v ), true, 'returns expected value for window '+i );
t.equal( isnan( acc() ), true, 'returns expected value for window '+i );
} else {
t.equal( v, expected[ i ], 'returns expected value for window '+i );
t.equal( acc(), expected[ i ], 'returns expected value for window '+i );
}
}
t.strictEqual( main !== void 0, true, 'main export is defined' );
t.end();
});

0 comments on commit fce78d9

Please sign in to comment.