aleclarson/sortedarray

A sorted array for Javascript

SortedArray v1.0.0

• Uses binary search

• Supports custom compare(a, b)

• For exact matches, you must return 0 in your custom compare(a, b)

const SortedArray = require('sorted-array')

const sorted = SortedArray(array, compare)

// Get the sorted items
sorted.array

// Insert the item at its sorted index (using `this.compare`)
sorted.insert(item)

// Remove the item (using `this.compare`)
sorted.remove(item)

// Find the item's sorted index (using `this.compare`)
sorted.search(item)

Unique comparison

When using a custom compare(a, b), it's important to compare with values that are guaranteed to be unique.

Otherwise, this.remove() and this.search() can yield "false positives". For example, let's say every item in this.array is unique. But our custom compare function uses a property of each item that is not guaranteed to be unique. Now, you run the risk of this.remove() or this.search() finding the "wrong item".