-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/dnancusumors
#9911
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
MeKaustubh07
wants to merge
7
commits into
stdlib-js:develop
Choose a base branch
from
MeKaustubh07:blas/dnancusumors
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
ca46f38
feat: add blas/ext/base/dnancusumors
MeKaustubh07 87f0d33
fixed spacing
MeKaustubh07 d887e56
fixed paths
MeKaustubh07 63de582
Fixed Paths
MeKaustubh07 1253862
Lint
MeKaustubh07 eb4a52e
Add Reviewed Suggestions
MeKaustubh07 0f66292
add accurate spacing
MeKaustubh07 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
329 changes: 329 additions & 0 deletions
329
lib/node_modules/@stdlib/blas/ext/base/dnancusumors/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,329 @@ | ||
| <!-- | ||
|
|
||
| @license Apache-2.0 | ||
|
|
||
| Copyright (c) 2026 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. | ||
|
|
||
| --> | ||
|
|
||
| # dnancusumors | ||
|
|
||
| > Calculate the cumulative sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation. | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var dnancusumors = require( '@stdlib/blas/ext/base/dnancusumors' ); | ||
| ``` | ||
|
|
||
| #### dnancusumors( N, sum, x, strideX, y, strideY ) | ||
|
|
||
| Computes the cumulative sum of double-precision floating-point strided array elements,ignoring `NaN` values and using ordinary recursive summation. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 1.0, -2.0, NaN ] ); | ||
| var y = new Float64Array( x.length ); | ||
|
|
||
| dnancusumors( x.length, 0.0, x, 1, y, 1 ); | ||
| // y => <Float64Array>[ 1.0, -1.0, -1.0 ] | ||
|
|
||
| x = new Float64Array( [ 1.0, -2.0, NaN ] ); | ||
| y = new Float64Array( x.length ); | ||
|
|
||
| dnancusumors( x.length, 10.0, x, 1, y, 1 ); | ||
| // y => <Float64Array>[ 11.0, 9.0, 9.0 ] | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **sum**: initial sum. | ||
| - **x**: input [`Float64Array`][@stdlib/array/float64]. | ||
| - **strideX**: stride length for `x`. | ||
| - **y**: output [`Float64Array`][@stdlib/array/float64]. | ||
| - **strideY**: stride length for `y`. | ||
|
|
||
| The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative sum of every other element: | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, NaN, 3.0, 4.0, 2.0 ] ); | ||
| var y = new Float64Array( x.length ); | ||
|
|
||
| var v = dnancusumors( 4, 0.0, x, 2, y, 1 ); | ||
| // y => <Float64Array>[ 1.0, 3.0, 3.0, 7.0, 0.0, 0.0, 0.0, 0.0 ] | ||
| ``` | ||
|
|
||
| Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. | ||
|
|
||
| <!-- eslint-disable stdlib/capitalized-comments --> | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| // Initial arrays... | ||
| var x0 = new Float64Array( [ 2.0, NaN, 2.0, NaN, -2.0, 2.0, 3.0, 4.0 ] ); | ||
| var y0 = new Float64Array( x0.length ); | ||
|
|
||
| // Create offset views... | ||
| var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
| var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element | ||
|
|
||
| dnancusumors( 4, 0.0, x1, -2, y1, 1 ); | ||
| // y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 6.0, 6.0, 6.0, 0.0 ] | ||
| ``` | ||
|
|
||
| #### dnancusumors.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY ) | ||
|
|
||
| Computes the cumulative sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 1.0, -2.0, NaN ] ); | ||
| var y = new Float64Array( x.length ); | ||
|
|
||
| dnancusumors.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); | ||
| // y => <Float64Array>[ 1.0, -1.0, -1.0 ] | ||
| ``` | ||
|
|
||
| The function has the following additional parameters: | ||
|
|
||
| - **offsetX**: starting index for `x`. | ||
| - **offsetY**: starting index for `y`. | ||
|
|
||
| While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative sum of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element: | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 2.0, 1.0, 2.0, NaN, -2.0, 2.0, 3.0, NaN ] ); | ||
| var y = new Float64Array( x.length ); | ||
|
|
||
| dnancusumors.ndarray( 4, 0.0, x, 2, 1, y, -1, y.length-1 ); | ||
| // y => <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 3.0, 3.0, 1.0, 1.0 ] | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If `N <= 0`, both functions return `y` unchanged. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var bernoulli = require( '@stdlib/random/base/bernoulli' ); | ||
| var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); | ||
| var filledarrayBy = require( '@stdlib/array/filled-by' ); | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
| var dnancusumors = require( '@stdlib/blas/ext/base/dnancusumors' ); | ||
|
|
||
| function rand() { | ||
| if ( bernoulli( 0.5 ) < 1 ) { | ||
| return discreteUniform( 0, 100 ); | ||
| } | ||
| return NaN; | ||
| } | ||
|
|
||
| var x = filledarrayBy( 10, 'float64', rand ); | ||
| console.log( x ); | ||
|
|
||
| var y = new Float64Array( x.length ); | ||
| console.log( y ); | ||
|
|
||
| dnancusumors( x.length, 0.0, x, 1, y, 1 ); | ||
| console.log( y ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| <!-- C interface documentation. --> | ||
|
|
||
| * * * | ||
|
|
||
| <section class="c"> | ||
|
|
||
| ## C APIs | ||
|
|
||
| <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="intro"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.intro --> | ||
|
|
||
| <!-- C usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ### Usage | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/dnancusumors.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dnancusumors( N, sum, \*X, strideX, \*Y, strideY ) | ||
|
|
||
| Computes the cumulative sum of double-precision floating-point strided array elements, ingoring `NaN` values and using ordinary recursive summation. | ||
|
|
||
| ```c | ||
| const double x[] = { 1.0, 2.0, 3.0, 0.0/0.0 } | ||
| double y[] = { 0.0, 0.0, 0.0, 0.0 } | ||
|
|
||
| stdlib_strided_dnancusumors( 4, 0.0, x, 1, y, 1 ); | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **sum**: `[in] double` initial sum. | ||
| - **X**: `[in] double*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||
| - **Y**: `[out] double*` output array. | ||
| - **strideY**: `[in] CBLAS_INT` stride length for `Y`. | ||
|
|
||
| ```c | ||
| void stdlib_strided_dnancusumors( const CBLAS_INT N, const double sum, const double *X, const CBLAS_INT strideX, double *Y, const CBLAS_INT strideY ); | ||
| ``` | ||
|
|
||
| <!-- lint disable maximum-heading-length --> | ||
|
|
||
| #### stdlib_strided_dnancusumors_ndarray( N, sum, \*X, strideX, offsetX, \*Y, strideY, offsetY ) | ||
|
|
||
| <!-- lint enable maximum-heading-length --> | ||
|
|
||
| Computes the cumulative sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. | ||
|
|
||
| ```c | ||
| const double x[] = { 1.0, 2.0, 3.0, 0.0/0.0 } | ||
| double y[] = { 0.0, 0.0, 0.0, 0.0 } | ||
|
|
||
| stdlib_strided_dnancusumors_ndarray( 4, 0.0, x, 1, 0, y, 1, 0 ); | ||
| ``` | ||
|
|
||
| The function accepts the following arguments: | ||
|
|
||
| - **N**: `[in] CBLAS_INT` number of indexed elements. | ||
| - **sum**: `[in] double` initial sum. | ||
| - **X**: `[in] double*` input array. | ||
| - **strideX**: `[in] CBLAS_INT` stride length for `X`. | ||
| - **offsetX**: `[in] CBLAS_INT` starting index for `X`. | ||
| - **Y**: `[out] double*` output array. | ||
| - **strideY**: `[in] CBLAS_INT` stride length for `Y`. | ||
| - **offsetY**: `[in] CBLAS_INT` starting index for `Y`. | ||
|
|
||
| ```c | ||
| void stdlib_strided_dnancusumors_ndarray( const CBLAS_INT N, const double sum, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY ); | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- C API usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ### Examples | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/dnancusumors.h" | ||
|
|
||
| int main( void ) { | ||
| // Create strided arrays: | ||
| const double x[] = { 1.0, 2.0, 3.0, 0.0/0.0, 5.0, 6.0, 7.0, 0.0/0.0 }; | ||
| double y[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }; | ||
|
|
||
| // Specify the number of elements: | ||
| const int N = 4; | ||
|
|
||
| // Specify stride lengths: | ||
| const int strideX = 2; | ||
| const int strideY = -2; | ||
|
|
||
| // Compute the cumulative sum: | ||
| stdlib_strided_dnancusumors( N, 0.0, x, strideX, y, strideY ); | ||
|
|
||
| // Print the result: | ||
| for ( int i = 0; i < 8; i++ ) { | ||
| printf( "y[ %d ] = %lf\n", i, y[ i ] ); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
|
||
| <section class="related"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.related --> | ||
|
|
||
| <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="links"> | ||
|
|
||
| [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 | ||
|
|
||
| [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray | ||
|
|
||
| <!-- <related-links> --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Related packages are autogenerated.