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
109 changes: 109 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gnancount/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<!--

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

-->

# gnancount

> Count the number of non-`NaN` elements in a one-dimensional ndarray.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

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

#### gnancount( arrays )

Counts the number of non-`NaN` elements in a one-dimensional ndarray.

```javascript
var vector = require( '@stdlib/ndarray/vector/ctor' );

var x = vector( [ 1.0, NaN, 4.0, NaN ], 'generic' );

var v = gnancount( [ x ] );
// returns 2
```

The function has the following parameters:

- **arrays**: array-like object containing a one-dimensional input ndarray.

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- If provided an empty one-dimensional ndarray, the function returns `0`.
- The function supports arbitrary strides and offsets, including negative and zero strides.
- The function supports input ndarrays whose underlying data buffers use accessor protocols.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var vector = require( '@stdlib/ndarray/vector/ctor' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var gnancount = require( '@stdlib/blas/ext/base/ndarray/gnancount' );

var x = vector( [ 1.0, NaN, -2.0, NaN, 3.0 ], 'generic' );
console.log( ndarray2array( x ) );

var v = gnancount( [ x ] );
console.log( v );
// => 3
```

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/**
* @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 uniform = require( '@stdlib/random/uniform' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var gnancount = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'generic'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x;
var i;

x = uniform( [ len ], -10.0, 10.0, options );
for ( i = 0; i < len; i += 2 ) {
x.set( i, NaN );
}
return benchmark;

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

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = gnancount( [ x ] );
if ( v !== len/2 ) {
b.fail( 'should return expected count' );
}
}
b.toc();
if ( v !== len/2 ) {
b.fail( 'should return expected count' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

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

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

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

{{alias}}( arrays )
Counts the number of non-NaN elements in a one-dimensional ndarray.

If provided an empty ndarray, the function returns `0`.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing a one-dimensional input ndarray.

Returns
-------
out: number
Count.

Examples
--------
> var vector = {{alias:@stdlib/ndarray/vector/ctor}};
> var x = vector( [ 1.0, NaN, 3.0 ], 'generic' );
> {{alias}}( [ x ] )
2

See Also
--------
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* @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.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { typedndarray } from '@stdlib/types/ndarray';

/**
* Counts the number of non-`NaN` elements in a one-dimensional ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns count
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var x = vector( [ 1.0, NaN, 4.0, NaN ], 'generic' );
*
* var v = gnancount( [ x ] );
* // returns 2
*/
declare function gnancount<T extends typedndarray<number> = typedndarray<number>>( arrays: [ T ] ): number;


// EXPORTS //

export = gnancount;
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* @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.
*/

/* eslint-disable space-in-parens */

import zeros = require( '@stdlib/ndarray/zeros' );
import gnancount = require( './index' );


// TESTS //

// The function returns a number...
{
const x = zeros( [ 10 ], {
'dtype': 'float64'
});

gnancount( [ x ] ); // $ExpectType number

const y = zeros( [ 10 ], {
'dtype': 'generic'
});
gnancount( [ y ] ); // $ExpectType number
}

// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
{
gnancount( '10' ); // $ExpectError
gnancount( 10 ); // $ExpectError
gnancount( true ); // $ExpectError
gnancount( false ); // $ExpectError
gnancount( null ); // $ExpectError
gnancount( undefined ); // $ExpectError
gnancount( [] ); // $ExpectError
gnancount( {} ); // $ExpectError
gnancount( ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided an unsupported number of arguments...
{
const x = zeros( [ 10 ], {
'dtype': 'float64'
});

gnancount( x ); // $ExpectError
gnancount( [ x, x ] ); // $ExpectError
gnancount( [ [ 1, 2, 3 ] ] ); // $ExpectError

gnancount(); // $ExpectError
gnancount( [ x ], {} ); // $ExpectError
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
* @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';

var vector = require( '@stdlib/ndarray/vector/ctor' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var gnancount = require( './../lib' );

var x = vector( [ 1.0, NaN, -2.0, NaN, 3.0 ], 'generic' );
console.log( ndarray2array( x ) );

var v = gnancount( [ x ] );
console.log( v );
// => 3
Loading
Loading