diff --git a/docs/migration-guides/jstat/benchmark/benchmark.max.js b/docs/migration-guides/jstat/benchmark/benchmark.max.js index 93740f3da5ac..7a68437ba404 100644 --- a/docs/migration-guides/jstat/benchmark/benchmark.max.js +++ b/docs/migration-guides/jstat/benchmark/benchmark.max.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var format = require( '@stdlib/string/format' ); var randu = require( '@stdlib/random/base/randu' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -98,7 +99,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+'::jstat:max:len='+len, opts, f ); + bench( format( '%s::jstat:max:len=%d', pkg, len ), opts, f ); } } diff --git a/docs/migration-guides/jstat/benchmark/benchmark.min.js b/docs/migration-guides/jstat/benchmark/benchmark.min.js index 905a725f0dae..b9f7d167ba50 100644 --- a/docs/migration-guides/jstat/benchmark/benchmark.min.js +++ b/docs/migration-guides/jstat/benchmark/benchmark.min.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var randu = require( '@stdlib/random/base/randu' ); var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -98,7 +99,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+'::jstat:min:len='+len, opts, f ); + bench( format( '%s::jstat:min:len=%d', pkg, len ), opts, f ); } } diff --git a/docs/migration-guides/jstat/benchmark/benchmark.range.js b/docs/migration-guides/jstat/benchmark/benchmark.range.js index 2df201800b78..21525a9b81bc 100644 --- a/docs/migration-guides/jstat/benchmark/benchmark.range.js +++ b/docs/migration-guides/jstat/benchmark/benchmark.range.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var randu = require( '@stdlib/random/base/randu' ); +var format = require( '@stdlib/string/format' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -98,7 +99,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+'::jstat:range:len='+len, opts, f ); + bench( format( '%s::jstat:range:len=%d', pkg, len ), opts, f ); } } diff --git a/docs/migration-guides/jstat/benchmark/benchmark.sum.js b/docs/migration-guides/jstat/benchmark/benchmark.sum.js index f3f39486c5d9..11935ce6ceec 100644 --- a/docs/migration-guides/jstat/benchmark/benchmark.sum.js +++ b/docs/migration-guides/jstat/benchmark/benchmark.sum.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var randu = require( '@stdlib/random/base/randu' ); var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); var Float64Array = require( '@stdlib/array/float64' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -98,7 +99,7 @@ function main() { for ( i = min; i <= max; i++ ) { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+'::jstat:sum:len='+len, opts, f ); + bench( format( '%s::jstat:sum:len=%d', pkg, len ), opts, f ); } } diff --git a/docs/migration-guides/lodash/benchmark/benchmark.count_by.js b/docs/migration-guides/lodash/benchmark/benchmark.count_by.js index a925d452238a..bf7d28be4467 100644 --- a/docs/migration-guides/lodash/benchmark/benchmark.count_by.js +++ b/docs/migration-guides/lodash/benchmark/benchmark.count_by.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var format = require( '@stdlib/string/format' ); var tryRequire = require( '@stdlib/utils/try-require' ); var countBy = require( '@stdlib/utils/count-by' ); var pkg = require( './../package.json' ).name; @@ -38,7 +39,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:utils/count-by', opts, function benchmark( b ) { +bench( format( '%s::stdlib:utils/count-by', pkg ), opts, function benchmark( b ) { var vals; var arr; var o; @@ -72,7 +73,7 @@ bench( pkg+'::stdlib:utils/count-by', opts, function benchmark( b ) { } }); -bench( pkg+'::lodash:countBy', opts, function benchmark( b ) { +bench( format( '%s::lodash:countBy', pkg ), opts, function benchmark( b ) { var vals; var arr; var o; diff --git a/docs/migration-guides/lodash/benchmark/benchmark.every.js b/docs/migration-guides/lodash/benchmark/benchmark.every.js index 3dbb5667cb56..5994dec818f0 100644 --- a/docs/migration-guides/lodash/benchmark/benchmark.every.js +++ b/docs/migration-guides/lodash/benchmark/benchmark.every.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var format = require( '@stdlib/string/format' ); var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; var tryRequire = require( '@stdlib/utils/try-require' ); var every = require( '@stdlib/utils/every' ); @@ -39,7 +40,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:utils/every', opts, function benchmark( b ) { +bench( format( '%s::stdlib:utils/every', pkg ), opts, function benchmark( b ) { var bool; var arr; var i; @@ -66,7 +67,7 @@ bench( pkg+'::stdlib:utils/every', opts, function benchmark( b ) { } }); -bench( pkg+'::lodash:every', opts, function benchmark( b ) { +bench( format( '%s::lodash:every', pkg ), opts, function benchmark( b ) { var bool; var arr; var i; diff --git a/docs/migration-guides/lodash/benchmark/benchmark.for_each.js b/docs/migration-guides/lodash/benchmark/benchmark.for_each.js index ed347a47b97f..550b45062ce2 100644 --- a/docs/migration-guides/lodash/benchmark/benchmark.for_each.js +++ b/docs/migration-guides/lodash/benchmark/benchmark.for_each.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var format = require( '@stdlib/string/format' ); var tryRequire = require( '@stdlib/utils/try-require' ); var forEach = require( '@stdlib/utils/for-each' ); var pkg = require( './../package.json' ).name; @@ -38,7 +39,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:utils/for-each', opts, function benchmark( b ) { +bench( format( '%s::stdlib:utils/for-each', pkg ), opts, function benchmark( b ) { var arr; var i; @@ -66,7 +67,7 @@ bench( pkg+'::stdlib:utils/for-each', opts, function benchmark( b ) { } }); -bench( pkg+'::lodash:forEach', opts, function benchmark( b ) { +bench( format( '%s::lodash:forEach', pkg ), opts, function benchmark( b ) { var arr; var i; diff --git a/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js b/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js index d5956f77743c..673bdd65a251 100644 --- a/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js +++ b/docs/migration-guides/lodash/benchmark/benchmark.for_each_right.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var format = require( '@stdlib/string/format' ); var tryRequire = require( '@stdlib/utils/try-require' ); var forEachRight = require( '@stdlib/utils/for-each-right' ); var pkg = require( './../package.json' ).name; @@ -38,7 +39,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:utils/for-each-right', opts, function benchmark( b ) { +bench( format( '%s::stdlib:utils/for-each-right', pkg ), opts, function benchmark( b ) { var arr; var i; @@ -66,7 +67,7 @@ bench( pkg+'::stdlib:utils/for-each-right', opts, function benchmark( b ) { } }); -bench( pkg+'::lodash:forEachRight', opts, function benchmark( b ) { +bench( format( '%s::lodash:forEachRight', pkg ), opts, function benchmark( b ) { var arr; var i; diff --git a/docs/migration-guides/lodash/benchmark/benchmark.group_by.js b/docs/migration-guides/lodash/benchmark/benchmark.group_by.js index 8ac5ba54aaaf..2a6c47f85e21 100644 --- a/docs/migration-guides/lodash/benchmark/benchmark.group_by.js +++ b/docs/migration-guides/lodash/benchmark/benchmark.group_by.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var format = require( '@stdlib/string/format' ); var tryRequire = require( '@stdlib/utils/try-require' ); var groupBy = require( '@stdlib/utils/group-by' ); var pkg = require( './../package.json' ).name; @@ -38,7 +39,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:utils/group-by', opts, function benchmark( b ) { +bench( format( '%s::stdlib:utils/group-by', pkg ), opts, function benchmark( b ) { var vals; var arr; var o; @@ -72,7 +73,7 @@ bench( pkg+'::stdlib:utils/group-by', opts, function benchmark( b ) { } }); -bench( pkg+'::lodash:groupBy', opts, function benchmark( b ) { +bench( format( '%s::lodash:groupBy', pkg ), opts, function benchmark( b ) { var vals; var arr; var o; diff --git a/docs/migration-guides/lodash/benchmark/benchmark.key_by.js b/docs/migration-guides/lodash/benchmark/benchmark.key_by.js index 1c1b84970e1a..cd37398ca5ad 100644 --- a/docs/migration-guides/lodash/benchmark/benchmark.key_by.js +++ b/docs/migration-guides/lodash/benchmark/benchmark.key_by.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var tryRequire = require( '@stdlib/utils/try-require' ); +var format = require( '@stdlib/string/format' ); var keyBy = require( '@stdlib/utils/key-by' ); var pkg = require( './../package.json' ).name; @@ -37,7 +38,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:utils/key-by', opts, function benchmark( b ) { +bench( format( '%s::stdlib:utils/key-by', pkg ), opts, function benchmark( b ) { var arr; var out; var i; @@ -69,7 +70,7 @@ bench( pkg+'::stdlib:utils/key-by', opts, function benchmark( b ) { } }); -bench( pkg+'::lodash:keyBy', opts, function benchmark( b ) { +bench( format( '%s::lodash:keyBy', pkg ), opts, function benchmark( b ) { var arr; var out; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js index 51757b3c70af..f7c526ad8c38 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.float64.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var zeros = require( '@stdlib/array/zeros' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var strided = require( '@stdlib/math/strided/special/abs' ); var dabs = require( '@stdlib/math/strided/special/dabs' ); @@ -43,7 +44,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/strided/special/abs:value=array,dtype=float64,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/special/abs:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -66,7 +67,7 @@ bench( pkg+'::stdlib:math/strided/special/abs:value=array,dtype=float64,len=100' b.end(); }); -bench( pkg+'::stdlib:math/strided/special/dabs:value=array,dtype=float64,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/special/dabs:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -89,7 +90,7 @@ bench( pkg+'::stdlib:math/strided/special/dabs:value=array,dtype=float64,len=100 b.end(); }); -bench( pkg+'::stdlib:math/special/abs:value=array,dtype=float64,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/special/abs:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -115,7 +116,7 @@ bench( pkg+'::stdlib:math/special/abs:value=array,dtype=float64,len=100', opts, opts = { 'skip': true }; -bench( pkg+'::mathjs:abs:value=array,dtype=float64,len=100', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js index 0805ac7043cc..bf7cd50bf78f 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.array.generic.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var zeros = require( '@stdlib/array/zeros' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var strided = require( '@stdlib/math/strided/special/abs' ); var abs = require( '@stdlib/math/special/abs' ); @@ -42,7 +43,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/strided/special/abs:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/special/abs:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -65,7 +66,7 @@ bench( pkg+'::stdlib:math/strided/special/abs:value=array,dtype=generic,len=100' b.end(); }); -bench( pkg+'::stdlib:math/special/abs:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/special/abs:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -87,7 +88,7 @@ bench( pkg+'::stdlib:math/special/abs:value=array,dtype=generic,len=100', opts, b.end(); }); -bench( pkg+'::mathjs:abs:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js index 4d7a2eac7c83..91d3a067b5fe 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.complex_number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/math/base/special/cabs' ); var abs = require( '@stdlib/math/special/abs' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/cabs:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/cabs:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:math/base/special/cabs:value=complex_number', opts, functio b.end(); }); -bench( pkg+'::stdlib:math/special/abs:value=complex_number', { +bench( format( '%s::stdlib:math/special/abs:value=complex_number', pkg ), { 'skip': true }, function benchmark( b ) { // FIXME: update once complex supported in top-level abs var x; @@ -98,7 +99,7 @@ bench( pkg+'::stdlib:math/special/abs:value=complex_number', { b.end(); }); -bench( pkg+'::mathjs:abs:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js index 3b435236fdae..a1f00c41902d 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.2d.js @@ -23,6 +23,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var format = require( '@stdlib/string/format' ); var filled2dBy = require( '@stdlib/array/base/filled2d-by' ); var filledndBy = require( '@stdlib/array/base/fillednd-by' ); var unary2d = require( '@stdlib/array/base/unary2d' ); @@ -47,7 +48,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(10,10)', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -71,7 +72,7 @@ bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape b.end(); }); -bench( pkg+'::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=100,shape=(10,10)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -96,7 +97,7 @@ bench( pkg+'::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(10,10)' ), pkg, opts, function benchmark( b ) { var sh; var x; var y; @@ -121,7 +122,7 @@ bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(10,10)', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(10,10)', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js index 6d80dd4f1d2d..da13ad88604e 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.3d.js @@ -30,6 +30,7 @@ var unarynd = require( '@stdlib/array/base/unarynd' ); var zeros3d = require( '@stdlib/array/base/zeros3d' ); var zerosnd = require( '@stdlib/array/base/zerosnd' ); var array = require( '@stdlib/ndarray/array' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/abs' ); var abs = require( '@stdlib/math/special/abs' ); @@ -47,7 +48,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(4,5,5)', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -71,7 +72,7 @@ bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape b.end(); }); -bench( pkg+'::stdlib:array/base/unary3d:value=nested_array,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unary3d:value=nested_array,dtype=generic,size=100,shape=(4,5,5)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -96,7 +97,7 @@ bench( pkg+'::stdlib:array/base/unary3d:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(4,5,5)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -121,7 +122,7 @@ bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(4,5,5)', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(4,5,5)', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js index 8460a56c98ad..c29a2ceba59b 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.matrix.4d.js @@ -29,6 +29,7 @@ var unary4d = require( '@stdlib/array/base/unary4d' ); var unarynd = require( '@stdlib/array/base/unarynd' ); var zeros4d = require( '@stdlib/array/base/zeros4d' ); var zerosnd = require( '@stdlib/array/base/zerosnd' ); +var format = require( '@stdlib/string/format' ); var array = require( '@stdlib/ndarray/array' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/abs' ); @@ -47,7 +48,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape=(2,5,2,5)', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -71,7 +72,7 @@ bench( pkg+'::stdlib:math/special/abs:value=ndarray,dtype=generic,size=100,shape b.end(); }); -bench( pkg+'::stdlib:array/base/unary4d:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unary4d:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -96,7 +97,7 @@ bench( pkg+'::stdlib:array/base/unary4d:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=100,shape=(2,5,2,5)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -121,7 +122,7 @@ bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(2,5,2,5)', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=matrix,dtype=generic,size=100,shape=(2,5,2,5)', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js index f30a883e1ab7..d74851019390 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.abs.number.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/math/base/special/abs' ); var abs = require( '@stdlib/math/special/abs' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -41,7 +42,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/abs:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/abs:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -63,7 +64,7 @@ bench( pkg+'::stdlib:math/base/special/abs:value=number', opts, function benchma b.end(); }); -bench( pkg+'::stdlib:math/special/abs:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/special/abs:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -85,7 +86,7 @@ bench( pkg+'::stdlib:math/special/abs:value=number', opts, function benchmark( b b.end(); }); -bench( pkg+'::mathjs:abs:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:abs:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js index 95da14d7732e..3a39e2d69bf0 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.add.array.generic.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var zeros = require( '@stdlib/array/zeros' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var strided = require( '@stdlib/math/strided/ops/add' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -41,7 +42,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/strided/ops/add:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/ops/add:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var z; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:math/strided/ops/add:value=array,dtype=generic,len=100', op // TODO: add math/ops/add benchmarks -bench( pkg+'::mathjs:add:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::mathjs:add:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var z; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js index ac01d30e53c0..5c64ee6708f1 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.add.complex_number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var format = require( '@stdlib/string/format' ); var real = require( '@stdlib/complex/float64/real' ); var imag = require( '@stdlib/complex/float64/imag' ); var base = require( '@stdlib/complex/float64/base/add' ); @@ -41,7 +42,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/cadd:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/cadd:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -73,7 +74,7 @@ bench( pkg+'::stdlib:math/base/special/cadd:value=complex_number', opts, functio // TODO: add math/special/add benchmarks -bench( pkg+'::mathjs:add:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:add:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js index 2ec388ea8d51..be9c1d1b6e9d 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.add.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/number/float64/base/add' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:number/float64/base/add:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:number/float64/base/add:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:number/float64/base/add:value=number', opts, function bench // TODO: add math/ops/add benchmarks -bench( pkg+'::mathjs:add:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:add:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js index 3571a60bb591..29c08cd63a4d 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.cbrt.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/cbrt' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/cbrt:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/cbrt:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/cbrt:value=number', opts, function benchm // TODO: add math/special/cbrt benchmarks -bench( pkg+'::mathjs:cbrt:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:cbrt:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js index 2b3000ece1ee..b606e6d8f99e 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.ceil.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/ceil' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/ceil:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/ceil:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/ceil:value=number', opts, function benchm // TODO: add math/special/ceil benchmarks -bench( pkg+'::mathjs:ceil:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:ceil:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js index 8dbff9537091..b13bbba7de7a 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.erf.number.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/math/base/special/erf' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/erf:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/erf:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/erf:value=number', opts, function benchma // TODO: add math/special/erf benchmarks -bench( pkg+'::mathjs:erf:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:erf:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js index f4f4f5f01228..81efb79bcefc 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.exp.number.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/math/base/special/exp' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/exp:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/exp:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/exp:value=number', opts, function benchma // TODO: add math/special/exp benchmarks -bench( pkg+'::mathjs:exp:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:exp:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js index 3d238651cecd..bf74095f5c12 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.expm1.number.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/math/base/special/expm1' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/expm1:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/expm1:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/expm1:value=number', opts, function bench // TODO: add math/special/expm1 benchmarks -bench( pkg+'::mathjs:expm1:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:expm1:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js index d5bddf3e5c4a..861c89412d38 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.floor.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/floor' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/floor:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/floor:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/floor:value=number', opts, function bench // TODO: add math/special/floor benchmarks -bench( pkg+'::mathjs:floor:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:floor:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js index 00b31fd13a41..965e0aa3545d 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.hypot.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/hypot' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/hypot:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/hypot:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:math/base/special/hypot:value=number', opts, function bench // TODO: add math/special/hypot benchmarks -bench( pkg+'::mathjs:hypot:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:hypot:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js index a2376dd8aad8..6c5040e95546 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.log10.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/log10' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/log10:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/log10:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/log10:value=number', opts, function bench // TODO: add math/special/log10 benchmarks -bench( pkg+'::mathjs:log10:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:log10:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js index 022ff35534b4..73315bb4d4fd 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.log1p.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/log1p' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/log1p:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/log1p:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/log1p:value=number', opts, function bench // TODO: add math/special/log1p benchmarks -bench( pkg+'::mathjs:log1p:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:log1p:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js index 1903f8213ac2..40c882830ae9 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.log2.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/log2' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/log2:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/log2:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/log2:value=number', opts, function benchm // TODO: add math/special/log2 benchmarks -bench( pkg+'::mathjs:log2:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:log2:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.matrix.creation.js b/docs/migration-guides/mathjs/benchmark/benchmark.matrix.creation.js index ad9b54e6cfa5..0dc04fe21231 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.matrix.creation.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.matrix.creation.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var ndarray = require( '@stdlib/ndarray/ctor' ); var array = require( '@stdlib/ndarray/array' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -39,7 +40,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:ndarray/ctor:dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:ndarray/ctor:dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var buf; var x; var i; @@ -63,7 +64,7 @@ bench( pkg+'::stdlib:ndarray/ctor:dtype=generic,size=10000,shape=(100,100)', opt b.end(); }); -bench( pkg+'::stdlib:ndarray/array:dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:ndarray/array:dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var buf; var x; var i; @@ -91,7 +92,7 @@ bench( pkg+'::stdlib:ndarray/array:dtype=generic,size=10000,shape=(100,100)', op b.end(); }); -bench( pkg+'::mathjs:matrix:dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::mathjs:matrix:dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var buf; var x; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js index e58064c0a39b..cf55c0102889 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.array.generic.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var zeros = require( '@stdlib/array/zeros' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var strided = require( '@stdlib/math/strided/ops/mul' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -41,7 +42,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/strided/ops/mul:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/ops/mul:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var z; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:math/strided/ops/mul:value=array,dtype=generic,len=100', op // TODO: add math/ops/mul benchmarks -bench( pkg+'::mathjs:dotMultiply:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::mathjs:dotMultiply:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var z; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js index a5695f6640a1..66bf01d5a263 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.complex_number.js @@ -26,6 +26,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); var real = require( '@stdlib/complex/float64/real' ); var imag = require( '@stdlib/complex/float64/imag' ); +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/complex/float64/base/mul' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -41,7 +42,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/cmul:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/cmul:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -73,7 +74,7 @@ bench( pkg+'::stdlib:math/base/special/cmul:value=complex_number', opts, functio // TODO: add math/special/mul benchmarks -bench( pkg+'::mathjs:multiply:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:multiply:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js index dcd4cedb3944..63cdaf995559 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.multiply.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/number/float64/base/mul' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:number/float64/base/mul:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:number/float64/base/mul:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:number/float64/base/mul:value=number', opts, function bench // TODO: add math/ops/mul benchmarks -bench( pkg+'::mathjs:multiply:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:multiply:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.matrix.2d.js b/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.matrix.2d.js index 25970517bdf2..09d2b02967da 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.matrix.2d.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.matrix.2d.js @@ -32,6 +32,7 @@ var zerosnd = require( '@stdlib/array/base/zerosnd' ); var ndmap = require( '@stdlib/ndarray/map' ); var ndzeros = require( '@stdlib/ndarray/zeros' ); var ndunary = require( '@stdlib/ndarray/base/unary' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var randu = require( '@stdlib/random/uniform' ); var base = require( '@stdlib/math/base/special/sqrt' ); @@ -49,7 +50,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -74,7 +75,7 @@ bench( pkg+'::stdlib:array/base/unary2d:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -99,7 +100,7 @@ bench( pkg+'::stdlib:array/base/unarynd:value=nested_array,dtype=generic,size=10 b.end(); }); -bench( pkg+'::stdlib:ndarray/base/unary:value=ndarray,dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:ndarray/base/unary:value=ndarray,dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var opts; var sh; var x; @@ -128,7 +129,7 @@ bench( pkg+'::stdlib:ndarray/base/unary:value=ndarray,dtype=generic,size=10000,s b.end(); }); -bench( pkg+'::stdlib:ndarray/map:value=ndarray,dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::stdlib:ndarray/map:value=ndarray,dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var sh; var x; var y; @@ -154,7 +155,7 @@ bench( pkg+'::stdlib:ndarray/map:value=ndarray,dtype=generic,size=10000,shape=(1 b.end(); }); -bench( pkg+'::mathjs:sqrt:value=matrix,dtype=generic,size=10000,shape=(100,100)', opts, function benchmark( b ) { +bench( format( '%s::mathjs:sqrt:value=matrix,dtype=generic,size=10000,shape=(100,100)', pkg ), opts, function benchmark( b ) { var buf; var x; var y; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js index a3d8b7f22830..73166309a117 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.sqrt.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/sqrt' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/sqrt:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/sqrt:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/sqrt:value=number', opts, function benchm // TODO: add math/special/sqrt benchmarks -bench( pkg+'::mathjs:sqrt:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:sqrt:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js index 9a3ce9f8a90a..bb2d72b848d2 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.float64.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var zeros = require( '@stdlib/array/zeros' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var strided = require( '@stdlib/math/strided/special/abs2' ); var dabs2 = require( '@stdlib/math/strided/special/dabs2' ); @@ -42,7 +43,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/strided/special/abs2:value=array,dtype=float64,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/special/abs2:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -65,7 +66,7 @@ bench( pkg+'::stdlib:math/strided/special/abs2:value=array,dtype=float64,len=100 b.end(); }); -bench( pkg+'::stdlib:math/strided/special/dabs2:value=array,dtype=float64,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/special/dabs2:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -94,7 +95,8 @@ bench( pkg+'::stdlib:math/strided/special/dabs2:value=array,dtype=float64,len=10 opts = { 'skip': true }; -bench( pkg+'::mathjs:square:value=array,dtype=float64,len=100', opts, function benchmark( b ) { + +bench( format( '%s::mathjs:square:value=array,dtype=float64,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js index 548c21e2ed23..534f19b9c3d0 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.array.generic.js @@ -25,6 +25,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); var zeros = require( '@stdlib/array/zeros' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var strided = require( '@stdlib/math/strided/special/abs2' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -41,7 +42,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/strided/special/abs2:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/strided/special/abs2:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -70,7 +71,7 @@ bench( pkg+'::stdlib:math/strided/special/abs2:value=array,dtype=generic,len=100 opts = { 'skip': true }; -bench( pkg+'::mathjs:square:value=array,dtype=generic,len=100', opts, function benchmark( b ) { +bench( format( '%s::mathjs:square:value=array,dtype=generic,len=100', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js index fc1ba64084bf..38e912c0e3ec 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.complex_number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var format = require( '@stdlib/string/format' ); var base = require( '@stdlib/math/base/special/cabs2' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -39,7 +40,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/cabs2:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/cabs2:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -69,7 +70,7 @@ bench( pkg+'::stdlib:math/base/special/cabs2:value=complex_number', opts, functi // TODO: add math/special/abs2 benchmarks -bench( pkg+'::mathjs:square:value=complex_number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:square:value=complex_number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js b/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js index a385e47288bf..b940646936a9 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.square.number.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/math/base/special/abs2' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:math/base/special/abs2:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:math/base/special/abs2:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; @@ -64,7 +65,7 @@ bench( pkg+'::stdlib:math/base/special/abs2:value=number', opts, function benchm // TODO: add math/special/abs2 benchmarks -bench( pkg+'::mathjs:square:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:square:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var i; diff --git a/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js b/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js index 24512a323219..e5a412b3b9c3 100644 --- a/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js +++ b/docs/migration-guides/mathjs/benchmark/benchmark.subtract.js @@ -24,6 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var filledBy = require( '@stdlib/array/filled-by' ); +var format = require( '@stdlib/string/format' ); var uniform = require( '@stdlib/random/base/uniform' ).factory; var base = require( '@stdlib/number/float64/base/sub' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -40,7 +41,7 @@ var opts = { // MAIN // -bench( pkg+'::stdlib:number/float64/base/sub:value=number', opts, function benchmark( b ) { +bench( format( '%s::stdlib:number/float64/base/sub:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; @@ -68,7 +69,7 @@ bench( pkg+'::stdlib:number/float64/base/sub:value=number', opts, function bench // TODO: add math/ops/sub benchmarks -bench( pkg+'::mathjs:subtract:value=number', opts, function benchmark( b ) { +bench( format( '%s::mathjs:subtract:value=number', pkg ), opts, function benchmark( b ) { var x; var y; var z; diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/README.md b/lib/node_modules/@stdlib/stats/incr/nanvariance/README.md new file mode 100644 index 000000000000..043f95ba9754 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/README.md @@ -0,0 +1,172 @@ + + +# incrnanvariance + +> Compute an [unbiased sample variance][sample-variance] incrementally, ignoring `NaN` values. + +
+ +The [unbiased sample variance][sample-variance] is defined as + + + +```math +s^2 = \frac{1}{n-1} \sum_{i=0}^{n-1} ( x_i - \bar{x} )^2 +``` + + + + + +
+ + + +
+ +## Usage + +```javascript +var incrnanvariance = require( '@stdlib/stats/incr/nanvariance' ); +``` + +#### incrnanvariance( \[mean] ) + +Returns an accumulator `function` which incrementally computes an [unbiased sample variance][sample-variance]. + +```javascript +var accumulator = incrnanvariance(); +``` + +If the mean is already known, provide a `mean` argument. + +```javascript +var accumulator = incrnanvariance( 3.0 ); +``` + +#### accumulator( \[x] ) + +If provided an input value `x`, the accumulator function returns an updated [unbiased sample variance][sample-variance]. If not provided an input value `x`, the accumulator function returns the current [unbiased sample variance][sample-variance]. + +```javascript +var accumulator = incrnanvariance(); + +var s2 = accumulator( 2.0 ); +// returns 0.0 + +s2 = accumulator( 1.0 ); // => ((2-1.5)^2+(1-1.5)^2) / (2-1) +// returns 0.5 + +s2 = accumulator( 3.0 ); // => ((2-2)^2+(1-2)^2+(3-2)^2) / (3-1) +// returns 1.0 + +s2 = accumulator( NaN ); +// returns 1.0 + +s2 = accumulator(); +// returns 1.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. + +
+ + + +
+ +## Examples + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var incrnanvariance = require( '@stdlib/stats/incr/nanvariance' ); + +var accumulator; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanvariance(); + +// For each simulated datum, update the unbiased sample variance... +for ( i = 0; i < 100; i++ ) { + if ( randu() < 0.2 ) { + v = NaN; + } else { + v = randu() * 100.0; + } + accumulator( v ); +} +console.log( accumulator() ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/incr/nanvariance/benchmark/benchmark.js new file mode 100644 index 000000000000..89885e69f671 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/benchmark/benchmark.js @@ -0,0 +1,92 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var incrnanvariance = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var f; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + f = incrnanvariance(); + 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( format( '%s::accumulator', pkg ), function benchmark( b ) { + var acc; + var v; + var i; + + acc = incrnanvariance(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = acc( randu() ); + 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(); +}); + +bench( format( '%s::accumulator,known_mean' ), function benchmark( b ) { + var acc; + var v; + var i; + + acc = incrnanvariance( 3.14 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = acc( randu() ); + 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/nanvariance/docs/img/equation_unbiased_sample_variance.svg b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/img/equation_unbiased_sample_variance.svg new file mode 100644 index 000000000000..1ae1283e7fb1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/img/equation_unbiased_sample_variance.svg @@ -0,0 +1,61 @@ + +s squared equals StartFraction 1 Over n minus 1 EndFraction sigma-summation Underscript i equals 0 Overscript n minus 1 Endscripts left-parenthesis x Subscript i Baseline minus x overbar right-parenthesis squared + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/repl.txt b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/repl.txt new file mode 100644 index 000000000000..7d96a7ed62d2 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/repl.txt @@ -0,0 +1,36 @@ + +{{alias}}( [mean] ) + Returns an accumulator function which incrementally computes an unbiased + sample variance, ignorning `NaN` values. + + If provided a value, the accumulator function returns an updated unbiased + sample variance. If not provided a value, the accumulator function returns + the current unbiased sample variance. + + Parameters + ---------- + mean: number (optional) + Known mean. + + Returns + ------- + acc: Function + Accumulator function. + + Examples + -------- + > var accumulator = {{alias}}(); + > var s2 = accumulator() + null + > s2 = accumulator( 2.0 ) + 0.0 + > s2 = accumulator( -5.0 ) + 24.5 + > s2 = accumulator( NaN ) + 24.5 + > s2 = accumulator() + 24.5 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/types/index.d.ts new file mode 100644 index 000000000000..224b5c58c838 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/types/index.d.ts @@ -0,0 +1,58 @@ +/* +* @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 a value, returns an updated unbiased sample variance; otherwise, returns the current unbiased sample variance. +* +* @param x - value +* @returns unbiased sample variance +*/ +type accumulator = ( x?: number ) => number | null; + +/** +* Returns an accumulator function which incrementally computes an unbiased sample variance, ignoring `NaN` values. +* +* @param mu - known mean +* @returns accumulator function +* +* @example +* var accumulator = incrnanvariance(); +* +* var s2 = accumulator(); +* // returns null +* +* s2 = accumulator( 2.0 ); +* // returns 0.0 +* +* s2 = accumulator( -5.0 ); +* // returns 24.5 +* +* s2 = accumulator( NaN ); +* // returns 24.5 +* +* s2 = accumulator(); +* // returns 24.5 +*/ +declare function incrnanvariance( mu?: number ): accumulator; + + +// EXPORTS // + +export = incrnanvariance; diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/types/test.ts b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/types/test.ts new file mode 100644 index 000000000000..8a69d19f6a66 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/docs/types/test.ts @@ -0,0 +1,60 @@ +/* +* @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 incrnanvariance = require( './index' ); + + +// TESTS // + +// The function returns an accumulator function... +{ + incrnanvariance(); // $ExpectType accumulator + incrnanvariance( 0.0 ); // $ExpectType accumulator +} + +// The compiler throws an error if the function is provided invalid arguments... +{ + incrnanvariance( '5' ); // $ExpectError + incrnanvariance( true ); // $ExpectError + incrnanvariance( false ); // $ExpectError + incrnanvariance( null ); // $ExpectError + incrnanvariance( [] ); // $ExpectError + incrnanvariance( {} ); // $ExpectError + incrnanvariance( ( x: number ): number => x ); // $ExpectError +} + +// The function returns an accumulator function which returns an accumulated result... +{ + const acc = incrnanvariance(); + + acc(); // $ExpectType number | null + acc( 3.14 ); // $ExpectType number | null +} + +// The compiler throws an error if the returned accumulator function is provided invalid arguments... +{ + const acc = incrnanvariance(); + + acc( '5' ); // $ExpectError + acc( true ); // $ExpectError + acc( false ); // $ExpectError + acc( null ); // $ExpectError + acc( [] ); // $ExpectError + acc( {} ); // $ExpectError + acc( ( x: number ): number => x ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/examples/index.js b/lib/node_modules/@stdlib/stats/incr/nanvariance/examples/index.js new file mode 100644 index 000000000000..6602179a914e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/examples/index.js @@ -0,0 +1,43 @@ +/** +* @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 randu = require( '@stdlib/random/base/randu' ); +var incrnanvariance = require( './../lib' ); + +var accumulator; +var s2; +var v; +var i; + +// Initialize an accumulator: +accumulator = incrnanvariance(); + +// For each simulated datum, update the unbiased sample variance... +console.log( '\nValue\tVariance\n' ); +for ( i = 0; i < 100; i++ ) { + if ( randu() < 0.2 ) { + v = NaN; + } else { + v = randu() * 100.0; + } + s2 = accumulator( v ); + console.log( '%d\t%d', v.toFixed( 4 ), s2.toFixed( 4 ) ); +} +console.log( '\nFinal variance: %d\n', accumulator() ); diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/lib/index.js b/lib/node_modules/@stdlib/stats/incr/nanvariance/lib/index.js new file mode 100644 index 000000000000..edd555d1e11b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/lib/index.js @@ -0,0 +1,54 @@ +/** +* @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 an unbiased sample variance incrementally, ignoring `NaN` values. +* +* @module @stdlib/stats/incr/nanvariance +* +* @example +* var incrnanvariance = require( '@stdlib/stats/incr/nanvariance' ); +* +* var accumulator = incrnanvariance(); +* +* var s2 = accumulator(); +* // returns null +* +* s2 = accumulator( 2.0 ); +* // returns 0.0 +* +* s2 = accumulator( -5.0 ); +* // returns 24.5 +* +* s2 = accumulator( NaN ); +* // returns 24.5 +* +* s2 = accumulator(); +* // returns 24.5 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/lib/main.js b/lib/node_modules/@stdlib/stats/incr/nanvariance/lib/main.js new file mode 100644 index 000000000000..8b30f15aab46 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/lib/main.js @@ -0,0 +1,84 @@ +/** +* @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 incrvariance = require( '@stdlib/stats/incr/variance' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); + + +// MAIN // + +/** +* Returns an accumulator function which incrementally computes an unbiased sample variance, ignoring `NaN` values. +* +* @param {number} [mean] - mean value +* @throws {TypeError} must provide a number primitive +* @returns {Function} accumulator function +* +* @example +* var accumulator = incrnanvariance(); +* +* var s2 = accumulator(); +* // returns null +* +* s2 = accumulator( 2.0 ); +* // returns 0.0 +* +* s2 = accumulator( -5.0 ); +* // returns 24.5 +* +* s2 = accumulator( NaN ); +* // returns 24.5 +* +* s2 = accumulator(); +* // returns 24.5 +* +* @example +* var accumulator = incrnanvariance( 3.14 ); +*/ +function incrnanvariance( mean ) { + var variance; + if ( arguments.length ) { + variance = incrvariance( mean ); + } else { + variance = incrvariance(); + } + return accumulator; + + /** + * If provided a value, the accumulator function returns an updated unbiased sample variance. If not provided a value, the accumulator function returns the current unbiased sample variance. + * + * @private + * @param {number} [x] - new value + * @returns {(number|null)} unbiased sample variance or null + */ + function accumulator( x ) { + if ( arguments.length === 0 || isnan( x ) ) { + return variance(); + } + return variance( x ); + } +} + + +// EXPORTS // + +module.exports = incrnanvariance; diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/package.json b/lib/node_modules/@stdlib/stats/incr/nanvariance/package.json new file mode 100644 index 000000000000..3388d2675f8c --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/stats/incr/nanvariance", + "version": "0.0.0", + "description": "Compute an unbiased sample variance incrementally.", + "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", + "variance", + "sample variance", + "unbiased", + "var", + "dispersion", + "standard deviation", + "stdev", + "central tendency", + "incremental", + "accumulator" + ] +} diff --git a/lib/node_modules/@stdlib/stats/incr/nanvariance/test/test.js b/lib/node_modules/@stdlib/stats/incr/nanvariance/test/test.js new file mode 100644 index 000000000000..93461cdc73ed --- /dev/null +++ b/lib/node_modules/@stdlib/stats/incr/nanvariance/test/test.js @@ -0,0 +1,276 @@ +/** +* @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 zeros = require( '@stdlib/array/base/zeros' ); +var incrnanvariance = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof incrnanvariance, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an accumulator function', function test( t ) { + t.strictEqual( typeof incrnanvariance(), 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns an accumulator function (known mean)', function test( t ) { + t.strictEqual( typeof incrnanvariance( 3.0 ), 'function', 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided a non-numeric value', function test( t ) { + var values; + var i; + + values = [ + '5', + true, + false, + null, + void 0, + [], + {}, + 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() { + incrnanvariance( value ); + }; + } +}); + +tape( 'the accumulator function incrementally computes an unbiased sample variance', function test( t ) { + var expected; + var actual; + var data; + var acc; + var i; + + data = [ 2.0, 3.0, 2.0, 4.0, 3.0, 4.0 ]; + + // Test against Julia: + expected = [ + 0.0, + 0.5, + 0.33333333333333337, + 0.9166666666666666, + 0.7, + 0.8 + ]; + + acc = incrnanvariance(); + + actual = zeros( data.length ); + for ( i = 0; i < data.length; i++ ) { + actual[ i ] = acc( data[ i ] ); + } + t.deepEqual( actual, expected, 'returns expected incremental results' ); + t.end(); +}); + +tape( 'the accumulator function incrementally computes an unbiased sample variance (known mean)', function test( t ) { + var expected; + var actual; + var data; + var acc; + var i; + + data = [ 2.0, 3.0, 2.0, 4.0, 3.0, 4.0 ]; + + // Test against Julia: + expected = [ + 1.0, + 0.5, + 0.6666666666666666, + 0.75, + 0.6, + 0.6666666666666666 + ]; + + acc = incrnanvariance( 3.0 ); + + actual = zeros( data.length ); + for ( i = 0; i < data.length; i++ ) { + actual[ i ] = acc( data[ i ] ); + } + t.deepEqual( actual, expected, 'returns expected incremental results' ); + t.end(); +}); + +tape( 'if not provided an input value, the accumulator function returns the current unbiased sample variance', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, 3.0, 1.0 ]; + acc = incrnanvariance(); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.strictEqual( acc(), 1.0, 'returns the current accumulated unbiased sample variance' ); + t.end(); +}); + +tape( 'if not provided an input value, the accumulator function returns the current unbiased sample variance (known mean)', function test( t ) { + var data; + var acc; + var i; + + data = [ 2.0, 3.0, 1.0 ]; + acc = incrnanvariance( 2.0 ); + for ( i = 0; i < data.length; i++ ) { + acc( data[ i ] ); + } + t.strictEqual( acc(), 0.6666666666666666, 'returns the current accumulated unbiased sample variance' ); + t.end(); +}); + +tape( 'the sample variance is `null` until at least 1 datum has been provided (unknown mean)', function test( t ) { + var acc; + var s2; + + acc = incrnanvariance(); + + s2 = acc(); + t.strictEqual( s2, null, 'returns expected value' ); + + s2 = acc( 3.0 ); + t.notEqual( s2, null, 'does not return null' ); + + s2 = acc(); + t.notEqual( s2, null, 'does not return null' ); + + t.end(); +}); + +tape( 'the sample variance is `null` until at least 1 datum has been provided (known mean)', function test( t ) { + var acc; + var s2; + + acc = incrnanvariance( 3.0 ); + + s2 = acc(); + t.strictEqual( s2, null, 'returns expected value' ); + + s2 = acc( 3.0 ); + t.notEqual( s2, null, 'does not return null' ); + + s2 = acc(); + t.notEqual( s2, null, 'does not return null' ); + + t.end(); +}); + +tape( 'the sample variance is `0` until at least 2 datums have been provided (unknown mean)', function test( t ) { + var acc; + var s2; + + acc = incrnanvariance(); + + s2 = acc( 2.0 ); + t.strictEqual( s2, 0.0, 'returns expected value' ); + + s2 = acc(); + t.strictEqual( s2, 0.0, 'returns expected value' ); + + s2 = acc( 3.0 ); + t.notEqual( s2, 0.0, 'does not return 0' ); + + s2 = acc(); + t.notEqual( s2, 0.0, 'does not return 0' ); + + t.end(); +}); + +tape( 'if provided a `NaN`, the accumulator function returns the current unbiased sample variance (unknown mean)', function test( t ) { + var expected; + var actual; + var data; + var acc; + var i; + + data = [ 2.0, 1.0, 2.0, NaN, 3.0, 4.0, 5.0, 6.0, NaN, 7.0 ]; + + // Test against Julia: + expected = [ + 0, + 0.5, + 0.3333333333333333, + 0.3333333333333333, + 0.6666666666666666, + 1.3, + 2.166666666666667, + 3.2380952380952386, + 3.2380952380952386, + 4.5 + ]; + + acc = incrnanvariance(); + actual = zeros( data.length ); + for ( i = 0; i < data.length; i++ ) { + actual[ i ] = acc( data[ i ] ); + } + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if provided a `NaN`, the accumulator function returns the current unbiased sample variance (known mean)', function test( t ) { + var expected; + var actual; + var data; + var acc; + var i; + + data = [ 2.0, 1.0, 2.0, NaN, 3.0, 4.0, 5.0, 6.0, NaN, 7.0 ]; + + // Test against Julia: + expected = [ + 1.2996000000000003, + 2.9396000000000004, + 2.3929333333333336, + 2.3929333333333336, + 1.7996, + 1.5876000000000001, + 1.8996000000000002, + 2.7967428571428568, + 2.7967428571428568, + 4.3096 + ]; + acc = incrnanvariance( 3.14 ); + actual = zeros( data.length ); + for ( i = 0; i < data.length; i++ ) { + actual[ i ] = acc( data[ i ] ); + } + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +});