yuukinajima / sortedset

a simple sorted set implementation that allows a custom compare function

sortedset

A fast, simple sorted set implementation for javascript (browser and node) that allows a custom compare function.

Similar API to javascript's Set.

npm install sortedset

Compare Function

The compare function is the same thing that works with Array#sort().

• If compare(a, b) < 0, a comes before b.
• If compare(a, b) === 0, a and b are considered identical in the set.
• If compare(a, b) > 0, b comes before a.

If no compare function is provided, a default ascending comparator is used.

const SortedSet = require('sortedset')

const set = new SortedSet([2, 1, 3])

console.log(set.toArray()) // [1, 2, 3]

Or pass in a custom comparator.

const SortedSet = require('sortedset')

function reverse (a, b) {
  if (a === b) return 0
  return a < b ? 1 : -1
}

const set = new SortedSet([2, 1, 3], reverse)

console.log(set.toArray()) // [3, 2, 1]

API

Constructor:

• new SortedSet()
• new SortedSet([2, 1, 3])
• new SortedSet(customCompare)
• new SortedSet([2, 1, 3], customCompare)

Properties:

• SortedSet#size

Methods:

• SortedSet#add(item)
• SortedSet#delete(item) Note: Returns the deleted item if it existed, else undefined
• SortedSet#clear()
• SortedSet#has(item)
• SortedSet#toArray()