Miss any of our Open RFC calls?Watch the recordings here! »

allclose

1.1.1 • Public • Published

allclose

Compare numbers, arrays, or nested arrays for equality up to some tolerance. Checks both shapes and values. Uses almost-equal and generalizes array-almost-equal. Useful when working with lists of coordinates and other numerical data.

js-standard-style

install

use npm

npm install allclose

usage

allclose(a, b, [atol], [rtol])

requires two numbers or arrays or nested arrays a and b, and optionally an absolute tolerance atol and a relative tolerance rtol. returns true if a and b have the same shape and value, and false otherwise.

examples

you can test numbers

allclose(1, 1)
> true
 
allclose(1, 2)
> false

or arrays

allclose([1, 2], [1, 2])
> true
 
allclose([1, 2], [1, 2, 3])
> false
 
allclose([1, 2], [1, 3])
> false

or nested arrays

allclose([[1, 2], [3, 4]], [[1, 2], [3, 4]])
> true
 
allclose([[1, 2], [3, 4]], [[1, 2], [3, 4], [5, 6]])
> false
 
allclose([[1, 2], [3, 4]], [[1, 2], [3, 5]])
> false

and you can optionally specify a tolerance

allclose([1, 2], [1, 2.1])
> false
 
allclose([1, 2], [1, 2.1], 0.2)
> true

Install

npm i allclose

DownloadsWeekly Downloads

3

Version

1.1.1

License

MIT

Last publish

Collaborators

  • avatar