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
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
<!--

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

-->

# gindexOfSomeTruthyRow

> Return the index of the first row in an input matrix which contains at least `k` truthy elements.

<section class="usage">

## Usage

```javascript
var gindexOfSomeTruthyRow = require( '@stdlib/blas/ext/base/gindex-of-some-truthy-row' );
```

#### gindexOfSomeTruthyRow( order, M, N, k, A, LDA )

Returns the index of the first row in an input matrix which contains at least `k` truthy elements.

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

```javascript
/*
A = [
[ 0.0, 0.0, 0.0 ],
[ 1.0, 0.0, 1.0 ],
[ 1.0, 1.0, 1.0 ],
[ 0.0, 0.0, 0.0 ]
]
*/
var A = [ 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0 ];

var out = gindexOfSomeTruthyRow( 'row-major', 4, 3, 2, A, 3 );
// returns 1
```

The function has the following parameters:

- **order**: storage layout.
- **M**: number of rows in `A`.
- **N**: number of columns in `A`.
- **k**: minimum number of truthy elements.
- **A**: input matrix as a linear array.
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).

If the function is unable to find a row with at least `k` truthy elements, the function returns `-1`.

```javascript
var A = [ 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0, 0.0 ];

var out = gindexOfSomeTruthyRow( 'row-major', 3, 3, 2, A, 3 );
// returns -1
```

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, max-len -->

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

// Initial array:
var A0 = new Float64Array( [ 9999.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0 ] );

// Create offset view:
var A1 = new Float64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

var out = gindexOfSomeTruthyRow( 'row-major', 4, 3, 2, A1, 3 );
// returns 1
```

#### gindexOfSomeTruthyRow.ndarray( M, N, k, A, strideA1, strideA2, offsetA )

Returns the index of the first row in an input matrix which contains at least `k` truthy elements using alternative indexing semantics.

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

```javascript
/*
A = [
[ 0.0, 0.0, 0.0 ],
[ 1.0, 0.0, 1.0 ],
[ 1.0, 1.0, 1.0 ],
[ 0.0, 0.0, 0.0 ]
]
*/
var A = [ 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0 ];

var out = gindexOfSomeTruthyRow.ndarray( 4, 3, 2, A, 3, 1, 0 );
// returns 1
```

The function has the following parameters:

- **M**: number of rows in `A`.
- **N**: number of columns in `A`.
- **k**: minimum number of truthy elements.
- **A**: input matrix as a linear array.
- **strideA1**: stride length for the first dimension of `A`.
- **strideA2**: stride length for the second dimension of `A`.
- **offsetA**: starting index for `A`.

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 start searching from the second element

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

```javascript
/*
A = [
[ 0.0, 0.0, 0.0 ],
[ 1.0, 0.0, 1.0 ],
[ 1.0, 1.0, 1.0 ],
[ 0.0, 0.0, 0.0 ]
]
*/
var A = [ 9999.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0 ];

var out = gindexOfSomeTruthyRow.ndarray( 4, 3, 2, A, 3, 1, 1 );
// returns 1
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- A row is considered to contain at least `k` truthy elements when at least `k` elements in the row are not equal to `0.0` and are not `NaN`.
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

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

```javascript
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
var gindexOfSomeTruthyRow = require( '@stdlib/blas/ext/base/gindex-of-some-truthy-row' );

var shape = [ 4, 3 ];
var order = 'row-major';
var strides = shape2strides( shape, order );

var A = [ 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0 ];
console.log( ndarray2array( A, shape, strides, 0, order ) );

var out = gindexOfSomeTruthyRow( order, shape[ 0 ], shape[ 1 ], 2, A, strides[ 0 ] );
console.log( out );
```

</section>

<!-- /.examples -->

<!-- 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">

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
/**
* @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.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var zeros = require( '@stdlib/array/zeros' );
var pow = require( '@stdlib/math/base/special/pow' );
var floor = require( '@stdlib/math/base/special/floor' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var gindexOfSomeTruthyRow = require( './../lib' );


// VARIABLES //

var LAYOUTS = [
'row-major',
'column-major'
];


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {string} order - storage layout
* @param {PositiveInteger} N - number of elements along each dimension
* @returns {Function} benchmark function
*/
function createBenchmark( order, N ) {
var A = zeros( N*N, 'generic' );
return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var z;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
z = gindexOfSomeTruthyRow( order, N, N, 2, A, N );
if ( isnan( z ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( z ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var min;
var max;
var ord;
var N;
var f;
var i;
var k;

min = 1; // 10^min
max = 6; // 10^max

for ( k = 0; k < LAYOUTS.length; k++ ) {
ord = LAYOUTS[ k ];
for ( i = min; i <= max; i++ ) {
N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
f = createBenchmark( ord, N );
bench( format( '%s::square_matrix:order=%s,size=%d', pkg, ord, N*N ), f );
}
}
}

main();
Loading
Loading