Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 299 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/dsome/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,299 @@
<!--

@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.

-->

# dsome

> Test whether a double-precision floating-point strided array contains at least `k` truthy elements.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var dsome = require( '@stdlib/blas/ext/base/dsome' );
```

#### dsome( N, k, x, strideX )

Tests whether a double-precision floating-point strided array contains at least `k` truthy elements.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 0.0, 1.0, 2.0 ] );

var v = dsome( x.length, 2, x, 1 );
// returns true
```

The function has the following parameters:

- **N**: number of indexed elements.
- **k**: minimum number of truthy elements.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **strideX**: stride length.

The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to test every other element:

<!-- eslint-disable max-len -->

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 0.0, 1.0, 2.0, 1.0, 3.0 ] );

var v = dsome( 3, 2, x, 2 );
// returns true
```

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' );

var x0 = new Float64Array( [ 0.0, 0.0, 1.0, 2.0, 0.0, 3.0 ] );
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var v = dsome( 3, 2, x1, 2 );
// returns true
```

#### dsome.ndarray( N, k, x, strideX, offsetX )

Tests whether a double-precision floating-point strided array contains at least `k` truthy elements using alternative indexing semantics.

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 0.0, 1.0, 2.0 ] );

var v = dsome.ndarray( x.length, 2, x, 1, 0 );
// returns true
```

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 test every other element starting from the second element:

```javascript
var Float64Array = require( '@stdlib/array/float64' );

var x = new Float64Array( [ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0 ] );

var v = dsome.ndarray( 3, 2, x, 2, 1 );
// returns true
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If `N <= 0`, the function returns `false`.
- Both functions explicitly treat `NaN` values as falsy.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var bernoulli = require( '@stdlib/random/array/bernoulli' );
var dsome = require( '@stdlib/blas/ext/base/dsome' );

var x = bernoulli( 10, 0.5, {
'dtype': 'float64'
});
console.log( x );

var out = dsome( x.length, 5, x, 1 );
console.log( out );
```

</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/dsome.h"
```

#### stdlib_strided_dsome( N, k, \*X, strideX )

Tests whether a double-precision floating-point strided array contains at least `k` truthy elements.

```c
const double x[] = { 0.0, 0.0, 1.0, 2.0 };

bool result = stdlib_strided_dsome( 4, 2, x, 1 );
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **k**: `[in] CBLAS_INT` minimum number of truthy elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.

```c
bool stdlib_strided_dsome( const CBLAS_INT N, const CBLAS_INT k, const double *X, const CBLAS_INT strideX );
```

#### stdlib_strided_dsome_ndarray( N, k, \*X, strideX, offsetX )

Tests whether a double-precision floating-point strided array contains at least `k` truthy elements using alternative indexing semantics.

```c
const double x[] = { 0.0, 0.0, 1.0, 2.0 };

bool result = stdlib_strided_dsome_ndarray( 4, 2, x, 1, 0 );
```

The function accepts the following arguments:

- **N**: `[in] CBLAS_INT` number of indexed elements.
- **k**: `[in] CBLAS_INT` minimum number of truthy elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` stride length.
- **offsetX**: `[in] CBLAS_INT` starting index.

```c
bool stdlib_strided_dsome_ndarray( const CBLAS_INT N, const CBLAS_INT k, 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/dsome.h"
#include <stdbool.h>
#include <stdio.h>

int main( void ) {
// Create a strided array:
const double x[] = { 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0 };

// Specify the number of indexed elements:
const int N = 8;

// Specify the minimum number of truthy elements:
const int k = 2;

// Specify a stride:
const int strideX = 1;

// Test whether the array contains at least `k` truthy elements:
bool result = stdlib_strided_dsome( N, k, x, strideX );

// Print the result:
printf( "Result: %s\n", result ? "true" : "false" );
}
```

</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> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
Loading