Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/array-base-none-by-right
Test whether all elements in an array fail a test implemented by a predicate function, iterating from right to left.
https://github.com/stdlib-js/array-base-none-by-right
all array data every generic javascript node node-js nodejs none predicate stdlib structure test types validate
Last synced: 13 days ago
JSON representation
Test whether all elements in an array fail a test implemented by a predicate function, iterating from right to left.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-none-by-right
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-01-14T22:45:32.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-07-29T12:07:00.000Z (5 months ago)
- Last Synced: 2024-11-17T11:02:01.622Z (about 2 months ago)
- Topics: all, array, data, every, generic, javascript, node, node-js, nodejs, none, predicate, stdlib, structure, test, types, validate
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 595 KB
- Stars: 1
- Watchers: 3
- 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
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!
# noneByRight
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test whether all elements in an array fail a test implemented by a predicate function, iterating from right to left.
## Installation
```bash
npm install @stdlib/array-base-none-by-right
```
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 noneByRight = require( '@stdlib/array-base-none-by-right' );
```
#### noneByRight( x, predicate\[, thisArg] )
Tests whether all elements in an array fail a test implemented by a `predicate` function, iterating from right to left.
```javascript
function isPositive( value ) {
return ( value > 0 );
}
var x = [ 0, 0, 0, 0 ];
var bool = noneByRight( x, isPositive );
// returns true
```
If a `predicate` function returns a truthy value, the function **immediately** returns `false`.
```javascript
function isPositive( value ) {
return ( value > 0 );
}
var x = [ -1, -2, 3, -4 ];
var bool = noneByRight( x, isPositive );
// returns false
```
The `predicate` function is provided three arguments:
- **value**: current array element.
- **index**: current array element index.
- **arr**: input array.
To set the `predicate` function execution context, provide a `thisArg`.
```javascript
function predicate( value ) {
this.count += 1;
return ( value < 0 );
}
var x = [ 1, 2, -3, 4 ];
var context = {
'count': 0
};
var bool = noneByRight( x, predicate, context );
// returns false
var cnt = context.count;
// returns 2
```
## Notes
- The function performs a linear scan and returns immediately upon encountering a truthy return value. Unlike [`Array.prototype.every`][mdn-array-every], when performing a linear scan, the function does **not** skip `undefined` elements.
- If provided an empty array, the function returns `true`.
## Examples
```javascript
var bernoulli = require( '@stdlib/random-array-bernoulli' );
var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive;
var naryFunction = require( '@stdlib/utils-nary-function' );
var noneByRight = require( '@stdlib/array-base-none-by-right' );
var x = bernoulli( 10, 0.1, {
'dtype': 'int8'
});
// returns
var out = noneByRight( x, naryFunction( isPositiveInteger, 1 ) );
// returns
```
* * *
## 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/array-base-none-by-right.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-none-by-right
[test-image]: https://github.com/stdlib-js/array-base-none-by-right/actions/workflows/test.yml/badge.svg?branch=v0.2.2
[test-url]: https://github.com/stdlib-js/array-base-none-by-right/actions/workflows/test.yml?query=branch:v0.2.2
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-none-by-right/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-none-by-right?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/array-base-none-by-right/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-none-by-right/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-none-by-right/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-none-by-right/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-none-by-right/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-none-by-right/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-none-by-right/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-none-by-right/main/LICENSE
[mdn-array-every]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every