https://github.com/stdlib-js/ndarray-any

Test whether at least one element along one or more ndarray dimensions is truthy.
https://github.com/stdlib-js/ndarray-any

any array javascript ndarray node node-js nodejs reduce reduction some stdlib strided truthy utility utils

Last synced: 18 days ago
JSON representation

Test whether at least one element along one or more ndarray dimensions is truthy.

Host: GitHub
URL: https://github.com/stdlib-js/ndarray-any
Owner: stdlib-js
License: apache-2.0
Created: 2025-09-22T00:33:42.000Z (19 days ago)
Default Branch: main
Last Pushed: 2025-09-22T11:29:25.000Z (19 days ago)
Last Synced: 2025-09-22T13:16:09.003Z (19 days ago)
Topics: any, array, javascript, ndarray, node, node-js, nodejs, reduce, reduction, some, stdlib, strided, truthy, utility, utils
Language: JavaScript
Homepage: https://github.com/stdlib-js/stdlib
Size: 792 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE

Awesome Lists containing this project

README

          

  

    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!


# any

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> Test whether at least one element along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions is truthy.

## Installation

```bash

npm install @stdlib/ndarray-any

```

Alternatively,

-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] 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

```javascript

var any = require( '@stdlib/ndarray-any' );

```

#### any( x\[, options] )

Tests whether at least one element along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions is truthy.

```javascript

var array = require( '@stdlib/ndarray-array' );

// Create an input ndarray:

var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, -4.0 ] ], [ [ 5.0, -6.0 ] ] ] );

// returns 

// Perform reduction:

var out = any( x );

// returns 

var v = out.get();

// returns true

```

The function accepts the following arguments:

-   **x**: input [`ndarray`][@stdlib/ndarray/ctor].

-   **options**: function options (_optional_).

The function accepts the following `options`:

-   **dims**: list of dimensions over which to perform a reduction.

-   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [`ndarray`][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.

By default, the function performs a reduction over all elements in a provided [`ndarray`][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.

```javascript

var array = require( '@stdlib/ndarray-array' );

var ndarray2array = require( '@stdlib/ndarray-to-array' );

// Create an input ndarray:

var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );

// returns 

// Perform reduction:

var out = any( x, {

    'dims': [ 1, 2 ]

});

// returns 

var v = ndarray2array( out );

// returns [ true, true, true ]

```

By default, the function returns an [`ndarray`][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [`ndarray`][@stdlib/ndarray/ctor], set the `keepdims` option to `true`.

```javascript

var array = require( '@stdlib/ndarray-array' );

var ndarray2array = require( '@stdlib/ndarray-to-array' );

// Create an input ndarray:

var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );

// returns 

// Perform reduction:

var out = any( x, {

    'dims': [ 1, 2 ],

    'keepdims': true

});

// returns 

var v = ndarray2array( out );

// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ]

```

#### any.assign( x, out\[, options] )

Tests whether at least one element along one or more [`ndarray`][@stdlib/ndarray/ctor] dimensions is truthy and assigns results to a provided output [`ndarray`][@stdlib/ndarray/ctor].

```javascript

var array = require( '@stdlib/ndarray-array' );

var empty = require( '@stdlib/ndarray-empty' );

// Create an input ndarray:

var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );

// returns 

// Create an output ndarray:

var y = empty( [], {

    'dtype': 'bool'

});

// Perform reduction:

var out = any.assign( x, y );

// returns 

var bool = ( out === y );

// returns true

var v = y.get();

// returns true

```

The function accepts the following arguments:

-   **x**: input [`ndarray`][@stdlib/ndarray/ctor].

-   **out**: output [`ndarray`][@stdlib/ndarray/ctor]. The output [`ndarray`][@stdlib/ndarray/ctor] must have a shape matching the non-reduced dimensions of the input [`ndarray`][@stdlib/ndarray/ctor].

-   **options**: function options (_optional_).

The function accepts the following `options`:

-   **dims**: list of dimensions over which to perform a reduction.

By default, the function performs a reduction over all elements in a provided [`ndarray`][@stdlib/ndarray/ctor]. To reduce specific dimensions, set the `dims` option.

```javascript

var array = require( '@stdlib/ndarray-array' );

var empty = require( '@stdlib/ndarray-empty' );

var ndarray2array = require( '@stdlib/ndarray-to-array' );

// Create an input ndarray:

var x = array( [ [ [ -1.0, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );

// returns 

// Create an output ndarray:

var y = empty( [ 3 ], {

    'dtype': 'bool'

});

// Perform reduction:

var out = any.assign( x, y, {

    'dims': [ 1, 2 ]

});

var bool = ( out === y );

// returns true

var v = ndarray2array( y );

// returns [ true, true, true ]

```

## Examples

```javascript

var bernoulli = require( '@stdlib/random-base-bernoulli' ).factory;

var ndarray2array = require( '@stdlib/ndarray-to-array' );

var fillBy = require( '@stdlib/ndarray-fill-by' );

var zeros = require( '@stdlib/ndarray-zeros' );

var any = require( '@stdlib/ndarray-any' );

var x = zeros( [ 2, 4, 5 ], {

    'dtype': 'float64'

});

x = fillBy( x, bernoulli( 0.10 ) );

console.log( ndarray2array( x ) );

var y = any( x );

console.log( 'any(x[:,:,:]) =' );

console.log( y.get() );

y = any( x, {

    'dims': [ 0 ],

    'keepdims': true

});

console.log( 'any(x[:,j,k]) =' );

console.log( ndarray2array( y ) );

y = any( x, {

    'dims': [ 1 ],

    'keepdims': true

});

console.log( 'any(x[i,:,k]) =' );

console.log( ndarray2array( y ) );

y = any( x, {

    'dims': [ 2 ],

    'keepdims': true

});

console.log( 'any(x[i,j,:]) =' );

console.log( ndarray2array( y ) );

y = any( x, {

    'dims': [ 0, 1 ],

    'keepdims': true

});

console.log( 'any(x[:,:,k]) =' );

console.log( ndarray2array( y ) );

y = any( x, {

    'dims': [ 0, 2 ],

    'keepdims': true

});

console.log( 'any(x[:,j,:]) =' );

console.log( ndarray2array( y ) );

y = any( x, {

    'dims': [ 1, 2 ],

    'keepdims': true

});

console.log( 'any(x[i,:,:]) =' );

console.log( ndarray2array( y ) );

y = any( x, {

    'dims': [ 0, 1, 2 ],

    'keepdims': true

});

console.log( 'any(x[:,:,:]) =' );

console.log( ndarray2array( y ) );

```

* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-any.svg

[npm-url]: https://npmjs.org/package/@stdlib/ndarray-any

[test-image]: https://github.com/stdlib-js/ndarray-any/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/ndarray-any/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-any/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-any?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/ndarray-any/tree/deno

[deno-readme]: https://github.com/stdlib-js/ndarray-any/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/ndarray-any/tree/umd

[umd-readme]: https://github.com/stdlib-js/ndarray-any/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/ndarray-any/tree/esm

[esm-readme]: https://github.com/stdlib-js/ndarray-any/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/ndarray-any/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-any/main/LICENSE

[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/stdlib-js/ndarray-any

Awesome Lists containing this project

README