Skip to content

stdlib-js/blas-ext-base-gcunone

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

gcunone

NPM version Build Status Coverage Status

Cumulatively test whether every element in a strided array is falsy.

Installation

npm install @stdlib/blas-ext-base-gcunone

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var gcunone = require( '@stdlib/blas-ext-base-gcunone' );

gcunone( N, x, strideX, out, strideOut )

Cumulatively tests whether every element in a strided array is falsy.

var x = [ 0, 0, 1, 1 ];
var out = [ false, false, false, false ];

gcunone( x.length, x, 1, out, 1 );
// out => [ true, true, false, false ]

The function has the following parameters:

  • N: number of indexed elements.
  • x: input Array or typed array.
  • strideX: stride length for x.
  • out: output Array or typed array.
  • strideOut: stride length for out.

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

var x = [ 0, 0, 0, 0, 1, 0, 1, 0 ];
var out = [ false, false, false, false ];

gcunone( 4, x, 2, out, 1 );
// out => [ true, true, false, false ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var BooleanArray = require( '@stdlib/array-bool' );
var Uint8Array = require( '@stdlib/array-uint8' );

// Initial arrays...
var x0 = new Uint8Array( [ 0, 0, 0, 1, 1, 1 ] );
var o0 = new BooleanArray( x0.length );

// Create offset views...
var x1 = new Uint8Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var o1 = new BooleanArray( o0.buffer, o0.BYTES_PER_ELEMENT*3 ); // start at 4th element

gcunone( 3, x1, 2, o1, 1 );
// o0 => <BooleanArray>[ false, false, false, true, false, false ]

gcunone.ndarray( N, x, strideX, offsetX, out, strideOut, offsetOut )

Cumulatively tests whether every element in a strided array is falsy using alternative indexing semantics.

var x = [ 0, 0, 1, 1 ];
var out = [ false, false, false, false ];

gcunone.ndarray( x.length, x, 1, 0, out, 1, 0 );
// out => [ true, true, false, false ]

The function has the following additional parameters:

  • offsetX: starting index for x.
  • offsetOut: starting index for out.

While typed array views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to cumulatively test every other element starting from the third element:

var x = [ 0, 0, 0, 0, 1, 0, 1, 0 ];
var out = [ false, false, false ];

gcunone.ndarray( 3, x, 2, 2, out, 1, 0 );
// out => [ true, false, false ]

Notes

  • If N <= 0, both functions return out unchanged.
  • Both functions support array-like objects having getter and setter accessors for array element access (e.g., @stdlib/array-base/accessor).

Examples

var bernoulli = require( '@stdlib/random-array-bernoulli' );
var falses = require( '@stdlib/array-falses' );
var gcunone = require( '@stdlib/blas-ext-base-gcunone' );

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

var out = falses( x.length, 'generic' );
gcunone( x.length, x, 1, out, 1 );
console.log( out );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

Releases

No releases published

Packages

 
 
 

Contributors