diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 8e01774..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-11-01T04:08:33.767Z diff --git a/.github/workflows/test_published_package.yml b/.github/workflows/test_published_package.yml new file mode 100644 index 0000000..eb42e54 --- /dev/null +++ b/.github/workflows/test_published_package.yml @@ -0,0 +1,105 @@ +#/ +# @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. +#/ + +# Workflow name: +name: test_published_package + +# Workflow triggers: +on: + # Run workflow on a weekly schedule: + schedule: + # * is a special character in YAML so you have to quote this string + - cron: '4 4 * * 3' + + # Run workflow upon completion of `publish` workflow run: + workflow_run: + workflows: ["publish"] + types: [completed] + + # Allow workflow to be manually run: + workflow_dispatch: + +# Workflow jobs: +jobs: + test-published: + # Define a display name: + name: 'Test running examples of published package' + + # Define the type of virtual host machine: + runs-on: ubuntu-latest + + # Define environment variables: + env: + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} + + # Run workflow job if `publish` workflow run is successful or when the workflow is manually run: + if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }} + + # Define the job's steps: + steps: + # Checkout the repository: + - name: 'Checkout repository' + uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 + + # Install Node.js: + - name: 'Install Node.js' + uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 + with: + node-version: 20 + timeout-minutes: 5 + + # Create test directory and run examples: + - name: 'Create test directory and run examples' + run: | + cd .. + mkdir test-published + cd test-published + + # Copy example file: + cp $GITHUB_WORKSPACE/examples/index.js . + + # Create a minimal package.json + echo '{ + "name": "test-published", + "version": "1.0.0", + "main": "index.js", + "dependencies": {} + }' > package.json + + # Get package name and modify example file: + PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json) + ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g') + + sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js + + # Extract and install dependencies: + DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.") + for dep in $DEPS; do + npm install $dep --save + done + + # Run the example: + node index.js + + # Send Slack notification if job fails: + - name: 'Send notification to Slack in case of failure' + uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 + with: + status: ${{ job.status }} + channel: '#npm-ci' + if: failure() diff --git a/CHANGELOG.md b/CHANGELOG.md index e6256be..c179f4b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,17 @@
-## Unreleased (2024-11-01) +## Unreleased (2024-11-21) + +
+ +### Features + +- [`14021a5`](https://github.com/stdlib-js/stdlib/commit/14021a537b3f627a4ff0b3228b78d0433a6eb562) - add C `ndarray` API and refactor `blas/ext/base/dnansumpw` [(#3202)](https://github.com/stdlib-js/stdlib/pull/3202) + +
+ +
@@ -12,6 +22,7 @@
+- [`14021a5`](https://github.com/stdlib-js/stdlib/commit/14021a537b3f627a4ff0b3228b78d0433a6eb562) - **feat:** add C `ndarray` API and refactor `blas/ext/base/dnansumpw` [(#3202)](https://github.com/stdlib-js/stdlib/pull/3202) _(by Muhammad Haris)_ - [`272ae7a`](https://github.com/stdlib-js/stdlib/commit/272ae7ac5c576c68cfab1b6e304c86407faa20cd) - **docs:** remove comment _(by Athan Reines)_ - [`2777e4b`](https://github.com/stdlib-js/stdlib/commit/2777e4be161869d09406e3b17947d24c64b47af2) - **bench:** resolve lint errors in benchmarks _(by Athan Reines)_ @@ -25,9 +36,10 @@ ### Contributors -A total of 1 person contributed to this release. Thank you to this contributor: +A total of 2 people contributed to this release. Thank you to the following contributors: - Athan Reines +- Muhammad Haris
diff --git a/CONTRIBUTORS b/CONTRIBUTORS index c9f811c..f09b30e 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -59,6 +59,7 @@ Mohammad Kaif <98884589+Kaif987@users.noreply.github.com> Momtchil Momtchev Muhammad Haris Naresh Jagadeesan +Neeraj Pathak NightKnight Nithin Katta <88046362+nithinkatta@users.noreply.github.com> Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com> @@ -69,6 +70,7 @@ Prajwal Kulkarni Pranav Goswami Praneki <97080887+PraneGIT@users.noreply.github.com> Pratik <97464067+Pratik772846@users.noreply.github.com> +Pratyush Kumar Chouhan Priyansh <88396544+itsspriyansh@users.noreply.github.com> Pushpendra Chandravanshi RISHAV <115060907+rishav2404@users.noreply.github.com> @@ -79,9 +81,11 @@ Ridam Garg <67867319+RidamGarg@users.noreply.github.com> Robert Gislason Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com> Rutam <138517416+performant23@users.noreply.github.com> +Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com> Ryan Seal Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com> SarthakPaandey <145528240+SarthakPaandey@users.noreply.github.com> +Saurabh Singh Seyyed Parsa Neshaei Shashank Shekhar Singh Shivam <11shivam00@gmail.com> diff --git a/README.md b/README.md index 73bf072..3f6d27a 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ To view installation and usage instructions specific to each branch build, be su var dnansumpw = require( '@stdlib/blas-ext-base-dnansumpw' ); ``` -#### dnansumpw( N, x, stride ) +#### dnansumpw( N, x, strideX ) Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation. @@ -77,9 +77,8 @@ Computes the sum of double-precision floating-point strided array elements, igno var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = dnansumpw( N, x, 1 ); +var v = dnansumpw( x.length, x, 1 ); // returns 1.0 ``` @@ -87,9 +86,9 @@ 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 the strided array are accessed at runtime. For example, to compute the sum 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 sum of every other element: ```javascript var Float64Array = require( '@stdlib/array-float64' ); @@ -114,7 +113,7 @@ var v = dnansumpw( 4, x1, 2 ); // returns 5.0 ``` -#### dnansumpw.ndarray( N, x, stride, offset ) +#### dnansumpw.ndarray( N, x, strideX, offsetX ) Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation and alternative indexing semantics. @@ -123,15 +122,15 @@ var Float64Array = require( '@stdlib/array-float64' ); var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var v = dnansumpw.ndarray( 4, x, 1, 0 ); +var v = dnansumpw.ndarray( x.length, x, 1, 0 ); // returns 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 sum of 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 sum of every other element starting from the second element: ```javascript var Float64Array = require( '@stdlib/array-float64' ); @@ -169,14 +168,14 @@ var bernoulli = require( '@stdlib/random-base-bernoulli' ); var filledarrayBy = require( '@stdlib/array-filled-by' ); var dnansumpw = require( '@stdlib/blas-ext-base-dnansumpw' ); -function clbk() { +function rand() { if ( bernoulli( 0.7 ) > 0 ) { return discreteUniform( 0, 100 ); } return NaN; } -var x = filledarrayBy( 10, 'float64', clbk ); +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = dnansumpw( x.length, x, 1 ); @@ -187,8 +186,123 @@ console.log( v ); + + * * * +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/dnansumpw.h" +``` + +#### stdlib_strided_dnansumpw( N, \*X, strideX ) + +Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation. + +```c +const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 }; + +double v = stdlib_strided_dnansumpw( 4, x, 1 ); +// returns 7.0 +``` + +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_dnansumpw( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnansumpw_ndarray( N, \*X, strideX, offsetX ) + +Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation and alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 }; + +double v = stdlib_strided_dnansumpw_ndarray( 4, x, 1, 0 ); +// returns 7.0 +``` + +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_dnansumpw_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/dnansumpw.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, 0.0/0.0, 0.0/0.0 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride length: + const int strideX = 2; + + // Compute the sum: + double v = stdlib_strided_dnansumpw( N, x, strideX ); + + // Print the result: + printf( "sum: %lf\n", v ); +} +``` + +
+ + + +
+ + +
## References diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js index edea026..bcc2d78 100644 --- a/benchmark/benchmark.js +++ b/benchmark/benchmark.js @@ -32,6 +32,19 @@ var dnansumpw = require( './../lib/dnansumpw.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) > 0 ) { + return uniform( -10.0, 10.0 ); + } + return NaN; +} + /** * Creates a benchmark function. * @@ -40,16 +53,9 @@ var dnansumpw = require( './../lib/dnansumpw.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', clbk ); + var x = filledarrayBy( len, 'float64', rand ); return benchmark; - function clbk() { - if ( bernoulli( 0.7 ) > 0 ) { - return uniform( -100.0, 100.0 ); - } - return NaN; - } - function benchmark( b ) { var v; var i; diff --git a/benchmark/benchmark.native.js b/benchmark/benchmark.native.js index 34c4e1a..aab8ef4 100644 --- a/benchmark/benchmark.native.js +++ b/benchmark/benchmark.native.js @@ -41,6 +41,19 @@ var opts = { // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) > 0 ) { + return uniform( -10.0, 10.0 ); + } + return NaN; +} + /** * Creates a benchmark function. * @@ -49,16 +62,9 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', clbk ); + var x = filledarrayBy( len, 'float64', rand ); return benchmark; - function clbk() { - if ( bernoulli( 0.7 ) > 0 ) { - return uniform( -100.0, 100.0 ); - } - return NaN; - } - function benchmark( b ) { var v; var i; diff --git a/benchmark/benchmark.ndarray.js b/benchmark/benchmark.ndarray.js index 21d8a50..d2e5946 100644 --- a/benchmark/benchmark.ndarray.js +++ b/benchmark/benchmark.ndarray.js @@ -32,6 +32,19 @@ var dnansumpw = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) > 0 ) { + return uniform( -10.0, 10.0 ); + } + return NaN; +} + /** * Creates a benchmark function. * @@ -40,16 +53,9 @@ var dnansumpw = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', clbk ); + var x = filledarrayBy( len, 'float64', rand ); return benchmark; - function clbk() { - if ( bernoulli( 0.7 ) > 0 ) { - return uniform( -100.0, 100.0 ); - } - return NaN; - } - function benchmark( b ) { var v; var i; diff --git a/benchmark/benchmark.ndarray.native.js b/benchmark/benchmark.ndarray.native.js index b6fe11a..7e668a5 100644 --- a/benchmark/benchmark.ndarray.native.js +++ b/benchmark/benchmark.ndarray.native.js @@ -41,6 +41,19 @@ var opts = { // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) > 0 ) { + return uniform( -10.0, 10.0 ); + } + return NaN; +} + /** * Creates a benchmark function. * @@ -49,16 +62,9 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float64', clbk ); + var x = filledarrayBy( len, 'float64', rand ); return benchmark; - function clbk() { - if ( bernoulli( 0.7 ) > 0 ) { - return uniform( -100.0, 100.0 ); - } - return NaN; - } - function benchmark( b ) { var v; var i; diff --git a/benchmark/c/benchmark.length.c b/benchmark/c/benchmark.length.c index 47b7439..acd164f 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; @@ -111,6 +111,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_dnansumpw( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -124,6 +125,44 @@ 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++ ) { + if ( rand_double() < 0.2 ) { + x[ i ] = 0.0 / 0.0; // NaN + } else { + 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_dnansumpw_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. */ @@ -146,7 +185,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 bdfd883..e38e26d 100644 --- a/dist/index.js +++ b/dist/index.js @@ -1,9 +1,9 @@ -"use strict";var j=function(u,a){return function(){return a||u((a={exports:{}}).exports,a),a.exports}};var E=j(function(J,_){ -var v=require('@stdlib/math-base-assert-is-nan/dist'),Z=require('@stdlib/math-base-special-floor/dist'),b=128;function t(u,a,n,e){var r,i,s,p,m,l,c,w,y,R,o,q,f;if(u<=0)return 0;if(u===1||n===0)return v(a[e])?0:a[e];if(r=e,u<8){for(o=0,f=0;f {{alias}}( x.length, x, 1 ) 1.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, NaN, NaN ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 4, x, 2 ) 1.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); > 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}}( 4, x1, 2 ) -1.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation and alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -66,10 +63,10 @@ x: Float64Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -86,8 +83,7 @@ // Using offset parameter: > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 4, x, 2, 1 ) -1.0 See Also diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 0d46b4b..e73a62b 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 sum * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = dnansumpw( x.length, x, 1 ); * // returns 1.0 */ - ( N: number, x: Float64Array, stride: number ): number; + ( N: number, x: Float64Array, strideX: number ): number; /** * Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation and 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 sum * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = dnansumpw.ndarray( x.length, x, 1, 0 ); * // returns 1.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 sum * * @example diff --git a/examples/c/example.c b/examples/c/example.c index d85c4d3..68ae6c0 100644 --- a/examples/c/example.c +++ b/examples/c/example.c @@ -17,7 +17,6 @@ */ #include "stdlib/blas/ext/base/dnansumpw.h" -#include #include int main( void ) { @@ -25,13 +24,13 @@ int main( void ) { const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; // Specify the number of elements: - const int64_t N = 5; + const int N = 5; // Specify the stride length: - const int64_t stride = 2; + const int strideX = 2; // Compute the sum: - double v = stdlib_strided_dnansumpw( N, x, stride ); + double v = stdlib_strided_dnansumpw( N, x, strideX ); // Print the result: printf( "sum: %lf\n", v ); diff --git a/examples/index.js b/examples/index.js index 51c5598..b38d782 100644 --- a/examples/index.js +++ b/examples/index.js @@ -23,14 +23,14 @@ var bernoulli = require( '@stdlib/random-base-bernoulli' ); var filledarrayBy = require( '@stdlib/array-filled-by' ); var dnansumpw = require( './../lib' ); -function clbk() { +function rand() { if ( bernoulli( 0.7 ) > 0 ) { return discreteUniform( -100, 100 ); } return NaN; } -var x = filledarrayBy( 10, 'float64', clbk ); +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = dnansumpw( x.length, x, 1 ); diff --git a/include/stdlib/blas/ext/base/dnansumpw.h b/include/stdlib/blas/ext/base/dnansumpw.h index f921e9f..a8b93f7 100644 --- a/include/stdlib/blas/ext/base/dnansumpw.h +++ b/include/stdlib/blas/ext/base/dnansumpw.h @@ -19,7 +19,7 @@ #ifndef STDLIB_BLAS_EXT_BASE_DNANSUMPW_H #define STDLIB_BLAS_EXT_BASE_DNANSUMPW_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 sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation. */ -double stdlib_strided_dnansumpw( const int64_t N, const double *X, const int64_t stride ); +double API_SUFFIX(stdlib_strided_dnansumpw)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation and alternative indexing semantics. +*/ +double API_SUFFIX(stdlib_strided_dnansumpw_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/dnansumpw.js b/lib/dnansumpw.js index 93cb486..3f8360b 100644 --- a/lib/dnansumpw.js +++ b/lib/dnansumpw.js @@ -20,8 +20,8 @@ // MODULES // -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var sum = require( './ndarray.js' ); +var stride2offset = require( '@stdlib/strided-base-stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -39,49 +39,19 @@ var sum = require( './ndarray.js' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var Float64Array = require( '@stdlib/array-float64' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = dnansumpw( N, x, 1 ); +* var v = dnansumpw( x.length, x, 1 ); * // returns 1.0 */ -function dnansumpw( N, x, stride ) { - var ix; - var s; - var i; - - if ( N <= 0 ) { - return 0.0; - } - if ( N === 1 || stride === 0 ) { - if ( isnan( x[ 0 ] ) ) { - return 0.0; - } - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - if ( N < 8 ) { - // Use simple summation... - s = 0.0; - for ( i = 0; i < N; i++ ) { - if ( isnan( x[ ix ] ) === false ) { - s += x[ ix ]; - } - ix += stride; - } - return s; - } - return sum( N, x, stride, ix ); +function dnansumpw( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/dnansumpw.native.js b/lib/dnansumpw.native.js index 2acd5af..1276fc9 100644 --- a/lib/dnansumpw.native.js +++ b/lib/dnansumpw.native.js @@ -30,20 +30,19 @@ 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} sum * * @example * var Float64Array = require( '@stdlib/array-float64' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = dnansumpw( N, x, 1 ); +* var v = dnansumpw( x.length, x, 1 ); * // returns 1.0 */ -function dnansumpw( N, x, stride ) { - return addon( N, x, stride ); +function dnansumpw( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/index.js b/lib/index.js index 54f4585..98b0573 100644 --- a/lib/index.js +++ b/lib/index.js @@ -28,9 +28,8 @@ * var dnansumpw = require( '@stdlib/blas-ext-base-dnansumpw' ); * * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = dnansumpw( N, x, 1 ); +* var v = dnansumpw( x.length, x, 1 ); * // returns 1.0 * * @example diff --git a/lib/ndarray.js b/lib/ndarray.js index 810d00c..7d4414c 100644 --- a/lib/ndarray.js +++ b/lib/ndarray.js @@ -45,8 +45,8 @@ var BLOCKSIZE = 128; * * @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} sum * * @example @@ -57,7 +57,7 @@ var BLOCKSIZE = 128; * var v = dnansumpw( 5, x, 2, 1 ); * // returns 5.0 */ -function dnansumpw( N, x, stride, offset ) { +function dnansumpw( N, x, strideX, offsetX ) { var ix; var s0; var s1; @@ -75,13 +75,13 @@ function dnansumpw( N, x, stride, offset ) { if ( N <= 0 ) { return 0.0; } - if ( N === 1 || stride === 0 ) { - if ( isnan( x[ offset ] ) ) { + if ( strideX === 0 ) { + if ( isnan( x[ offsetX ] ) ) { return 0.0; } - return x[ offset ]; + return x[ offsetX ] * N; } - ix = offset; + ix = offsetX; if ( N < 8 ) { // Use simple summation... s = 0.0; @@ -89,64 +89,64 @@ function dnansumpw( N, x, stride, offset ) { if ( isnan( x[ ix ] ) === false ) { s += x[ ix ]; } - ix += stride; + ix += strideX; } return s; } if ( N <= BLOCKSIZE ) { // Sum a block with 8 accumulators (by loop unrolling, we lower the effective blocksize to 16)... s0 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s1 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s2 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s3 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s4 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s5 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s6 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s7 = ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; M = N % 8; for ( i = 8; i < N-M; i += 8 ) { s0 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s1 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s2 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s3 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s4 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s5 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s6 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; s7 += ( isnan( x[ ix ] ) ) ? 0.0 : x[ ix ]; - ix += stride; + ix += strideX; } // Pairwise sum the accumulators: - s = ((s0+s1) + (s2+s3)) + ((s4+s5) + (s6+s7)); + s = ( (s0+s1) + (s2+s3)) + ((s4+s5) + (s6+s7) ); // Clean-up loop... for ( i; i < N; i++ ) { if ( isnan( x[ ix ] ) === false ) { s += x[ ix ]; } - ix += stride; + ix += strideX; } return s; } // Recurse by dividing by two, but avoiding non-multiples of unroll factor... n = floor( N/2 ); n -= n % 8; - return dnansumpw( n, x, stride, ix ) + dnansumpw( N-n, x, stride, ix+(n*stride) ); // eslint-disable-line max-len + return dnansumpw( n, x, strideX, ix ) + dnansumpw( N-n, x, strideX, ix+(n*strideX) ); // eslint-disable-line max-len } diff --git a/lib/ndarray.native.js b/lib/ndarray.native.js index ca2fc49..3df51cd 100644 --- a/lib/ndarray.native.js +++ b/lib/ndarray.native.js @@ -20,9 +20,7 @@ // MODULES // -var minViewBufferIndex = require( '@stdlib/strided-base-min-view-buffer-index' ); -var offsetView = require( '@stdlib/strided-base-offset-view' ); -var addon = require( './dnansumpw.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -32,8 +30,8 @@ var addon = require( './dnansumpw.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} sum * * @example @@ -44,11 +42,8 @@ var addon = require( './dnansumpw.native.js' ); * var v = dnansumpw( 5, x, 2, 1 ); * // returns 5.0 */ -function dnansumpw( N, x, stride, offset ) { - var view; - offset = minViewBufferIndex( N, stride, offset ); - view = offsetView( x, offset ); - return addon( N, view, stride ); +function dnansumpw( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/manifest.json b/manifest.json index 16545b4..80ab315 100644 --- a/manifest.json +++ b/manifest.json @@ -27,36 +27,55 @@ "confs": [ { "task": "build", - "src": ["./src/dnansumpw.c"], - "include": ["./include"], - "libraries": ["-lm"], + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/math-base-assert-is-nan", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", - "@stdlib/napi-argv-strided-float64array" + "@stdlib/napi-argv-strided-float64array", + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset", + "@stdlib/napi-create-double" ] }, { "task": "benchmark", - "src": ["./src/dnansumpw.c"], - "include": ["./include"], - "libraries": ["-lm"], + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math-base-assert-is-nan" + "@stdlib/math-base-assert-is-nan", + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset" ] }, { "task": "examples", - "src": ["./src/dnansumpw.c"], - "include": ["./include"], - "libraries": ["-lm"], + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/math-base-assert-is-nan" + "@stdlib/math-base-assert-is-nan", + "@stdlib/blas-base-shared", + "@stdlib/strided-base-stride2offset" ] } ] diff --git a/package.json b/package.json index 217401d..1045126 100644 --- a/package.json +++ b/package.json @@ -42,12 +42,15 @@ }, "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-special-floor": "^0.2.3", "@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" @@ -60,8 +63,6 @@ "@stdlib/random-base-bernoulli": "^0.2.1", "@stdlib/random-base-discrete-uniform": "^0.2.1", "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/strided-base-min-view-buffer-index": "^0.2.2", - "@stdlib/strided-base-offset-view": "^0.2.2", "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 index 10126a6..763abb6 100644 --- a/src/addon.c +++ b/src/addon.c @@ -17,12 +17,13 @@ */ #include "stdlib/blas/ext/base/dnansumpw.h" +#include "stdlib/blas/base/shared.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 -#include /** * Receives JavaScript callback invocation data. @@ -36,12 +37,25 @@ static napi_value addon( napi_env env, napi_callback_info info ) { 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, API_SUFFIX(stdlib_strided_dnansumpw)( N, X, strideX ), v ); + return v; +} - napi_value v; - napi_status status = napi_create_double( env, stdlib_strided_dnansumpw( N, X, strideX ), &v ); - assert( status == napi_ok ); - +/** +* 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, API_SUFFIX(stdlib_strided_dnansumpw_ndarray)( N, X, strideX, offsetX ), v ); return v; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/src/dnansumpw.c b/src/main.c similarity index 73% rename from src/dnansumpw.c rename to src/main.c index 95a9f6c..8c152f4 100644 --- a/src/dnansumpw.c +++ b/src/main.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* 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. @@ -18,7 +18,8 @@ #include "stdlib/blas/ext/base/dnansumpw.h" #include "stdlib/math/base/assert/is_nan.h" -#include +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" /** * Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation. @@ -33,17 +34,20 @@ * * @param N number of indexed elements * @param X input array -* @param stride stride length +* @param strideX stride length * @return output value */ -double stdlib_strided_dnansumpw( const int64_t N, const double *X, const int64_t stride ) { - double *xp1; - double *xp2; +double API_SUFFIX(stdlib_strided_dnansumpw)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_dnansumpw_ndarray)( N, X, strideX, ox ); +} + +double API_SUFFIX(stdlib_strided_dnansumpw_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT M; + CBLAS_INT n; + CBLAS_INT i; double sum; - int64_t ix; - int64_t M; - int64_t n; - int64_t i; double s0; double s1; double s2; @@ -56,17 +60,13 @@ double stdlib_strided_dnansumpw( const int64_t N, const double *X, const int64_t if ( N <= 0 ) { return 0.0; } - if ( N == 1 || stride == 0 ) { + if ( strideX == 0 ) { if ( stdlib_base_is_nan( X[ 0 ] ) ) { return 0.0; } - return X[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; + return X[ 0 ] * N; } + ix = offsetX; if ( N < 8 ) { // Use simple summation... sum = 0.0; @@ -74,7 +74,7 @@ double stdlib_strided_dnansumpw( const int64_t N, const double *X, const int64_t if ( !stdlib_base_is_nan( X[ ix ] ) ) { sum += X[ ix ]; } - ix += stride; + ix += strideX; } return sum; } @@ -82,62 +82,55 @@ double stdlib_strided_dnansumpw( const int64_t N, const double *X, const int64_t if ( N <= 128 ) { // Sum a block with 8 accumulators (by loop unrolling, we lower the effective blocksize to 16)... s0 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s1 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s2 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s3 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s4 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s5 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s6 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s7 = ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; M = N % 8; for ( i = 8; i < N-M; i += 8 ) { s0 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s1 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s2 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s3 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s4 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s5 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s6 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; s7 += ( stdlib_base_is_nan( X[ ix ] ) ) ? 0.0 : X[ ix ]; - ix += stride; + ix += strideX; } // Pairwise sum the accumulators: - sum = ((s0+s1) + (s2+s3)) + ((s4+s5) + (s6+s7)); + sum = ( (s0+s1) + (s2+s3)) + ((s4+s5) + (s6+s7) ); // Clean-up loop... for (; i < N; i++ ) { if ( !stdlib_base_is_nan( X[ ix ] ) ) { sum += X[ ix ]; } - ix += stride; + ix += strideX; } return sum; } // Recurse by dividing by two, but avoiding non-multiples of unroll factor... n = N / 2; n -= n % 8; - if ( stride < 0 ) { - xp1 = (double *)X + ( (n-N)*stride ); - xp2 = (double *)X; - } else { - xp1 = (double *)X; - xp2 = (double *)X + ( n*stride ); - } - return stdlib_strided_dnansumpw( n, xp1, stride ) + stdlib_strided_dnansumpw( N-n, xp2, stride ); + return API_SUFFIX(stdlib_strided_dnansumpw_ndarray)( n, X, strideX, ix ) + API_SUFFIX(stdlib_strided_dnansumpw_ndarray)( N-n, X, strideX, ix+(n*strideX) ); } diff --git a/test/test.dnansumpw.js b/test/test.dnansumpw.js index 065efed..7dc5b63 100644 --- a/test/test.dnansumpw.js +++ b/test/test.dnansumpw.js @@ -182,14 +182,26 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dnansumpw( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0` and the first element is NaN, the function returns 0', function test( t ) { + var x; + var v; + + x = new Float64Array( [ NaN, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnansumpw( x.length, x, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); t.end(); }); diff --git a/test/test.dnansumpw.native.js b/test/test.dnansumpw.native.js index 932544a..58fb118 100644 --- a/test/test.dnansumpw.native.js +++ b/test/test.dnansumpw.native.js @@ -273,14 +273,26 @@ tape( 'the function supports a negative `stride` parameter', opts, function test t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', opts, function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dnansumpw( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0` and the first element is NaN, the function returns 0', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ NaN, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnansumpw( x.length, x, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); t.end(); }); diff --git a/test/test.ndarray.js b/test/test.ndarray.js index 8e245b6..823cd3c 100644 --- a/test/test.ndarray.js +++ b/test/test.ndarray.js @@ -182,14 +182,26 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dnansumpw( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0` and the first element is NaN, the function returns 0', function test( t ) { + var x; + var v; + + x = new Float64Array( [ NaN, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnansumpw( x.length, x, 0, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); t.end(); }); diff --git a/test/test.ndarray.native.js b/test/test.ndarray.native.js index 3bf5718..4b1f4dd 100644 --- a/test/test.ndarray.native.js +++ b/test/test.ndarray.native.js @@ -191,14 +191,26 @@ tape( 'the function supports a negative `stride` parameter', opts, function test t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', opts, function test( t ) { var x; var v; x = new Float64Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = dnansumpw( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided a `stride` parameter equal to `0` and the first element is NaN, the function returns 0', opts, function test( t ) { + var x; + var v; + + x = new Float64Array( [ NaN, -2.0, -4.0, 5.0, 3.0 ] ); + + v = dnansumpw( x.length, x, 0, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); t.end(); });