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 658b3e3 commit f857d65
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 176 deletions.
1 change: 1 addition & 0 deletions .github/.keepalive
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2023-11-01T03:03:48.728Z
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 <[email protected]>
Yernar Yergaziyev <[email protected]>
orimiles5 <[email protected]>
rei2hu <[email protected]>
Robert Gislason <[email protected]>
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
"dependencies": {
"@stdlib/assert-is-array-like-object": "^0.1.0",
"@stdlib/math-base-assert-is-nan": "^0.1.1",
"@stdlib/math-base-special-sqrt": "^0.1.0",
"@stdlib/math-base-special-sqrt": "^0.1.1",
"@stdlib/string-format": "^0.1.1",
"@stdlib/types": "^0.1.0"
},
"devDependencies": {
"@stdlib/array-buffer": "^0.1.0",
"@stdlib/array-float64": "^0.1.0",
"@stdlib/array-float64": "^0.1.1",
"@stdlib/bench": "^0.1.0",
"@stdlib/random-base-randu": "^0.1.0",
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
Expand Down
176 changes: 4 additions & 172 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,181 +21,13 @@
// MODULES //

var tape = require( 'tape' );
var isnan = require( '@stdlib/math-base-assert-is-nan' );
var sqrt = require( '@stdlib/math-base-special-sqrt' );
var incrmeanstdev = 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 incrmeanstdev, 'function', 'main export is a function' );
t.end();
});

tape( 'the function throws an error if not provided an array-like object for an output argument', function test( t ) {
var values;
var i;

values = [
'5',
-5.0,
true,
false,
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() {
incrmeanstdev( value );
};
}
});

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

tape( 'the function returns an accumulator function (output)', function test( t ) {
t.equal( typeof incrmeanstdev( [ 0.0, 0.0 ] ), 'function', 'returns a function' );
t.end();
});

tape( 'the accumulator function incrementally computes an arithmetic mean and corrected sample standard deviation', function test( t ) {
var expected;
var actual;
var data;
var acc;
var N;
var i;

data = [ 2.0, 3.0, 2.0, 4.0, 3.0, 4.0 ];
N = data.length;

// Test against Julia:
expected = [
[ 2.0, 0.0 ],
[ 2.5, sqrt( 0.5 ) ],
[ 7.0/3.0, sqrt( 0.33333333333333337 ) ],
[ 11.0/4.0, sqrt( 0.9166666666666666 ) ],
[ 14.0/5.0, sqrt( 0.7 ) ],
[ 18.0/6.0, sqrt( 0.8 ) ]
];

acc = incrmeanstdev();

for ( i = 0; i < N; i++ ) {
actual = acc( data[ i ] );
t.deepEqual( actual, expected[ i ], 'returns expected value' );
}
t.end();
});

tape( 'the accumulator function incrementally computes an arithmetic mean and corrected sample standard deviation (output)', function test( t ) {
var expected;
var actual;
var data;
var acc;
var out;
var N;
var i;

data = [ 2.0, 3.0, 2.0, 4.0, 3.0, 4.0 ];
N = data.length;

// Test against Julia:
expected = [
[ 2.0, 0.0 ],
[ 2.5, sqrt( 0.5 ) ],
[ 7.0/3.0, sqrt( 0.33333333333333337 ) ],
[ 11.0/4.0, sqrt( 0.9166666666666666 ) ],
[ 14.0/5.0, sqrt( 0.7 ) ],
[ 18.0/6.0, sqrt( 0.8 ) ]
];
out = [ 0.0, 0.0 ];
acc = incrmeanstdev( out );

for ( i = 0; i < N; i++ ) {
actual = acc( data[ i ] );
t.equal( actual, out, 'returns output array' );
t.deepEqual( actual, expected[ i ], 'returns expected value' );
}
t.end();
});

tape( 'if not provided an input value, the accumulator function returns the current mean and corrected sample standard deviation', function test( t ) {
var data;
var acc;
var i;

data = [ 2.0, 3.0, 1.0 ];
acc = incrmeanstdev();
for ( i = 0; i < data.length; i++ ) {
acc( data[ i ] );
}
t.deepEqual( acc(), [ 2.0, 1.0 ], 'returns expected value' );
t.end();
});

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

tape( 'the sample standard deviation is `0` until at least 2 datums have been provided', function test( t ) {
var acc;
var ms;

acc = incrmeanstdev();

ms = acc();
t.equal( ms, null, 'returns null' );

ms = acc( 3.0 );
t.equal( ms[ 1 ], 0.0, 'returns expected value' );

ms = acc();
t.equal( ms[ 1 ], 0.0, 'returns expected value' );

ms = acc( 5.0 );
t.notEqual( ms[ 1 ], 0.0, 'does not return 0' );

ms = acc();
t.notEqual( ms[ 1 ], 0.0, 'does not return 0' );

t.end();
});

tape( 'if provided `NaN`, the accumulated values are `NaN` for all future invocations', function test( t ) {
var data;
var acc;
var v;
var i;

data = [ NaN, 2.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ];
acc = incrmeanstdev();
for ( i = 0; i < data.length; i++ ) {
v = acc( data[ i ] );
t.equal( isnan( v[ 0 ] ), true, 'returns expected value' );
t.equal( isnan( v[ 1 ] ), true, 'returns expected value' );

v = acc();
t.equal( isnan( v[ 0 ] ), true, 'returns expected value' );
t.equal( isnan( v[ 1 ] ), true, 'returns expected value' );
}
t.strictEqual( main !== void 0, true, 'main export is defined' );
t.end();
});

0 comments on commit f857d65

Please sign in to comment.