Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/assert-is-same-booleanarray

Test if two arguments are both BooleanArrays and have the same values.
https://github.com/stdlib-js/assert-is-same-booleanarray

assert assertion equal is isequal issame issamevalue isstrictequal javascript node node-js nodejs same stdlib strict type util utilities utility utils

Last synced: about 1 month ago
JSON representation

Test if two arguments are both BooleanArrays and have the same values.

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!

# isSameBooleanArray

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

> Test if two arguments are both [BooleanArrays][@stdlib/array/bool] and have the [same values][@stdlib/assert/is-same-value].

## Installation

```bash
npm install @stdlib/assert-is-same-booleanarray
```

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 isSameBooleanArray = require( '@stdlib/assert-is-same-booleanarray' );
```

#### isSameBooleanArray( v1, v2 )

Tests if two arguments are both [BooleanArrays][@stdlib/array/bool] and have the [same values][@stdlib/assert/is-same-value].

```javascript
var BooleanArray = require( '@stdlib/array-bool' );

var x = new BooleanArray( [ true, false ] );
var y = new BooleanArray( [ true, false ] );
var bool = isSameBooleanArray( x, y );
// returns true

bool = isSameBooleanArray( x, [ true, false ] );
// returns false
```

## Examples

```javascript
var BooleanArray = require( '@stdlib/array-bool' );
var isSameBooleanArray = require( '@stdlib/assert-is-same-booleanarray' );

var x = new BooleanArray( [ true, false, false, true ] );
var y = new BooleanArray( [ true, false, false, true ] );
var out = isSameBooleanArray( x, y );
// returns true

x = new BooleanArray( [ true, false, false, true ] );
y = new BooleanArray( [ true, true, false, false ] );
out = isSameBooleanArray( x, y );
// returns false
```

* * *

## 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/assert-is-same-booleanarray.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-same-booleanarray

[test-image]: https://github.com/stdlib-js/assert-is-same-booleanarray/actions/workflows/test.yml/badge.svg?branch=v0.1.0
[test-url]: https://github.com/stdlib-js/assert-is-same-booleanarray/actions/workflows/test.yml?query=branch:v0.1.0

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-same-booleanarray/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-same-booleanarray?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/assert-is-same-booleanarray/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-is-same-booleanarray/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-is-same-booleanarray/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-is-same-booleanarray/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-is-same-booleanarray/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-is-same-booleanarray/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-is-same-booleanarray/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-same-booleanarray/main/LICENSE

[@stdlib/array/bool]: https://github.com/stdlib-js/array-bool

[@stdlib/assert/is-same-value]: https://github.com/stdlib-js/assert-is-same-value