# boundary

> Provides boundary functions, (upper-bound and lower-bound).

Latest version **2.0.0** (published 2023-01-07) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install boundary
pnpm add boundary
yarn add boundary
bun add boundary
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-01-07 |
| First published | 2014-12-27 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Yusuke SUZUKI |
| Maintainers | constellation, azu |
| Keywords | algorithm |

## Links

- npm: https://www.npmjs.com/package/boundary
- Repository: https://github.com/textlint/boundary
- Issues: https://github.com/textlint/boundary/issues
- npm.io page: https://npm.io/package/boundary

## Recent versions

- 2.0.0 (latest) — 2023-01-07
- 1.0.1 — 2014-12-27

## README

# boundary [![Actions Status: test](https://github.com/textlint/boundary/workflows/test/badge.svg)](https://github.com/textlint/boundary/actions?query=workflow%3A"test")

## About

Provides binary search functions.

## Installation

```sh
npm install boundary
```

## Usage

```js
import boundary from 'boundary';
function lessThan(v1, v2) {
    return v1 < v2;
}

// boundary.upperBound(sortedArray, value, compare = lessThan);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], -1) === 0);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], 0) === 2);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], 1) === 2);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], 2) === 3);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], 3) === 4);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], 4) === 5);
assert(boundary.upperBound([ 0, 0, 2, 3, 4 ], 5) === 5);

// boundary.lowerBound(sortedArray, value, compare = lessThan);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], -1) === 0);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], 0) === 0);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], 1) === 2);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], 2) === 2);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], 3) === 3);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], 4) === 4);
assert(boundary.lowerBound([ 0, 0, 2, 3, 4 ], 5) === 5);

// boundary.binarySearch(sortedArray, value, compare = lessThan);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], -1) === false);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], 0) === true);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], 1) === false);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], 2) === true);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], 3) === true);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], 4) === true);
assert(boundary.binarySearch([ 0, 0, 2, 3, 4 ], 5) === false);
```

### License

Copyright (C) 2012-2014 [Yusuke Suzuki](http://github.com/Constellation)
 (twitter: [@Constellation](http://twitter.com/Constellation)) and other contributors.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---
_Source: https://npm.io/package/boundary · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._