From aa0885c51704a290dd45d6b4349ccd9ae6d1d507 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Dec 2024 16:23:36 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 16 ++- README.md | 140 +++++++++++++++++++++----- benchmark/benchmark.js | 18 ++-- benchmark/benchmark.native.js | 14 +-- benchmark/benchmark.ndarray.js | 18 ++-- benchmark/benchmark.ndarray.native.js | 14 +-- benchmark/c/benchmark.length.c | 50 ++++++++- dist/index.js | 14 +-- dist/index.js.map | 8 +- docs/repl.txt | 30 +++--- docs/types/index.d.ts | 12 +-- examples/c/example.c | 9 +- examples/index.js | 14 +-- include.gypi | 2 +- include/stdlib/stats/base/dmidrange.h | 9 +- lib/dmidrange.js | 42 +------- lib/dmidrange.native.js | 6 +- lib/index.js | 3 +- lib/ndarray.js | 18 ++-- lib/ndarray.native.js | 20 ++-- manifest.json | 75 +++++++++++++- package.json | 12 ++- src/addon.c | 60 +++++++++++ src/addon.cpp | 117 --------------------- src/{dmidrange.c => main.c} | 43 +++++--- test/test.dmidrange.js | 13 +-- test/test.dmidrange.native.js | 13 +-- test/test.ndarray.js | 13 +-- test/test.ndarray.native.js | 13 +-- 29 files changed, 452 insertions(+), 364 deletions(-) create mode 100644 src/addon.c delete mode 100644 src/addon.cpp rename src/{dmidrange.c => main.c} (55%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a34559..64e61fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,17 @@
-## Unreleased (2024-12-23) +## Unreleased (2024-12-29) + +
+ +### Features + +- [`3fcf22f`](https://github.com/stdlib-js/stdlib/commit/3fcf22faa5d7906c4278be7ad408379c36c7396e) - add C ndarray interface and refactor implementation for `stats/base/dmidrange` [(#4340)](https://github.com/stdlib-js/stdlib/pull/4340) + +
+ +
@@ -12,6 +22,7 @@
+- [`3fcf22f`](https://github.com/stdlib-js/stdlib/commit/3fcf22faa5d7906c4278be7ad408379c36c7396e) - **feat:** add C ndarray interface and refactor implementation for `stats/base/dmidrange` [(#4340)](https://github.com/stdlib-js/stdlib/pull/4340) _(by Aayush Khanna)_ - [`62364f6`](https://github.com/stdlib-js/stdlib/commit/62364f62ea823a3b52c2ad25660ecd80c71f8f36) - **style:** fix C comment alignment _(by Philipp Burckhardt)_ - [`9e689ff`](https://github.com/stdlib-js/stdlib/commit/9e689ffcb7c6223afc521f1e574b42f10921cf5e) - **chore:** fix indentation in manifest.json files _(by Philipp Burckhardt)_ - [`272ae7a`](https://github.com/stdlib-js/stdlib/commit/272ae7ac5c576c68cfab1b6e304c86407faa20cd) - **docs:** remove comment _(by Athan Reines)_ @@ -27,8 +38,9 @@ ### Contributors -A total of 2 people contributed to this release. Thank you to the following contributors: +A total of 3 people contributed to this release. Thank you to the following contributors: +- Aayush Khanna - Athan Reines - Philipp Burckhardt diff --git a/README.md b/README.md index c1e2a97..f06322b 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ To view installation and usage instructions specific to each branch build, be su var dmidrange = require( '@stdlib/stats-base-dmidrange' ); ``` -#### dmidrange( N, x, stride ) +#### dmidrange( N, x, strideX ) Computes the [mid-range][mid-range] of a double-precision floating-point strided array `x`. @@ -88,18 +88,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [mid-range][mid-range] 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 [mid-range][mid-range] 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 N = floor( x.length / 2 ); -var v = dmidrange( N, x, 2 ); +var v = dmidrange( 4, x, 2 ); // returns 1.0 ``` @@ -109,18 +107,15 @@ 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 -var N = floor( x0.length / 2 ); - -var v = dmidrange( N, x1, 2 ); +var v = dmidrange( 4, x1, 2 ); // returns 1.0 ``` -#### dmidrange.ndarray( N, x, stride, offset ) +#### dmidrange.ndarray( N, x, strideX, offsetX ) Computes the [mid-range][mid-range] of a double-precision floating-point strided array using alternative indexing semantics. @@ -135,18 +130,16 @@ var v = dmidrange.ndarray( x.length, x, 1, 0 ); The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `x`. -While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the [mid-range][mid-range] 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 parameter supports indexing semantics based on a starting index. For example, to calculate the [mid-range][mid-range] 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 N = floor( x.length / 2 ); -var v = dmidrange.ndarray( N, x, 2, 1 ); +var v = dmidrange.ndarray( 4, x, 2, 1 ); // returns 1.0 ``` @@ -171,18 +164,12 @@ var v = dmidrange.ndarray( N, x, 2, 1 ); ```javascript -var randu = require( '@stdlib/random-base-randu' ); -var round = require( '@stdlib/math-base-special-round' ); -var Float64Array = require( '@stdlib/array-float64' ); +var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var dmidrange = require( '@stdlib/stats-base-dmidrange' ); -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 ); var v = dmidrange( x.length, x, 1 ); @@ -193,6 +180,107 @@ console.log( v ); + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dmidrange.h" +``` + +#### stdlib_strided_dmidrange( N, \*X, strideX ) + +Computes the [mid-range][mid-range] of a double-precision floating-point strided array `x`. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_dmidrange( 4, x, 1 ); +// returns 2.5 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +double stdlib_strided_dmidrange( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dmidrange_ndarray( N, \*X, strideX, offsetX ) + +Computes the [mid-range][mid-range] of a double-precision floating-point strided array using alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; + +double v = stdlib_strided_dmidrange_ndarray( 4, x, 1, 0 ); +// returns 2.5 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +double stdlib_strided_dmidrange_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dmidrange.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 }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the mid-range: + double v = stdlib_strided_dmidrange( N, x, strideX ); + + // Print the result: + printf( "mid-range: %lf\n", v ); +} +``` + +
+ + + +
+ + +
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js index 46ad06a..944f744 100644 --- a/benchmark/benchmark.js +++ b/benchmark/benchmark.js @@ -21,14 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench-harness' ); -var randu = require( '@stdlib/random-base-randu' ); +var uniform = require( '@stdlib/random-array-uniform' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var pow = require( '@stdlib/math-base-special-pow' ); -var Float64Array = require( '@stdlib/array-float64' ); var pkg = require( './../package.json' ).name; var dmidrange = require( './../lib/dmidrange.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -39,13 +45,7 @@ var dmidrange = require( './../lib/dmidrange.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/benchmark/benchmark.native.js b/benchmark/benchmark.native.js index f4ca83d..1fa72e7 100644 --- a/benchmark/benchmark.native.js +++ b/benchmark/benchmark.native.js @@ -22,10 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench-harness' ); -var randu = require( '@stdlib/random-base-randu' ); +var uniform = require( '@stdlib/random-array-uniform' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var pow = require( '@stdlib/math-base-special-pow' ); -var Float64Array = require( '@stdlib/array-float64' ); var tryRequire = require( '@stdlib/utils-try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +35,9 @@ var dmidrange = tryRequire( resolve( __dirname, './../lib/dmidrange.native.js' ) var opts = { 'skip': ( dmidrange instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -48,13 +50,7 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/benchmark/benchmark.ndarray.js b/benchmark/benchmark.ndarray.js index 468e077..4cb1acf 100644 --- a/benchmark/benchmark.ndarray.js +++ b/benchmark/benchmark.ndarray.js @@ -21,14 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench-harness' ); -var randu = require( '@stdlib/random-base-randu' ); +var uniform = require( '@stdlib/random-array-uniform' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var pow = require( '@stdlib/math-base-special-pow' ); -var Float64Array = require( '@stdlib/array-float64' ); var pkg = require( './../package.json' ).name; var dmidrange = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + // FUNCTIONS // /** @@ -39,13 +45,7 @@ var dmidrange = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/benchmark/benchmark.ndarray.native.js b/benchmark/benchmark.ndarray.native.js index ca18f37..b64afa0 100644 --- a/benchmark/benchmark.ndarray.native.js +++ b/benchmark/benchmark.ndarray.native.js @@ -22,10 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench-harness' ); -var randu = require( '@stdlib/random-base-randu' ); +var uniform = require( '@stdlib/random-array-uniform' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var pow = require( '@stdlib/math-base-special-pow' ); -var Float64Array = require( '@stdlib/array-float64' ); var tryRequire = require( '@stdlib/utils-try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +35,9 @@ var dmidrange = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ) var opts = { 'skip': ( dmidrange instanceof Error ) }; +var options = { + 'dtype': 'float64' +}; // FUNCTIONS // @@ -48,13 +50,7 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float64Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/benchmark/c/benchmark.length.c b/benchmark/c/benchmark.length.c index 025ef1e..e49f9d0 100644 --- a/benchmark/c/benchmark.length.c +++ b/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static double rand_double( void ) { * @param len array length * @return elapsed time in seconds */ -static double benchmark( int iterations, int len ) { +static double benchmark1( int iterations, int len ) { double elapsed; double x[ len ]; double v; @@ -107,6 +107,7 @@ static double benchmark( int iterations, int len ) { v = 0.0; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_dmidrange( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -120,6 +121,40 @@ static double benchmark( int iterations, int len ) { return elapsed; } +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + double x[ len ]; + double v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double() * 20000.0 ) - 10000.0; + } + v = 0.0; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_dmidrange_ndarray( len, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -142,7 +177,18 @@ int main( void ) { for ( j = 0; j < REPEATS; j++ ) { count += 1; printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark( iter, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); print_results( iter, elapsed ); printf( "ok %d benchmark finished\n", count ); } diff --git a/dist/index.js b/dist/index.js index 683a384..c32d009 100644 --- a/dist/index.js +++ b/dist/index.js @@ -1,9 +1,9 @@ -"use strict";var o=function(n,i){return function(){return i||n((i={exports:{}}).exports,i),i.exports}};var m=o(function(B,q){ -var y=require('@stdlib/math-base-assert-is-positive-zero/dist'),Z=require('@stdlib/math-base-assert-is-negative-zero/dist'),j=require('@stdlib/math-base-assert-is-nan/dist');function P(n,i,t){var u,a,v,r,e;if(n<=0)return NaN;if(n===1||t===0)return i[0];for(t<0?v=(1-n)*t:v=0,a=i[v],u=a,e=1;eu||r===u&&y(r))&&(u=r)}return(u+a)/2}q.exports=P -});var c=o(function(C,d){ -var R=require('@stdlib/math-base-assert-is-positive-zero/dist'),_=require('@stdlib/math-base-assert-is-negative-zero/dist'),E=require('@stdlib/math-base-assert-is-nan/dist');function N(n,i,t,u){var a,v,r,e,s;if(n<=0)return NaN;if(n===1||t===0)return i[u];for(r=u,v=i[r],a=v,s=1;sa||e===a&&R(e))&&(a=e)}return(a+v)/2}d.exports=N -});var p=o(function(D,l){ -var O=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),g=m(),b=c();O(g,"ndarray",b);l.exports=g -});var h=require("path").join,k=require('@stdlib/utils-try-require/dist'),w=require('@stdlib/assert-is-error/dist'),z=p(),f,x=k(h(__dirname,"./native.js"));w(x)?f=z:f=x;module.exports=f; +"use strict";var s=function(i,e){return function(){return e||i((e={exports:{}}).exports,e),e.exports}};var o=s(function(B,f){ +var j=require('@stdlib/math-base-assert-is-positive-zero/dist'),l=require('@stdlib/math-base-assert-is-negative-zero/dist'),R=require('@stdlib/math-base-assert-is-nan/dist');function Z(i,e,n,d){var t,a,u,r,v;if(i<=0)return NaN;if(i===1||n===0)return e[d];for(u=d,a=e[u],t=a,v=1;vt||r===t&&j(r))&&(t=r)}return(t+a)/2}f.exports=Z +});var c=s(function(C,m){ +var _=require('@stdlib/strided-base-stride2offset/dist'),E=o();function O(i,e,n){return E(i,e,n,_(i,n))}m.exports=O +});var y=s(function(D,p){ +var P=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),g=c(),b=o();P(g,"ndarray",b);p.exports=g +});var h=require("path").join,k=require('@stdlib/utils-try-require/dist'),w=require('@stdlib/assert-is-error/dist'),z=y(),q,x=k(h(__dirname,"./native.js"));w(x)?q=z:q=x;module.exports=q; /** @license Apache-2.0 */ //# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map index cf1793e..31d7623 100644 --- a/dist/index.js.map +++ b/dist/index.js.map @@ -1,7 +1,7 @@ { "version": 3, - "sources": ["../lib/dmidrange.js", "../lib/ndarray.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' );\nvar isNegativeZero = require( '@stdlib/math-base-assert-is-negative-zero' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\n\n\n// MAIN //\n\n/**\n* Computes the mid-range of a double-precision floating-point strided array.\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {Float64Array} x - input array\n* @param {integer} stride - stride length\n* @returns {number} mid-range\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\n*\n* var v = dmidrange( x.length, x, 1 );\n* // returns 0.0\n*/\nfunction dmidrange( N, x, stride ) {\n\tvar max;\n\tvar min;\n\tvar ix;\n\tvar v;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn NaN;\n\t}\n\tif ( N === 1 || stride === 0 ) {\n\t\treturn x[ 0 ];\n\t}\n\tif ( stride < 0 ) {\n\t\tix = (1-N) * stride;\n\t} else {\n\t\tix = 0;\n\t}\n\tmin = x[ ix ];\n\tmax = min;\n\tfor ( i = 1; i < N; i++ ) {\n\t\tix += stride;\n\t\tv = x[ ix ];\n\t\tif ( isnan( v ) ) {\n\t\t\treturn v;\n\t\t}\n\t\tif ( v < min || ( v === min && isNegativeZero( v ) ) ) {\n\t\t\tmin = v;\n\t\t} else if ( v > max || ( v === max && isPositiveZero( v ) ) ) {\n\t\t\tmax = v;\n\t\t}\n\t}\n\treturn ( max+min ) / 2.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' );\nvar isNegativeZero = require( '@stdlib/math-base-assert-is-negative-zero' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\n\n\n// MAIN //\n\n/**\n* Computes the mid-range of a double-precision floating-point strided array.\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {Float64Array} x - input array\n* @param {integer} stride - stride length\n* @param {NonNegativeInteger} offset - starting index\n* @returns {number} mid-range\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var floor = require( '@stdlib/math-base-special-floor' );\n*\n* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );\n* var N = floor( x.length / 2 );\n*\n* var v = dmidrange( N, x, 2, 1 );\n* // returns 1.0\n*/\nfunction dmidrange( N, x, stride, offset ) {\n\tvar max;\n\tvar min;\n\tvar ix;\n\tvar v;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn NaN;\n\t}\n\tif ( N === 1 || stride === 0 ) {\n\t\treturn x[ offset ];\n\t}\n\tix = offset;\n\tmin = x[ ix ];\n\tmax = min;\n\tfor ( i = 1; i < N; i++ ) {\n\t\tix += stride;\n\t\tv = x[ ix ];\n\t\tif ( isnan( v ) ) {\n\t\t\treturn v;\n\t\t}\n\t\tif ( v < min || ( v === min && isNegativeZero( v ) ) ) {\n\t\t\tmin = v;\n\t\t} else if ( v > max || ( v === max && isPositiveZero( v ) ) ) {\n\t\t\tmax = v;\n\t\t}\n\t}\n\treturn ( max+min ) / 2.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar dmidrange = require( './dmidrange.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( dmidrange, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the mid-range of a double-precision floating-point strided array.\n*\n* @module @stdlib/stats-base-dmidrange\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var dmidrange = require( '@stdlib/stats-base-dmidrange' );\n*\n* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\n*\n* var v = dmidrange( x.length, x, 1 );\n* // returns 0.0\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var dmidrange = require( '@stdlib/stats-base-dmidrange' );\n*\n* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );\n* var N = floor( x.length / 2 );\n*\n* var v = dmidrange.ndarray( N, x, 2, 1 );\n* // returns 1.0\n*/\n\n// MODULES //\n\nvar join = require( 'path' ).join;\nvar tryRequire = require( '@stdlib/utils-try-require' );\nvar isError = require( '@stdlib/assert-is-error' );\nvar main = require( './main.js' );\n\n\n// MAIN //\n\nvar dmidrange;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( isError( tmp ) ) {\n\tdmidrange = main;\n} else {\n\tdmidrange = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n\n// exports: { \"ndarray\": \"dmidrange.ndarray\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,2CAA4C,EACtEC,EAAiB,QAAS,2CAA4C,EACtEC,EAAQ,QAAS,iCAAkC,EAqBvD,SAASC,EAAWC,EAAGC,EAAGC,EAAS,CAClC,IAAIC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKP,GAAK,EACT,MAAO,KAER,GAAKA,IAAM,GAAKE,IAAW,EAC1B,OAAOD,EAAG,CAAE,EASb,IAPKC,EAAS,EACbG,GAAM,EAAEL,GAAKE,EAEbG,EAAK,EAEND,EAAMH,EAAGI,CAAG,EACZF,EAAMC,EACAG,EAAI,EAAGA,EAAIP,EAAGO,IAAM,CAGzB,GAFAF,GAAMH,EACNI,EAAIL,EAAGI,CAAG,EACLP,EAAOQ,CAAE,EACb,OAAOA,EAEHA,EAAIF,GAASE,IAAMF,GAAOP,EAAgBS,CAAE,EAChDF,EAAME,GACKA,EAAIH,GAASG,IAAMH,GAAOP,EAAgBU,CAAE,KACvDH,EAAMG,EAER,CACA,OAASH,EAAIC,GAAQ,CACtB,CAKAT,EAAO,QAAUI,ICnFjB,IAAAS,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,2CAA4C,EACtEC,EAAiB,QAAS,2CAA4C,EACtEC,EAAQ,QAAS,iCAAkC,EAwBvD,SAASC,EAAWC,EAAGC,EAAGC,EAAQC,EAAS,CAC1C,IAAIC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKR,GAAK,EACT,MAAO,KAER,GAAKA,IAAM,GAAKE,IAAW,EAC1B,OAAOD,EAAGE,CAAO,EAKlB,IAHAG,EAAKH,EACLE,EAAMJ,EAAGK,CAAG,EACZF,EAAMC,EACAG,EAAI,EAAGA,EAAIR,EAAGQ,IAAM,CAGzB,GAFAF,GAAMJ,EACNK,EAAIN,EAAGK,CAAG,EACLR,EAAOS,CAAE,EACb,OAAOA,EAEHA,EAAIF,GAASE,IAAMF,GAAOR,EAAgBU,CAAE,EAChDF,EAAME,GACKA,EAAIH,GAASG,IAAMH,GAAOR,EAAgBW,CAAE,KACvDH,EAAMG,EAER,CACA,OAASH,EAAIC,GAAQ,CACtB,CAKAV,EAAO,QAAUI,IClFjB,IAAAU,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAY,IACZC,EAAU,IAKdF,EAAaC,EAAW,UAAWC,CAAQ,EAK3CH,EAAO,QAAUE,ICcjB,IAAIE,EAAO,QAAS,MAAO,EAAE,KACzBC,EAAa,QAAS,2BAA4B,EAClDC,EAAU,QAAS,yBAA0B,EAC7CC,EAAO,IAKPC,EACAC,EAAMJ,EAAYD,EAAM,UAAW,aAAc,CAAE,EAClDE,EAASG,CAAI,EACjBD,EAAYD,EAEZC,EAAYC,EAMb,OAAO,QAAUD", - "names": ["require_dmidrange", "__commonJSMin", "exports", "module", "isPositiveZero", "isNegativeZero", "isnan", "dmidrange", "N", "x", "stride", "max", "min", "ix", "v", "i", "require_ndarray", "__commonJSMin", "exports", "module", "isPositiveZero", "isNegativeZero", "isnan", "dmidrange", "N", "x", "stride", "offset", "max", "min", "ix", "v", "i", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "dmidrange", "ndarray", "join", "tryRequire", "isError", "main", "dmidrange", "tmp"] + "sources": ["../lib/ndarray.js", "../lib/dmidrange.js", "../lib/main.js", "../lib/index.js"], + "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' );\nvar isNegativeZero = require( '@stdlib/math-base-assert-is-negative-zero' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\n\n\n// MAIN //\n\n/**\n* Computes the mid-range of a double-precision floating-point strided array.\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {Float64Array} x - input array\n* @param {integer} strideX - stride length\n* @param {NonNegativeInteger} offsetX - starting index\n* @returns {number} mid-range\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );\n*\n* var v = dmidrange( 4, x, 2, 1 );\n* // returns 1.0\n*/\nfunction dmidrange( N, x, strideX, offsetX ) {\n\tvar max;\n\tvar min;\n\tvar ix;\n\tvar v;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn NaN;\n\t}\n\tif ( N === 1 || strideX === 0 ) {\n\t\treturn x[ offsetX ];\n\t}\n\tix = offsetX;\n\tmin = x[ ix ];\n\tmax = min;\n\tfor ( i = 1; i < N; i++ ) {\n\t\tix += strideX;\n\t\tv = x[ ix ];\n\t\tif ( isnan( v ) ) {\n\t\t\treturn v;\n\t\t}\n\t\tif ( v < min || ( v === min && isNegativeZero( v ) ) ) {\n\t\t\tmin = v;\n\t\t} else if ( v > max || ( v === max && isPositiveZero( v ) ) ) {\n\t\t\tmax = v;\n\t\t}\n\t}\n\treturn ( max+min ) / 2.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar stride2offset = require( '@stdlib/strided-base-stride2offset' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\n/**\n* Computes the mid-range of a double-precision floating-point strided array.\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {Float64Array} x - input array\n* @param {integer} strideX - stride length\n* @returns {number} mid-range\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\n*\n* var v = dmidrange( x.length, x, 1 );\n* // returns 0.0\n*/\nfunction dmidrange( N, x, strideX ) {\n\treturn ndarray( N, x, strideX, stride2offset( N, strideX ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar dmidrange = require( './dmidrange.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( dmidrange, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the mid-range of a double-precision floating-point strided array.\n*\n* @module @stdlib/stats-base-dmidrange\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var dmidrange = require( '@stdlib/stats-base-dmidrange' );\n*\n* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );\n*\n* var v = dmidrange( x.length, x, 1 );\n* // returns 0.0\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var dmidrange = require( '@stdlib/stats-base-dmidrange' );\n*\n* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );\n*\n* var v = dmidrange.ndarray( 4, x, 2, 1 );\n* // returns 1.0\n*/\n\n// MODULES //\n\nvar join = require( 'path' ).join;\nvar tryRequire = require( '@stdlib/utils-try-require' );\nvar isError = require( '@stdlib/assert-is-error' );\nvar main = require( './main.js' );\n\n\n// MAIN //\n\nvar dmidrange;\nvar tmp = tryRequire( join( __dirname, './native.js' ) );\nif ( isError( tmp ) ) {\n\tdmidrange = main;\n} else {\n\tdmidrange = tmp;\n}\n\n\n// EXPORTS //\n\nmodule.exports = dmidrange;\n\n// exports: { \"ndarray\": \"dmidrange.ndarray\" }\n"], + "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,2CAA4C,EACtEC,EAAiB,QAAS,2CAA4C,EACtEC,EAAQ,QAAS,iCAAkC,EAsBvD,SAASC,EAAWC,EAAGC,EAAGC,EAASC,EAAU,CAC5C,IAAIC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKR,GAAK,EACT,MAAO,KAER,GAAKA,IAAM,GAAKE,IAAY,EAC3B,OAAOD,EAAGE,CAAQ,EAKnB,IAHAG,EAAKH,EACLE,EAAMJ,EAAGK,CAAG,EACZF,EAAMC,EACAG,EAAI,EAAGA,EAAIR,EAAGQ,IAAM,CAGzB,GAFAF,GAAMJ,EACNK,EAAIN,EAAGK,CAAG,EACLR,EAAOS,CAAE,EACb,OAAOA,EAEHA,EAAIF,GAASE,IAAMF,GAAOR,EAAgBU,CAAE,EAChDF,EAAME,GACKA,EAAIH,GAASG,IAAMH,GAAOR,EAAgBW,CAAE,KACvDH,EAAMG,EAER,CACA,OAASH,EAAIC,GAAQ,CACtB,CAKAV,EAAO,QAAUI,IChFjB,IAAAU,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAU,IAqBd,SAASC,EAAWC,EAAGC,EAAGC,EAAU,CACnC,OAAOJ,EAASE,EAAGC,EAAGC,EAASL,EAAeG,EAAGE,CAAQ,CAAE,CAC5D,CAKAN,EAAO,QAAUG,ICnDjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAY,IACZC,EAAU,IAKdF,EAAaC,EAAW,UAAWC,CAAQ,EAK3CH,EAAO,QAAUE,ICajB,IAAIE,EAAO,QAAS,MAAO,EAAE,KACzBC,EAAa,QAAS,2BAA4B,EAClDC,EAAU,QAAS,yBAA0B,EAC7CC,EAAO,IAKPC,EACAC,EAAMJ,EAAYD,EAAM,UAAW,aAAc,CAAE,EAClDE,EAASG,CAAI,EACjBD,EAAYD,EAEZC,EAAYC,EAMb,OAAO,QAAUD", + "names": ["require_ndarray", "__commonJSMin", "exports", "module", "isPositiveZero", "isNegativeZero", "isnan", "dmidrange", "N", "x", "strideX", "offsetX", "max", "min", "ix", "v", "i", "require_dmidrange", "__commonJSMin", "exports", "module", "stride2offset", "ndarray", "dmidrange", "N", "x", "strideX", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "dmidrange", "ndarray", "join", "tryRequire", "isError", "main", "dmidrange", "tmp"] } diff --git a/docs/repl.txt b/docs/repl.txt index fa39c81..0ed0c13 100644 --- a/docs/repl.txt +++ b/docs/repl.txt @@ -1,8 +1,8 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the mid-range of a double-precision floating-point strided array. - The `N` and `stride` parameters determine which elements in `x` are accessed + The `N` and stride parameters determine which elements in `x` are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed @@ -18,8 +18,8 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. Returns ------- @@ -33,22 +33,19 @@ > {{alias}}( x.length, x, 1 ) 0.0 - // 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 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 3, x, 2 ) 0.0 // 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 ); - > stride = 2; - > {{alias}}( N, x1, stride ) + > {{alias}}( 3, x1, 2 ) 0.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the mid-range of a double-precision floating-point strided array using alternative indexing semantics. @@ -64,10 +61,10 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. - offset: integer + offsetX: integer Starting index. Returns @@ -84,8 +81,7 @@ // 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 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) 0.0 See Also diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index b16229f..3f19372 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -27,7 +27,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns mid-range * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = dmidrange( x.length, x, 1 ); * // returns 0.0 */ - ( N: number, x: Float64Array, stride: number ): number; + ( N: number, x: Float64Array, strideX: number ): number; /** * Computes the mid-range of a double-precision floating-point strided array using alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns mid-range * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = dmidrange.ndarray( x.length, x, 1, 0 ); * // returns 0.0 */ - ndarray( N: number, x: Float64Array, stride: number, offset: number ): number; + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number; } /** @@ -65,7 +65,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns mid-range * * @example diff --git a/examples/c/example.c b/examples/c/example.c index ba1b297..766ea11 100644 --- a/examples/c/example.c +++ b/examples/c/example.c @@ -17,21 +17,20 @@ */ #include "stdlib/stats/base/dmidrange.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 }; // Specify the number of elements: - int64_t N = 4; + const int N = 4; // Specify the stride length: - int64_t stride = 2; + const int strideX = 2; // Compute the mid-range: - double v = stdlib_strided_dmidrange( N, x, stride ); + double v = stdlib_strided_dmidrange( N, x, strideX ); // Print the result: printf( "mid-range: %lf\n", v ); diff --git a/examples/index.js b/examples/index.js index 7b28c6a..a8fdbec 100644 --- a/examples/index.js +++ b/examples/index.js @@ -18,18 +18,12 @@ 'use strict'; -var randu = require( '@stdlib/random-base-randu' ); -var round = require( '@stdlib/math-base-special-round' ); -var Float64Array = require( '@stdlib/array-float64' ); +var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var dmidrange = require( './../lib' ); -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 ); var v = dmidrange( x.length, x, 1 ); diff --git a/include.gypi b/include.gypi index 2fa318f..9212937 100644 --- a/include.gypi +++ b/include.gypi @@ -36,7 +36,7 @@ # Source files: 'src_files': [ - '<(src_dir)/addon.cpp', + '<(src_dir)/addon.c', ' +#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 mid-range of a double-precision floating-point strided array. */ -double stdlib_strided_dmidrange( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dmidrange)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Computes the mid-range of a double-precision floating-point strided array and using alternative indexing semantics. +*/ +double API_SUFFIX(stdlib_strided_dmidrange_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/dmidrange.js b/lib/dmidrange.js index 0aa54d4..50920d3 100644 --- a/lib/dmidrange.js +++ b/lib/dmidrange.js @@ -20,9 +20,8 @@ // MODULES // -var isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' ); -var isNegativeZero = require( '@stdlib/math-base-assert-is-negative-zero' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); +var stride2offset = require( '@stdlib/strided-base-stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -32,7 +31,7 @@ var isnan = require( '@stdlib/math-base-assert-is-nan' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} mid-range * * @example @@ -43,39 +42,8 @@ var isnan = require( '@stdlib/math-base-assert-is-nan' ); * var v = dmidrange( x.length, x, 1 ); * // returns 0.0 */ -function dmidrange( N, x, stride ) { - var max; - var min; - var ix; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - min = x[ ix ]; - max = min; - for ( i = 1; i < N; i++ ) { - ix += stride; - v = x[ ix ]; - if ( isnan( v ) ) { - return v; - } - if ( v < min || ( v === min && isNegativeZero( v ) ) ) { - min = v; - } else if ( v > max || ( v === max && isPositiveZero( v ) ) ) { - max = v; - } - } - return ( max+min ) / 2.0; +function dmidrange( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/dmidrange.native.js b/lib/dmidrange.native.js index 12d9cca..75f7940 100644 --- a/lib/dmidrange.native.js +++ b/lib/dmidrange.native.js @@ -30,7 +30,7 @@ var addon = require( './../src/addon.node' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} mid-range * * @example @@ -41,8 +41,8 @@ var addon = require( './../src/addon.node' ); * var v = dmidrange( x.length, x, 1 ); * // returns 0.0 */ -function dmidrange( N, x, stride ) { - return addon( N, x, stride ); +function dmidrange( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/index.js b/lib/index.js index 58e3acf..2d7ef0e 100644 --- a/lib/index.js +++ b/lib/index.js @@ -38,9 +38,8 @@ * var dmidrange = require( '@stdlib/stats-base-dmidrange' ); * * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = floor( x.length / 2 ); * -* var v = dmidrange.ndarray( N, x, 2, 1 ); +* var v = dmidrange.ndarray( 4, x, 2, 1 ); * // returns 1.0 */ diff --git a/lib/ndarray.js b/lib/ndarray.js index 681270d..ac43166 100644 --- a/lib/ndarray.js +++ b/lib/ndarray.js @@ -32,21 +32,19 @@ var isnan = require( '@stdlib/math-base-assert-is-nan' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} mid-range * * @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 N = floor( x.length / 2 ); * -* var v = dmidrange( N, x, 2, 1 ); +* var v = dmidrange( 4, x, 2, 1 ); * // returns 1.0 */ -function dmidrange( N, x, stride, offset ) { +function dmidrange( N, x, strideX, offsetX ) { var max; var min; var ix; @@ -56,14 +54,14 @@ function dmidrange( N, x, stride, offset ) { if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + if ( N === 1 || strideX === 0 ) { + return x[ offsetX ]; } - ix = offset; + ix = offsetX; min = x[ ix ]; max = min; for ( i = 1; i < N; i++ ) { - ix += stride; + ix += strideX; v = x[ ix ]; if ( isnan( v ) ) { return v; diff --git a/lib/ndarray.native.js b/lib/ndarray.native.js index 0bd14ed..a66ace0 100644 --- a/lib/ndarray.native.js +++ b/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float64Array = require( '@stdlib/array-float64' ); -var addon = require( './dmidrange.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -31,27 +30,20 @@ var addon = require( './dmidrange.native.js' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} mid-range * * @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 N = floor( x.length / 2 ); * -* var v = dmidrange( N, x, 2, 1 ); +* var v = dmidrange( 4, x, 2, 1 ); * // returns 1.0 */ -function dmidrange( N, x, stride, offset ) { - var view; - if ( stride < 0 ) { - offset += (N-1) * stride; - } - view = new Float64Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len - return addon( N, view, stride ); +function dmidrange( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/manifest.json b/manifest.json index 8e769b4..c1e0631 100644 --- a/manifest.json +++ b/manifest.json @@ -1,5 +1,8 @@ { - "options": {}, + "options": { + "task": "build", + "wasm": false + }, "fields": [ { "field": "src", @@ -24,17 +27,81 @@ ], "confs": [ { + "task": "build", + "wasm": false, "src": [ - "./src/dmidrange.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset", + "@stdlib/math-base-assert-is-positive-zero", + "@stdlib/math-base-assert-is-negative-zero", + "@stdlib/math-base-assert-is-nan", + "@stdlib/napi-export", + "@stdlib/napi-argv", + "@stdlib/napi-argv-int64", + "@stdlib/napi-argv-strided-float64array", + "@stdlib/napi-create-double" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset", + "@stdlib/math-base-assert-is-nan", + "@stdlib/math-base-assert-is-positive-zero", + "@stdlib/math-base-assert-is-negative-zero" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset", + "@stdlib/math-base-assert-is-nan", + "@stdlib/math-base-assert-is-positive-zero", + "@stdlib/math-base-assert-is-negative-zero" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset", "@stdlib/math-base-assert-is-nan", "@stdlib/math-base-assert-is-positive-zero", "@stdlib/math-base-assert-is-negative-zero" diff --git a/package.json b/package.json index 9240596..07d89f1 100644 --- a/package.json +++ b/package.json @@ -42,9 +42,16 @@ }, "dependencies": { "@stdlib/assert-is-error": "^0.2.2", + "@stdlib/blas-base-shared": "^0.1.0", "@stdlib/math-base-assert-is-nan": "^0.2.2", "@stdlib/math-base-assert-is-negative-zero": "^0.2.2", "@stdlib/math-base-assert-is-positive-zero": "^0.2.2", + "@stdlib/napi-argv": "^0.2.2", + "@stdlib/napi-argv-int64": "^0.2.2", + "@stdlib/napi-argv-strided-float64array": "^0.2.2", + "@stdlib/napi-create-double": "^0.0.2", + "@stdlib/napi-export": "^0.2.2", + "@stdlib/strided-base-stride2offset": "^0.1.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/utils-library-manifest": "^0.2.2", "@stdlib/utils-try-require": "^0.2.2" @@ -52,10 +59,9 @@ "devDependencies": { "@stdlib/array-float64": "^0.2.2", "@stdlib/assert-is-browser": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/math-base-special-round": "^0.3.0", - "@stdlib/random-base-randu": "^0.2.1", + "@stdlib/random-array-discrete-uniform": "^0.2.1", + "@stdlib/random-array-uniform": "^0.2.1", "proxyquire": "^2.0.0", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", diff --git a/src/addon.c b/src/addon.c new file mode 100644 index 0000000..583115c --- /dev/null +++ b/src/addon.c @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/stats/base/dmidrange.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_float64array.h" +#include "stdlib/napi/create_double.h" +#include + +/** +* 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( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dmidrange( N, X, strideX ), v ); + return v; +} + +/** +* 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, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, stdlib_strided_dmidrange_ndarray( N, X, strideX, offsetX ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/src/addon.cpp b/src/addon.cpp deleted file mode 100644 index 4575827..0000000 --- a/src/addon.cpp +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ - -#include "stdlib/stats/base/dmidrange.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_stats_base_dmidrange { - - /** - * Computes the mid-range of a double-precision floating-point strided array. - * - * ## Notes - * - * - When called from JavaScript, the function expects three arguments: - * - * - `N`: number of indexed elements - * - `X`: input array - * - `stride`: stride length - */ - napi_value node_dmidrange( napi_env env, napi_callback_info info ) { - napi_status status; - - size_t argc = 3; - napi_value argv[ 3 ]; - status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); - assert( status == napi_ok ); - - if ( argc < 3 ) { - napi_throw_error( env, nullptr, "invalid invocation. Must provide 3 arguments." ); - return nullptr; - } - - napi_valuetype vtype0; - status = napi_typeof( env, argv[ 0 ], &vtype0 ); - assert( status == napi_ok ); - if ( vtype0 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. First argument must be a number." ); - return nullptr; - } - - bool res; - status = napi_is_typedarray( env, argv[ 1 ], &res ); - assert( status == napi_ok ); - if ( res == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float64Array." ); - return nullptr; - } - - napi_valuetype vtype2; - status = napi_typeof( env, argv[ 2 ], &vtype2 ); - assert( status == napi_ok ); - if ( vtype2 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a number." ); - return nullptr; - } - - int64_t N; - status = napi_get_value_int64( env, argv[ 0 ], &N ); - assert( status == napi_ok ); - - int64_t stride; - status = napi_get_value_int64( env, argv[ 2 ], &stride ); - assert( status == napi_ok ); - - napi_typedarray_type vtype1; - size_t xlen; - void *X; - status = napi_get_typedarray_info( env, argv[ 1 ], &vtype1, &xlen, &X, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype1 != napi_float64_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float64Array." ); - return nullptr; - } - if ( (N-1)*llabs(stride) >= (int64_t)xlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Second argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - napi_value v; - status = napi_create_double( env, stdlib_strided_dmidrange( N, (double *)X, stride ), &v ); - assert( status == napi_ok ); - - return v; - } - - napi_value Init( napi_env env, napi_value exports ) { - napi_status status; - napi_value fcn; - status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, node_dmidrange, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_stats_base_dmidrange diff --git a/src/dmidrange.c b/src/main.c similarity index 55% rename from src/dmidrange.c rename to src/main.c index 717ea2e..d6064ec 100644 --- a/src/dmidrange.c +++ b/src/main.c @@ -20,38 +20,49 @@ #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/assert/is_positive_zero.h" #include "stdlib/math/base/assert/is_negative_zero.h" -#include +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" /** * Computes the mid-range of a double-precision floating-point strided array. * -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value */ -double stdlib_strided_dmidrange( const int64_t N, const double *X, const int64_t stride ) { +double API_SUFFIX(stdlib_strided_dmidrange)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_dmidrange_ndarray)( N, X, strideX, ox ); +} + +/** +* Computes the mid-range of a double-precision floating-point strided array and using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param offsetX starting index for X +* @return output value +*/ +double API_SUFFIX(stdlib_strided_dmidrange_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; double max; double min; - int64_t ix; - int64_t i; double v; if ( N <= 0 ) { return 0.0 / 0.0; // NaN } - if ( N == 1 || stride == 0 ) { - return X[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; + if ( N == 1 || strideX == 0 ) { + return X[ offsetX ]; } + ix = offsetX; min = X[ ix ]; max = min; for ( i = 1; i < N; i++ ) { - ix += stride; + ix += strideX; v = X[ ix ]; if ( stdlib_base_is_nan( v ) ) { return v; diff --git a/test/test.dmidrange.js b/test/test.dmidrange.js index 15e396c..7b5dd50 100644 --- a/test/test.dmidrange.js +++ b/test/test.dmidrange.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math-base-special-floor' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' ); var Float64Array = require( '@stdlib/array-float64' ); @@ -101,7 +100,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -116,15 +114,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, 2 ); + v = dmidrange( 4, x, 2 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -139,8 +135,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, -2 ); + v = dmidrange( 4, x, -2 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); @@ -166,7 +161,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -182,9 +176,8 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = dmidrange( N, x1, 2 ); + v = dmidrange( 4, x1, 2 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); diff --git a/test/test.dmidrange.native.js b/test/test.dmidrange.native.js index 7ab781a..5d346ac 100644 --- a/test/test.dmidrange.native.js +++ b/test/test.dmidrange.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math-base-special-floor' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' ); var Float64Array = require( '@stdlib/array-float64' ); @@ -110,7 +109,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -125,15 +123,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, 2 ); + v = dmidrange( 4, x, 2 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -148,8 +144,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, -2 ); + v = dmidrange( 4, x, -2 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); @@ -175,7 +170,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', opts, function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -191,9 +185,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 - N = floor(x1.length / 2); - v = dmidrange( N, x1, 2 ); + v = dmidrange( 4, x1, 2 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); diff --git a/test/test.ndarray.js b/test/test.ndarray.js index dd7809d..fbfc2f3 100644 --- a/test/test.ndarray.js +++ b/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math-base-special-floor' ); var isnan = require( '@stdlib/math-base-assert-is-nan' ); var isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' ); var Float64Array = require( '@stdlib/array-float64' ); @@ -101,7 +100,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -116,15 +114,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, 2, 0 ); + v = dmidrange( 4, x, 2, 0 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -139,8 +135,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, -2, 6 ); + v = dmidrange( 4, x, -2, 6 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); @@ -164,7 +159,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -178,9 +172,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, 2, 1 ); + v = dmidrange( 4, x, 2, 1 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); diff --git a/test/test.ndarray.native.js b/test/test.ndarray.native.js index 2f16ecb..0f47d09 100644 --- a/test/test.ndarray.native.js +++ b/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 isnan = require( '@stdlib/math-base-assert-is-nan' ); var isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' ); var Float64Array = require( '@stdlib/array-float64' ); @@ -110,7 +109,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -125,15 +123,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, 2, 0 ); + v = dmidrange( 4, x, 2, 0 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -148,8 +144,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, -2, 6 ); + v = dmidrange( 4, x, -2, 6 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end(); @@ -173,7 +168,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', opts, function test( t ) { - var N; var x; var v; @@ -187,9 +181,8 @@ tape( 'the function supports an `offset` parameter', opts, function test( t ) { 3.0, 4.0 // 3 ]); - N = floor( x.length / 2 ); - v = dmidrange( N, x, 2, 1 ); + v = dmidrange( 4, x, 2, 1 ); t.strictEqual( v, 1.0, 'returns expected value' ); t.end();