diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/README.md b/lib/node_modules/@stdlib/stats/base/dmeanstdev/README.md index 4f6bd617531a..3e20a5d25a38 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/README.md +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/README.md @@ -102,7 +102,7 @@ var dmeanstdev = require( '@stdlib/stats/base/dmeanstdev' ); #### dmeanstdev( N, correction, x, strideX, out, strideOut ) -Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array `x`. +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array. ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -122,21 +122,19 @@ The function has the following parameters: - **N**: number of indexed elements. - **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **strideX**: index increment for `x`. +- **strideX**: stride length for `x`. - **out**: output [`Float64Array`][@stdlib/array/float64] for storing results. -- **strideOut**: index increment for `out`. +- **strideOut**: stride length for `out`. -The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the [standard deviation][standard-deviation] of every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [standard deviation][standard-deviation] of every other element in `x`, ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); var out = new Float64Array( 2 ); -var N = floor( x.length / 2 ); -var v = dmeanstdev( N, 1, x, 2, out, 1 ); +var v = dmeanstdev( 4, 1, x, 2, out, 1 ); // returns [ 1.25, 2.5 ] ``` @@ -146,7 +144,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element @@ -154,9 +151,7 @@ var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd var out0 = new Float64Array( 4 ); var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at 3rd element -var N = floor( x0.length / 2 ); - -var v = dmeanstdev( N, 1, x1, 2, out1, 1 ); +var v = dmeanstdev( 4, 1, x1, 2, out1, 1 ); // returns [ 1.25, 2.5 ] ``` @@ -179,17 +174,15 @@ The function has the following additional parameters: - **offsetX**: starting index for `x`. - **offsetOut**: starting index for `out`. -While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameters support indexing semantics based on a starting index. For example, to calculate the [mean][arithmetic-mean] and [standard deviation][standard-deviation] for every other value in `x` starting from the second value +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the [mean][arithmetic-mean] and [standard deviation][standard-deviation] for every other element in `x` starting from the second element ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var out = new Float64Array( 4 ); -var N = floor( x.length / 2 ); -var v = dmeanstdev.ndarray( N, 1, x, 2, 1, out, 2, 1 ); +var v = dmeanstdev.ndarray( 4, 1, x, 2, 1, out, 2, 1 ); // returns [ 0.0, 1.25, 0.0, 2.5 ] ``` @@ -215,22 +208,16 @@ var v = dmeanstdev.ndarray( N, 1, x, 2, 1, out, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var Float64Array = require( '@stdlib/array/float64' ); var dmeanstdev = require( '@stdlib/stats/base/dmeanstdev' ); -var out; -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); console.log( x ); -out = new Float64Array( 2 ); +var out = new Float64Array( 2 ); dmeanstdev( x.length, 1, x, 1, out, 1 ); console.log( out ); ``` @@ -239,6 +226,135 @@ console.log( out ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dmeanstdev.h" +``` + +#### stdlib_strided_dmeanstdev( N, correction, \*X, strideX, \*Out, strideOut ) + +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; +double out[] = { 0.0, 0.0 }; + +stdlib_strided_dmeanstdev( 4, 1.0, x, 1, out, 1 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **correction**: `[in] double` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Out**: `[out] double*` output array. +- **strideOut**: `[in] CBLAS_INT` stride length for `Out`. + +```c +void stdlib_strided_dmeanstdev( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut ); +``` + +#### stdlib_strided_dmeanstdev_ndarray( N, correction, \*X, strideX, offsetX, \*Out, strideOut, offsetOut ) + +Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; +double out[] = { 0.0, 0.0 }; + +stdlib_strided_dmeanstdev_ndarray( 4, 1.0, x, 2, 0, x, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **correction**: `[in] double` degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the corrected sample [standard deviation][standard-deviation], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Out**: `[out] double*` output array. +- **strideOut**: `[in] CBLAS_INT` stride length for `Out`. +- **offsetOut**: `[in] CBLAS_INT` starting index for `Out`. + +```c +void stdlib_strided_dmeanstdev_ndarray( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dmeanstdev.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + + // Create an output array: + double out[] = { 0.0, 0.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + const int strideOut = 1; + + // Compute the mean and standard deviation: + stdlib_strided_dmeanstdev( N, 1.0, x, strideX, out, strideOut ); + + // Print the result: + printf( "sample mean: %lf\n", out[ 0 ] ); + printf( "sample standard deviation: %lf\n", out[ 1 ] ); +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.js index 4acb59fb4c9e..145a877deae0 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.js @@ -21,14 +21,21 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var pkg = require( './../package.json' ).name; var dmeanstdev = require( './../lib/dmeanstdev.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -41,12 +48,8 @@ var dmeanstdev = require( './../lib/dmeanstdev.js' ); function createBenchmark( len ) { var out; var x; - var i; - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + x = uniform( len, -10.0, 10.0, options ); out = new Float64Array( 2 ); return benchmark; diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.native.js index 834f32f5c3dd..d12fbf6f5a36 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.native.js @@ -22,10 +22,10 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +36,9 @@ var dmeanstdev = tryRequire( resolve( __dirname, './../lib/dmeanstdev.native.js' var opts = { 'skip': ( dmeanstdev instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -50,12 +53,8 @@ var opts = { function createBenchmark( len ) { var out; var x; - var i; - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + x = uniform( len, -10.0, 10.0, options ); out = new Float64Array( 2 ); return benchmark; diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.js index b5e66116eb35..ed29f8657e64 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.js @@ -21,14 +21,21 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var pkg = require( './../package.json' ).name; var dmeanstdev = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -41,12 +48,8 @@ var dmeanstdev = require( './../lib/ndarray.js' ); function createBenchmark( len ) { var out; var x; - var i; - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + x = uniform( len, -10.0, 10.0, options ); out = new Float64Array( 2 ); return benchmark; diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.native.js index 767620b9c711..2df846cba702 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/benchmark/benchmark.ndarray.native.js @@ -22,10 +22,10 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +36,9 @@ var dmeanstdev = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) var opts = { 'skip': ( dmeanstdev instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -50,12 +53,8 @@ var opts = { function createBenchmark( len ) { var out; var x; - var i; - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + x = uniform( len, -10.0, 10.0, options ); out = new Float64Array( 2 ); return benchmark; diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dmeanstdev/docs/repl.txt index 120db54a73d9..8e3c76b7a46e 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/docs/repl.txt @@ -3,8 +3,8 @@ Computes the mean and standard deviation of a double-precision floating- point strided array. - The `N` and `stride` parameters determine which elements are accessed at - runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed array view. @@ -33,13 +33,13 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. out: Float64Array Output array. strideOut: integer - Index increment for `out`. + Stride length for `out`. Returns ------- @@ -54,21 +54,20 @@ > {{alias}}( x.length, 1, x, 1, out, 1 ) [ ~0.3333, ~2.0817 ] - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float64}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] ); > out = new {{alias:@stdlib/array/float64}}( 2 ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, 1, x, 2, out, 1 ) + > {{alias}}( 3, 1, x, 2, out, 1 ) [ ~0.3333, ~2.0817 ] // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); > out = new {{alias:@stdlib/array/float64}}( 2 ); - > {{alias}}( N, 1, x1, 2, out, 1 ) + > {{alias}}( 3, 1, x1, 2, out, 1 ) [ ~0.3333, ~2.0817 ] + {{alias}}.ndarray( N, c, x, strideX, offsetX, out, strideOut, offsetOut ) Computes the mean and standard deviation of a double-precision floating- point strided array using alternative indexing semantics. @@ -98,7 +97,7 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. offsetX: integer Starting index for `x`. @@ -107,7 +106,7 @@ Output array. strideOut: integer - Index increment for `out`. + Stride length for `out`. offsetOut: integer Starting index for `out`. @@ -126,10 +125,9 @@ [ ~0.3333, ~2.0817 ] // Using offset parameter: - > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 1.0 ] ); > out = new {{alias:@stdlib/array/float64}}( 2 ); - > {{alias}}.ndarray( N, 1, x, 2, 1, out, 1, 0 ) + > {{alias}}.ndarray( 3, 1, x, 2, 1, out, 1, 0 ) [ ~0.3333, ~2.0817 ] See Also diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/c/example.c index 5ee0c28e9ec4..006ff5f8daa1 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/c/example.c @@ -17,25 +17,24 @@ */ #include "stdlib/stats/base/dmeanstdev.h" -#include #include int main( void ) { // Create a strided array: - double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; // Create an output array: double out[] = { 0.0, 0.0 }; // Specify the number of elements: - int64_t N = 4; + const int N = 4; // Specify the stride lengths: - int64_t strideX = 2; - int64_t strideOut = 1; + const int strideX = 2; + const int strideOut = 1; // Compute the mean and standard deviation: - stdlib_strided_dmeanstdev( N, 1, x, strideX, out, strideOut ); + stdlib_strided_dmeanstdev( N, 1.0, x, strideX, out, strideOut ); // Print the result: printf( "sample mean: %lf\n", out[ 0 ] ); diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/index.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/index.js index e780c5fa7640..f8493d4535e5 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/examples/index.js @@ -18,21 +18,15 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var Float64Array = require( '@stdlib/array/float64' ); var dmeanstdev = require( './../lib' ); -var out; -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float64' +}); console.log( x ); -out = new Float64Array( 2 ); +var out = new Float64Array( 2 ); dmeanstdev( x.length, 1, x, 1, out, 1 ); console.log( out ); diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/include/stdlib/stats/base/dmeanstdev.h b/lib/node_modules/@stdlib/stats/base/dmeanstdev/include/stdlib/stats/base/dmeanstdev.h index 7d09f4fddcfc..bba74f77a719 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/include/stdlib/stats/base/dmeanstdev.h +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/include/stdlib/stats/base/dmeanstdev.h @@ -19,7 +19,7 @@ #ifndef STDLIB_STATS_BASE_DMEANSTDEV_H #define STDLIB_STATS_BASE_DMEANSTDEV_H -#include +#include "stdlib/blas/base/shared.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,12 @@ extern "C" { /** * Computes the mean and standard deviation of a double-precision floating-point strided array. */ -void stdlib_strided_dmeanstdev( const int64_t N, const double correction, const double *X, const int64_t strideX, double *Out, const int64_t strideOut ); +void API_SUFFIX(stdlib_strided_dmeanstdev)( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut ); + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using alternative indexing semantics. +*/ +void API_SUFFIX(stdlib_strided_dmeanstdev_ndarray)( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/dmeanstdev.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/dmeanstdev.js index 711cc71e6b23..643141aeddde 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/dmeanstdev.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/dmeanstdev.js @@ -20,7 +20,8 @@ // MODULES // -var dmeanstdevpn = require( '@stdlib/stats/base/dmeanstdevpn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -46,7 +47,10 @@ var dmeanstdevpn = require( '@stdlib/stats/base/dmeanstdevpn' ); * // returns [ ~0.3333, ~2.0817 ] */ function dmeanstdev( N, correction, x, strideX, out, strideOut ) { - return dmeanstdevpn( N, correction, x, strideX, out, strideOut ); + var ox = stride2offset( N, strideX ); + var oo = ( strideOut >= 0 ) ? 0 : -strideOut; + ndarray( N, correction, x, strideX, ox, out, strideOut, oo ); + return out; } diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/index.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/index.js index 18158b675ad7..a7a1c27ced7a 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/index.js @@ -35,15 +35,12 @@ * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var dmeanstdev = require( '@stdlib/stats/base/dmeanstdev' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); * var out = new Float64Array( 2 ); * -* var N = floor( x.length / 2 ); -* -* var v = dmeanstdev.ndarray( N, 1, x, 2, 1, out, 1, 0 ); +* var v = dmeanstdev.ndarray( 4, 1, x, 2, 1, out, 1, 0 ); * // returns [ 1.25, 2.5 ] */ diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.js index f5f873d2cc03..8086276997f2 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.js @@ -40,14 +40,11 @@ var dmeanstdevpn = require( '@stdlib/stats/base/dmeanstdevpn' ).ndarray; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); * var out = new Float64Array( 2 ); * -* var N = floor( x.length / 2 ); -* -* var v = dmeanstdev( N, 1, x, 2, 1, out, 1, 0 ); +* var v = dmeanstdev( 4, 1, x, 2, 1, out, 1, 0 ); * // returns [ 1.25, 2.5 ] */ function dmeanstdev( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ) { // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.native.js index 30a61a7cc5e7..2227ef326805 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float64Array = require( '@stdlib/array/float64' ); -var addon = require( './dmeanstdev.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -41,28 +40,15 @@ var addon = require( './dmeanstdev.native.js' ); * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); * var out = new Float64Array( 2 ); * -* var N = floor( x.length / 2 ); -* -* var v = dmeanstdev( N, 1, x, 2, 1, out, 1, 0 ); +* var v = dmeanstdev( 4, 1, x, 2, 1, out, 1, 0 ); * // returns [ 1.25, 2.5 ] */ function dmeanstdev( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ) { // eslint-disable-line max-len - var viewOut; - var viewX; - if ( strideX < 0 ) { - offsetX += (N-1) * strideX; - } - if ( strideOut < 0 ) { - offsetOut += strideOut; - } - viewX = new Float64Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offsetX), x.length-offsetX ); // eslint-disable-line max-len - viewOut = new Float64Array( out.buffer, out.byteOffset+(out.BYTES_PER_ELEMENT*offsetOut), out.length-offsetOut ); // eslint-disable-line max-len - addon( N, correction, viewX, strideX, viewOut, strideOut ); + addon.ndarray( N, correction, x, strideX, offsetX, out, strideOut, offsetOut ); // eslint-disable-line max-len return out; } diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/manifest.json b/lib/node_modules/@stdlib/stats/base/dmeanstdev/manifest.json index c80596729b88..9e38b401d872 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/manifest.json @@ -1,6 +1,7 @@ { "options": { - "task": "build" + "task": "build", + "wasm": false }, "fields": [ { @@ -27,55 +28,74 @@ "confs": [ { "task": "build", + "wasm": false, "src": [ "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/base/dmeanstdevpn", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-double", - "@stdlib/napi/argv-strided-float64array", - "@stdlib/blas/base/shared", - "@stdlib/stats/base/dmeanstdevpn" + "@stdlib/napi/argv-strided-float64array" ] }, { "task": "benchmark", + "wasm": false, "src": [ "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/stats/base/dmeanstdevpn" ] }, { "task": "examples", + "wasm": false, "src": [ "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/stats/base/dmeanstdevpn" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" ], + "include": [ + "./include" + ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/stats/base/dmeanstdevpn" ] } diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/addon.c b/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/addon.c index 581506d288e3..69c1be1af350 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/addon.c +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/addon.c @@ -44,4 +44,25 @@ static napi_value addon( napi_env env, napi_callback_info info ) { return NULL; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 8 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 4 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut, argv, 6 ); + STDLIB_NAPI_ARGV_INT64( env, offsetOut, argv, 7 ); + STDLIB_NAPI_ARGV_DOUBLE( env, correction, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Out, 2, strideOut, argv, 5 ); + API_SUFFIX(stdlib_strided_dmeanstdev_ndarray)( N, correction, X, strideX, offsetX, Out, strideOut, offsetOut ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/main.c index 997cc566e9cb..95e5a1c3539a 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/src/main.c @@ -18,7 +18,8 @@ #include "stdlib/stats/base/dmeanstdev.h" #include "stdlib/stats/base/dmeanstdevpn.h" -#include +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" /** * Computes the mean and standard deviation of a double-precision floating-point strided array. @@ -30,6 +31,26 @@ * @param Out output array * @param strideOut Out stride length */ -void stdlib_strided_dmeanstdev( const int64_t N, const double correction, const double *X, const int64_t strideX, double *Out, const int64_t strideOut ) { - stdlib_strided_dmeanstdevpn( N, correction, X, strideX, Out, strideOut ); +void API_SUFFIX(stdlib_strided_dmeanstdev)( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + const CBLAS_INT oo = ( strideOut >= 0 ) ? 0 : -strideOut; + API_SUFFIX(stdlib_strided_dmeanstdev_ndarray)( N, correction, X, strideX, ox, Out, strideOut, oo ); + return; +} + +/** +* Computes the mean and standard deviation of a double-precision floating-point strided array using alternative indexing semantics. +* +* @param N number of indexed elements +* @param correction degrees of freedom adjustment +* @param X input array +* @param strideX X stride length +* @param offsetX starting index for X +* @param Out output array +* @param strideOut Out stride length +* @param offsetOut starting index for Out +*/ +void API_SUFFIX(stdlib_strided_dmeanstdev_ndarray)( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ) { + API_SUFFIX(stdlib_strided_dmeanstdevpn_ndarray)( N, correction, X, strideX, offsetX, Out, strideOut, offsetOut ); + return; } diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.js index d6a3ae41e454..637ff1609008 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -189,7 +188,6 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or tape( 'the function supports `stride` parameters', function test( t ) { var expected; var out; - var N; var x; var v; @@ -205,8 +203,7 @@ tape( 'the function supports `stride` parameters', function test( t ) { ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, 2, out, 2 ); + v = dmeanstdev( 4, 1, x, 2, out, 2 ); expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -217,7 +214,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var expected; var out; - var N; var x; var v; @@ -233,8 +229,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, -2, out, -2 ); + v = dmeanstdev( 4, 1, x, -2, out, -2 ); expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -266,7 +261,6 @@ tape( 'the function supports view offsets', function test( t ) { var out1; var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -284,9 +278,8 @@ tape( 'the function supports view offsets', function test( t ) { x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at the 3rd element - N = floor(x1.length / 2); - v = dmeanstdev( N, 1, x1, 2, out1, 1 ); + v = dmeanstdev( 4, 1, x1, 2, out1, 1 ); expected0 = new Float64Array( [ 0.0, 0.0, 1.25, 2.5 ] ); expected1 = new Float64Array( [ 1.25, 2.5 ] ); diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.native.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.native.js index bbd8a20da9c6..1f3d42032776 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.dmeanstdev.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -198,7 +197,6 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or tape( 'the function supports `stride` parameters', opts, function test( t ) { var expected; var out; - var N; var x; var v; @@ -214,8 +212,7 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, 2, out, 2 ); + v = dmeanstdev( 4, 1, x, 2, out, 2 ); expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -226,7 +223,6 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { tape( 'the function supports negative `stride` parameters', opts, function test( t ) { var expected; var out; - var N; var x; var v; @@ -242,8 +238,7 @@ tape( 'the function supports negative `stride` parameters', opts, function test( ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, -2, out, -2 ); + v = dmeanstdev( 4, 1, x, -2, out, -2 ); expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -275,7 +270,6 @@ tape( 'the function supports view offsets', opts, function test( t ) { var out1; var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -293,9 +287,8 @@ tape( 'the function supports view offsets', opts, function test( t ) { x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at the 3rd element - N = floor(x1.length / 2); - v = dmeanstdev( N, 1, x1, 2, out1, 1 ); + v = dmeanstdev( 4, 1, x1, 2, out1, 1 ); expected0 = new Float64Array( [ 0.0, 0.0, 1.25, 2.5 ] ); expected1 = new Float64Array( [ 1.25, 2.5 ] ); diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.js index 6ccd519b6aa3..f24780fdbd9f 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -189,7 +188,6 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or tape( 'the function supports `stride` parameters', function test( t ) { var expected; var out; - var N; var x; var v; @@ -205,8 +203,7 @@ tape( 'the function supports `stride` parameters', function test( t ) { ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, 2, 0, out, 2, 0 ); + v = dmeanstdev( 4, 1, x, 2, 0, out, 2, 0 ); expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -217,7 +214,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var expected; var out; - var N; var x; var v; @@ -233,8 +229,7 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, -2, 6, out, -2, 2 ); + v = dmeanstdev( 4, 1, x, -2, 6, out, -2, 2 ); expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -262,7 +257,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns an ar tape( 'the function supports `offset` parameters', function test( t ) { var expected; var out; - var N; var x; var v; @@ -277,9 +271,8 @@ tape( 'the function supports `offset` parameters', function test( t ) { 4.0 // 3 ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, 2, 1, out, 2, 1 ); + v = dmeanstdev( 4, 1, x, 2, 1, out, 2, 1 ); expected = new Float64Array( [ 0.0, 1.25, 0.0, 2.5 ] ); t.deepEqual( v, expected, 'returns expected value' ); diff --git a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.native.js index e28653b59d50..4c4f9f81503a 100644 --- a/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/dmeanstdev/test/test.ndarray.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var sqrt = require( '@stdlib/math/base/special/sqrt' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Float64Array = require( '@stdlib/array/float64' ); @@ -198,7 +197,6 @@ tape( 'if provided a `correction` parameter yielding `N-correction` less than or tape( 'the function supports `stride` parameters', opts, function test( t ) { var expected; var out; - var N; var x; var v; @@ -214,8 +212,7 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, 2, 0, out, 2, 0 ); + v = dmeanstdev( 4, 1, x, 2, 0, out, 2, 0 ); expected = new Float64Array( [ 1.25, 0.0, 2.5, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -226,7 +223,6 @@ tape( 'the function supports `stride` parameters', opts, function test( t ) { tape( 'the function supports negative `stride` parameters', opts, function test( t ) { var expected; var out; - var N; var x; var v; @@ -242,8 +238,7 @@ tape( 'the function supports negative `stride` parameters', opts, function test( ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, -2, 6, out, -2, 2 ); + v = dmeanstdev( 4, 1, x, -2, 6, out, -2, 2 ); expected = new Float64Array( [ 2.5, 0.0, 1.25, 0.0 ] ); t.deepEqual( v, expected, 'returns expected value' ); @@ -271,7 +266,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns an ar tape( 'the function supports `offset` parameters', opts, function test( t ) { var expected; var out; - var N; var x; var v; @@ -286,9 +280,8 @@ tape( 'the function supports `offset` parameters', opts, function test( t ) { 4.0 // 3 ]); out = new Float64Array( 4 ); - N = floor( x.length / 2 ); - v = dmeanstdev( N, 1, x, 2, 1, out, 2, 1 ); + v = dmeanstdev( 4, 1, x, 2, 1, out, 2, 1 ); expected = new Float64Array( [ 0.0, 1.25, 0.0, 2.5 ] ); t.deepEqual( v, expected, 'returns expected value' );