JSPM – @thi.ng/arrays@0.10.15

Package Exports

@thi.ng/arrays

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@thi.ng/arrays) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm downloads

This project is part of the @thi.ng/umbrella monorepo.

About
- Status
Installation
Dependencies
API
- Binary search result predicates
Authors
License

About

Array / Arraylike utilities.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/arrays

// ES module
<script type="module" src="https://unpkg.com/@thi.ng/arrays?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/arrays/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 2.08 KB / CJS: 2.27 KB / UMD: 2.23 KB

Dependencies

API

Generated API docs

Binary search result predicates

The following predicates can be used to perform predecessor / successor queries using binarySearch().

bsLT() - Returns index of last item less than search value or -1 if no such values exist
bsLE() - Similar to bsLT(), but for less-than-equals queries
bsGT() - Returns index of first item greater than search value or -1 if no such values exist
bsGE() - Similar to bsGT(), but for less-than-equals queries
bsEQ() - Merely syntax sugar, casting any non-found result indices to -1

const src = [10, 20, 30, 40];

bsLT(binarySearch(src, 25))
// 1

// greater-than queries also require the array length

bsGT(binarySearch(src, 25), src.length)
// 2

bsGT(binarySearch(src, 40), src.length)
// -1

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-arrays,
  title = "@thi.ng/arrays",
  author = "Karsten Schmidt",
  note = "https://thi.ng/arrays",
  year = 2018
}

@thi.ng/arrays