Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/utils-find

Find elements in an array-like object that satisfy a test condition.
https://github.com/stdlib-js/utils-find

array find findindex javascript node node-js nodejs search stdlib util utilities utility utils

Last synced: 2 months ago
JSON representation

Find elements in an array-like object that satisfy a test condition.

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!



# Find



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



> Find elements in an array-like object that satisfy a test condition.



## Installation



```bash

npm install @stdlib/utils-find

```



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 find = require( '@stdlib/utils-find' );

```



#### find( arr, \[opts,] clbk )



Finds elements in an array-like object that satisfy a test condition. The function accepts two options: `k` and `returns`.



-   **k**: an `integer` which limits the number of elements returned and whose sign determines the direction in which to search. If set to a negative `integer`, the function searches from the last element to the first element.



-   **returns**: specifies the type of result to return and may be one of three options: `indices`, `values`, `*`.



    -   **indices**: indicates to return the element indices of those elements satisfying the search condition.

    -   **values**: indicates to return the element values of those elements satisfying the search condition.

    -   **\***: indicates to return both the element indices and values of those elements satisfying the search condition. The returned result is an `array` of `arrays`, where each sub-array is an index-value pair.



The `callback` is provided three arguments:



-   **element**: the current element

-   **index**: the current element's index

-   **array**: the input `array`, `typed array` or `string`



By default, `k` is the length of `arr` and `returns` is set to `indices`.



```javascript

var data = [ 30, 20, 50, 60, 10 ];



function greaterThan20( val ) {

    return val > 20;

}



var vals = find( data, greaterThan20 );

// returns [ 0, 2, 3 ]



data = 'Hello World';

function isUpperCase( val ) {

    return /[A-Z]/.test( val );

}



vals = find( data, isUpperCase );

// returns [ 0, 6 ]

```



To limit the number of results and specify that `values` should be returned,



```javascript

var data = [ 30, 20, 50, 60, 10 ];



var opts = {

    'k': 2,

    'returns': 'values'

};



function condition( val ) {

    return val > 20;

}



var vals = find( data, opts, condition );

// returns [ 30, 50 ]

```



If no `array` elements satisfy the test condition, the function returns an empty `array`.



```javascript

var data = [ 30, 20, 50, 60, 10 ];



var opts = {

    'k': 2,

    'returns': 'values'

};



function condition( val ) {

    return val > 1000;

}



var vals = find( data, opts, condition );

// returns []

```



To find the last two values satisfying a search condition,



```javascript

var data = [ 30, 20, 50, 60, 10 ];



var opts = {

    'k': -2,

    'returns': 'values'

};



function condition( val ) {

    return val > 20;

}



var vals = find( data, opts, condition );

// returns [ 60, 50 ]

```



To explicitly specify that only indices are returned,



```javascript

var data = [ 30, 20, 50, 60, 10 ];



var opts = {

    'k': -2,

    'returns': 'indices'

};



function condition( val ) {

    return val > 20;

}



var vals = find( data, opts, condition );

// returns [ 3, 2 ]

```



And to return both indices and values as index-value pairs,



```javascript

var data = [ 30, 20, 50, 60, 10 ];



var opts = {

    'k': -2,

    'returns': '*'

};



function condition( val ) {

    return val > 20;

}



var vals = find( data, opts, condition );

// returns [ [3, 60], [2, 50] ]

```



## Examples



```javascript

var round = require( '@stdlib/math-base-special-round' );

var randu = require( '@stdlib/random-base-randu' );

var find = require( '@stdlib/utils-find' );



// Simulate the data...

var data = new Array( 100 );

var i;

for ( i = 0; i < data.length; i++ ) {

    data[ i ] = round( randu*100 );

}



// Find the first 10 values greater than 25...

var opts = {

    'k': 10,

    'returns': '*'

};



function condition( val ) {

    return val > 25;

}



var vals = find( data, opts, condition );

console.log( vals.join( '\n' ) );

```



* * *



## 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-2024. The Stdlib [Authors][stdlib-authors].



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

[npm-url]: https://npmjs.org/package/@stdlib/utils-find



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

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



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

[coverage-url]: https://codecov.io/github/stdlib-js/utils-find?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/utils-find/tree/deno

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

[umd-url]: https://github.com/stdlib-js/utils-find/tree/umd

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

[esm-url]: https://github.com/stdlib-js/utils-find/tree/esm

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

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



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-find/main/LICENSE