-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add blas/ext/base/dlast-index-of-truthy
#13001
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
Merged
kgryte
merged 7 commits into
stdlib-js:develop
from
headlessNode:blas/dlast-index-of-truthy
Jun 22, 2026
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d5398d7
feat: add blas/ext/base/dlast-index-of-truthy
headlessNode cbfe72a
Merge branch 'develop' into blas/dlast-index-of-truthy
headlessNode 52deabc
test: refactor
headlessNode 15c60dd
Apply suggestions from code review
kgryte 18c926b
Apply suggestions from code review
kgryte 3792876
Apply suggestions from code review
kgryte 0354608
Apply suggestions from code review
kgryte 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
317 changes: 317 additions & 0 deletions
317
lib/node_modules/@stdlib/blas/ext/base/dlast-index-of-truthy/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,317 @@ | ||
| <!-- | ||
|
|
||
| @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. | ||
|
|
||
| --> | ||
|
|
||
| # dlastIndexOfTruthy | ||
|
|
||
| > Return the index of the last truthy element in a double-precision floating-point strided array. | ||
|
|
||
| <!-- 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 --> | ||
|
|
||
| <!-- Package usage documentation. --> | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| var dlastIndexOfTruthy = require( '@stdlib/blas/ext/base/dlast-index-of-truthy' ); | ||
| ``` | ||
|
|
||
| #### dlastIndexOfTruthy( N, x, strideX ) | ||
|
|
||
| Returns the index of the last truthy element in a double-precision floating-point strided array. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, -1.0, 3.0 ] ); | ||
|
|
||
| var idx = dlastIndexOfTruthy( x.length, x, 1 ); | ||
| // returns 7 | ||
| ``` | ||
|
|
||
| The function has the following parameters: | ||
|
|
||
| - **N**: number of indexed elements. | ||
| - **x**: input [`Float64Array`][@stdlib/array/float64]. | ||
| - **strideX**: stride length. | ||
|
|
||
| If the function is unable to find a truthy element, the function returns `-1`. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] ); | ||
|
|
||
| var idx = dlastIndexOfTruthy( x.length, x, 1 ); | ||
| // returns -1 | ||
| ``` | ||
|
|
||
| The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element: | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, -1.0, 3.0 ] ); | ||
|
|
||
| var idx = dlastIndexOfTruthy( 4, x, 2 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| // Initial array... | ||
| var x0 = new Float64Array( [ 0.0, 0.0, 0.0, 3.0, 5.0, 0.0 ] ); | ||
|
|
||
| // Create an offset view... | ||
| var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
|
||
| // Find index... | ||
| var idx = dlastIndexOfTruthy( 3, x1, 2 ); | ||
| // returns 1 | ||
| ``` | ||
|
|
||
| #### dlastIndexOfTruthy.ndarray( N, x, strideX, offsetX ) | ||
|
|
||
| Returns the index of the last truthy element in a double-precision floating-point strided array using alternative indexing semantics. | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, -1.0, 3.0 ] ); | ||
|
|
||
| var idx = dlastIndexOfTruthy.ndarray( x.length, x, 1, 0 ); | ||
| // returns 7 | ||
| ``` | ||
|
|
||
| The function has the following additional parameters: | ||
|
|
||
| - **offsetX**: starting index. | ||
|
|
||
| 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 access only the last three elements of the strided array: | ||
|
|
||
| ```javascript | ||
| var Float64Array = require( '@stdlib/array/float64' ); | ||
|
|
||
| var x = new Float64Array( [ 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, 0.0, 3.0 ] ); | ||
|
|
||
| var idx = dlastIndexOfTruthy.ndarray( 3, x, 1, x.length-3 ); | ||
| // returns 2 | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="notes"> | ||
|
|
||
| ## Notes | ||
|
|
||
| - If the function is unable to find a truthy element, the function returns `-1`. | ||
| - Both functions explicitly treat `NaN` values as falsy. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- Package usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var bernoulli = require( '@stdlib/random/array/bernoulli' ); | ||
| var dlastIndexOfTruthy = require( '@stdlib/blas/ext/base/dlast-index-of-truthy' ); | ||
|
|
||
| var x = bernoulli( 10, 0.3, { | ||
| 'dtype': 'float64' | ||
| }); | ||
| console.log( x ); | ||
|
|
||
| var idx = dlastIndexOfTruthy( x.length, x, 1 ); | ||
| console.log( idx ); | ||
| ``` | ||
|
|
||
| </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/dlast_index_of_truthy.h" | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dlast_index_of_truthy( N, \*X, strideX ) | ||
|
|
||
| Returns the index of the last truthy element in a double-precision floating-point strided array. | ||
|
|
||
| ```c | ||
| const double x[] = { 0.0, 0.0, 3.0, 4.0 }; | ||
|
|
||
| int idx = stdlib_strided_dlast_index_of_truthy( 4, x, 1 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| ```c | ||
| CBLAS_INT stdlib_strided_dlast_index_of_truthy( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); | ||
| ``` | ||
|
|
||
| #### stdlib_strided_dlast_index_of_truthy_ndarray( N, \*X, strideX, offsetX ) | ||
|
|
||
| Returns the index of the last truthy element in a double-precision floating-point strided array using alternative indexing semantics. | ||
|
|
||
| ```c | ||
| const double x[] = { 0.0, 0.0, 3.0, 4.0 }; | ||
|
|
||
| int idx = stdlib_strided_dlast_index_of_truthy_ndarray( 4, x, 1, 0 ); | ||
| // returns 3 | ||
| ``` | ||
|
|
||
| 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. | ||
| - **offsetX**: `[in] CBLAS_INT` starting index. | ||
|
|
||
| ```c | ||
| CBLAS_INT stdlib_strided_dlast_index_of_truthy_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); | ||
| ``` | ||
|
|
||
| </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"> | ||
|
|
||
| ### Notes | ||
|
|
||
| - Both functions explicitly treat `NaN` values as falsy. | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.notes --> | ||
|
|
||
| <!-- C API usage examples. --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ### Examples | ||
|
|
||
| ```c | ||
| #include "stdlib/blas/ext/base/dlast_index_of_truthy.h" | ||
| #include <stdio.h> | ||
|
|
||
| int main( void ) { | ||
| // Create a strided array: | ||
| const double x[] = { 0.0, 0.0, 3.0, 0.0, 4.0, 0.0, -1.0, 3.0 }; | ||
|
|
||
| // Specify the number of indexed elements: | ||
| const int N = 8; | ||
|
|
||
| // Specify a stride: | ||
| const int strideX = 1; | ||
|
|
||
| // Find the index of the last truthy element: | ||
| int idx = stdlib_strided_dlast_index_of_truthy( N, x, strideX ); | ||
|
|
||
| // Print the result: | ||
| printf( "index value: %d\n", idx ); | ||
| } | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.examples --> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.c --> | ||
|
|
||
| <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
|
||
| <section class="references"> | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.references --> | ||
|
|
||
| <!-- 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 | ||
|
|
||
| </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.
Uh oh!
There was an error while loading. Please reload this page.