uk.co.omegaprime.btreemap

Class IntLongBTreeMap

java.lang.Object

uk.co.omegaprime.btreemap.IntLongBTreeMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Long>, java.util.NavigableMap<java.lang.Integer,java.lang.Long>, java.util.SortedMap<java.lang.Integer,java.lang.Long>

public class IntLongBTreeMap
extends java.lang.Object
implements java.util.NavigableMap<java.lang.Integer,java.lang.Long>

A B-tree based NavigableMap implementation for int keys and long values.

To get started, call create().

All values in the map are stored at leaf nodes, and all leaf nodes are at the same depth. This ensures that accesses to the map via e.g. get, put and remove all take log(n) time. In contrast to a balanced binary tree (like that used by TreeMap), each node may holds more than one key. This makes the datastructure more cache-friendly: you can expect it to be around 50% faster than TreeMap for workloads that do not fit in cache.

The map is sorted either according to the Comparable method of the key type, or via a user-supplied Comparator. This ordering should be consistent with equals.

The implementation is unsynchronized, and there are no guarantees as to what will happen if you make use of iterator that was created before some operation that modified the map.

Entry instances returned by this class are immutable and hence do not support the Entry#setValue(Object) method.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	ceilingEntry(int key) Returns the entry with smallest key greater than or equal to key, or null if no such entry exists
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	ceilingEntry(java.lang.Integer key)
java.lang.Integer	ceilingKey(int key) Returns the key of the entry returned by ceilingEntry(java.lang.Integer), or null if no such entry exists
java.lang.Integer	ceilingKey(java.lang.Integer key)
int	ceilingKeyInt(int key) Returns the key of the entry returned by ceilingEntry(java.lang.Integer), or the most negative int value if no such entry exists
void	clear()
IntComparator	comparator()
boolean	containsKey(int key) Returns true iff an entry exists in the map with the supplied key.
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
static IntLongBTreeMap	create() Create as empty BTreeMap that uses the natural order of the keys
static IntLongBTreeMap	create(java.util.Comparator<? super java.lang.Integer> comparator) Create an empty BTreeMap that uses a custom comparator on the keys.
static IntLongBTreeMap	create(IntComparator comparator) Create an empty BTreeMap that uses a custom comparator on the keys.
static IntLongBTreeMap	create(java.util.Map<? extends java.lang.Integer,? extends java.lang.Long> that) Create a new map that contains the same entries as the specified Map, and uses the natural ordering on the keys
static IntLongBTreeMap	create(java.util.SortedMap<java.lang.Integer,? extends java.lang.Long> that) Create a new map that contains the same entries as the specified SortedMap, and also shares a key ordering with it
java.util.NavigableSet<java.lang.Integer>	descendingKeySet()
java.util.NavigableMap<java.lang.Integer,java.lang.Long>	descendingMap()
java.util.Set<java.util.Map.Entry<java.lang.Integer,java.lang.Long>>	entrySet()
boolean	equals(java.lang.Object that)
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	firstEntry()
java.lang.Integer	firstKey()
int	firstKeyInt() Returns the key of the entry that would be returned by firstEntry()
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	floorEntry(int key) Returns entry with largest key less than or equal to key, or null if no such entry exists
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	floorEntry(java.lang.Integer key)
java.lang.Integer	floorKey(int key) Returns the key of the entry returned by floorEntry(java.lang.Integer), or null if no such entry exists
java.lang.Integer	floorKey(java.lang.Integer key)
int	floorKeyInt(int key) Returns the key of the entry returned by floorEntry(java.lang.Integer), or the most negative int value if no such entry exists
java.lang.Long	get(int key) Gets the value at the given key.
java.lang.Long	get(java.lang.Object key)
long	getLong(int key) Gets the value at the given key.
long	getLong(java.lang.Object key) Gets the value at the given key.
java.lang.Long	getOrDefault(int key, java.lang.Long dflt) Gets the value at the given key.
java.lang.Long	getOrDefault(java.lang.Object key, java.lang.Long dflt)
long	getOrDefaultLong(int key, long dflt) Gets the value at the given key.
long	getOrDefaultLong(java.lang.Object key, long dflt) Gets the value at the given key.
int	hashCode()
java.util.SortedMap<java.lang.Integer,java.lang.Long>	headMap(java.lang.Integer toKey)
java.util.NavigableMap<java.lang.Integer,java.lang.Long>	headMap(java.lang.Integer toKey, boolean inclusive)
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	higherEntry(int key) Returns the entry with smallest key strictly greater than key, or null if no such entry exists
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	higherEntry(java.lang.Integer key)
java.lang.Integer	higherKey(int key) Returns the key of the entry returned by higherEntry(java.lang.Integer), or null if no such entry exists
java.lang.Integer	higherKey(java.lang.Integer key)
int	higherKeyInt(int key) Returns the key of the entry returned by higherEntry(java.lang.Integer), or the most negative int value if no such entry exists
boolean	isEmpty()
java.util.NavigableSet<java.lang.Integer>	keySet()
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	lastEntry()
java.lang.Integer	lastKey()
int	lastKeyInt() Returns the key of the entry that would be returned by lastEntry()
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	lowerEntry(int key) Returns the entry with largest key strictly less than key, or null if no such entry exists
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	lowerEntry(java.lang.Integer key)
java.lang.Integer	lowerKey(int key) Returns the key of the entry returned by lowerEntry(java.lang.Integer), or null if no such entry exists
java.lang.Integer	lowerKey(java.lang.Integer key)
int	lowerKeyInt(int key) Returns the key of the entry returned by lowerEntry(java.lang.Integer), or the most negative int value if no such entry exists
java.util.NavigableSet<java.lang.Integer>	navigableKeySet()
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	pollFirstEntry()
java.util.Map.Entry<java.lang.Integer,java.lang.Long>	pollLastEntry()
java.lang.Long	put(java.lang.Integer key, java.lang.Long value)
java.lang.Long	put(int key, long value) Adds a new entry to the map, and returns the old value associated with this key.
void	putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Long> that)
long	putLong(int key, long value) Adds a new entry to the map, and returns the old value associated with this key.
java.lang.Long	remove(int key) Remove the entry with the specified key, returning the value of the removed entry.
java.lang.Long	remove(java.lang.Object key)
long	removeLong(int key) Remove the entry with the specified key, returning the value of the removed entry.
long	removeLong(java.lang.Object key) Remove the entry with the specified key, returning the value of the removed entry.
int	size()
java.util.NavigableMap<java.lang.Integer,java.lang.Long>	subMap(java.lang.Integer fromKey, boolean fromInclusive, java.lang.Integer toKey, boolean toInclusive)
java.util.SortedMap<java.lang.Integer,java.lang.Long>	subMap(java.lang.Integer fromKey, java.lang.Integer toKey)
java.util.SortedMap<java.lang.Integer,java.lang.Long>	tailMap(java.lang.Integer fromKey)
java.util.NavigableMap<java.lang.Integer,java.lang.Long>	tailMap(java.lang.Integer fromKey, boolean inclusive)
java.lang.String	toString()
java.util.Collection<java.lang.Long>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

create

public static IntLongBTreeMap create()

Create as empty BTreeMap that uses the natural order of the keys

create

public static IntLongBTreeMap create(java.util.Comparator<? super java.lang.Integer> comparator)

Create an empty BTreeMap that uses a custom comparator on the keys.

Parameters:

comparator - If null, the natural order of the keys will be used

create

public static IntLongBTreeMap create(IntComparator comparator)

Create an empty BTreeMap that uses a custom comparator on the keys.

Parameters:

comparator - If null, the natural order of the keys will be used

create

public static IntLongBTreeMap create(java.util.SortedMap<java.lang.Integer,? extends java.lang.Long> that)

Create a new map that contains the same entries as the specified SortedMap, and also shares a key ordering with it

create

public static IntLongBTreeMap create(java.util.Map<? extends java.lang.Integer,? extends java.lang.Long> that)

Create a new map that contains the same entries as the specified Map, and uses the natural ordering on the keys

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Integer,java.lang.Long>

comparator

public IntComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

putAll

public void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Long> that)

Specified by:

putAll in interface java.util.Map<java.lang.Integer,java.lang.Long>

get

public java.lang.Long get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Integer,java.lang.Long>

getLong

public long getLong(java.lang.Object key)

Gets the value at the given key. If no such value was found, returns the most negative long value.

get

public java.lang.Long get(int key)

Gets the value at the given key. If no such value was found, returns null.

getLong

public long getLong(int key)

Gets the value at the given key. If no such value was found, returns the most negative long value.

getOrDefault

public java.lang.Long getOrDefault(java.lang.Object key,
                                   java.lang.Long dflt)

Specified by:

getOrDefault in interface java.util.Map<java.lang.Integer,java.lang.Long>

getOrDefault

public java.lang.Long getOrDefault(int key,
                                   java.lang.Long dflt)

Gets the value at the given key. If no such value was found, returns the specified default.

getOrDefaultLong

public long getOrDefaultLong(java.lang.Object key,
                             long dflt)

Gets the value at the given key. If no such value was found, returns the most negative long value.

getOrDefaultLong

public long getOrDefaultLong(int key,
                             long dflt)

Gets the value at the given key. If no such value was found, returns the specified default.

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Integer,java.lang.Long>

containsKey

public boolean containsKey(int key)

Returns true iff an entry exists in the map with the supplied key.

put

public java.lang.Long put(int key,
                          long value)

Adds a new entry to the map, and returns the old value associated with this key. If no prior entry existed, returns null.

putLong

public long putLong(int key,
                    long value)

Adds a new entry to the map, and returns the old value associated with this key. If no prior entry existed, returns the most negative long value.

put

public java.lang.Long put(java.lang.Integer key,
                          java.lang.Long value)

Specified by:

put in interface java.util.Map<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if either the key or value are null

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.Integer,java.lang.Long>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Integer,java.lang.Long>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Integer,java.lang.Long>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object that)

Specified by:

equals in interface java.util.Map<java.lang.Integer,java.lang.Long>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.Integer,java.lang.Long>

Overrides:

hashCode in class java.lang.Object

lowerKey

public java.lang.Integer lowerKey(java.lang.Integer key)

Specified by:

lowerKey in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if the key is null

lowerKeyInt

public int lowerKeyInt(int key)

Returns the key of the entry returned by lowerEntry(java.lang.Integer), or the most negative int value if no such entry exists

lowerKey

public java.lang.Integer lowerKey(int key)

Returns the key of the entry returned by lowerEntry(java.lang.Integer), or null if no such entry exists

higherKey

public java.lang.Integer higherKey(java.lang.Integer key)

Specified by:

higherKey in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if the key is null

higherKeyInt

public int higherKeyInt(int key)

Returns the key of the entry returned by higherEntry(java.lang.Integer), or the most negative int value if no such entry exists

higherKey

public java.lang.Integer higherKey(int key)

Returns the key of the entry returned by higherEntry(java.lang.Integer), or null if no such entry exists

floorKey

public java.lang.Integer floorKey(java.lang.Integer key)

Specified by:

floorKey in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if the key is null

floorKeyInt

public int floorKeyInt(int key)

Returns the key of the entry returned by floorEntry(java.lang.Integer), or the most negative int value if no such entry exists

floorKey

public java.lang.Integer floorKey(int key)

Returns the key of the entry returned by floorEntry(java.lang.Integer), or null if no such entry exists

ceilingKey

public java.lang.Integer ceilingKey(java.lang.Integer key)

Specified by:

ceilingKey in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if the key is null

ceilingKeyInt

public int ceilingKeyInt(int key)

Returns the key of the entry returned by ceilingEntry(java.lang.Integer), or the most negative int value if no such entry exists

ceilingKey

public java.lang.Integer ceilingKey(int key)

Returns the key of the entry returned by ceilingEntry(java.lang.Integer), or null if no such entry exists

lowerEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> lowerEntry(java.lang.Integer key)

Specified by:

lowerEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if key is null

lowerEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> lowerEntry(int key)

Returns the entry with largest key strictly less than key, or null if no such entry exists

floorEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> floorEntry(java.lang.Integer key)

Specified by:

floorEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if key is null

floorEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> floorEntry(int key)

Returns entry with largest key less than or equal to key, or null if no such entry exists

ceilingEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> ceilingEntry(java.lang.Integer key)

Specified by:

ceilingEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if key is null

ceilingEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> ceilingEntry(int key)

Returns the entry with smallest key greater than or equal to key, or null if no such entry exists

higherEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> higherEntry(java.lang.Integer key)

Specified by:

higherEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Throws:

java.lang.NullPointerException - if key is null

higherEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> higherEntry(int key)

Returns the entry with smallest key strictly greater than key, or null if no such entry exists

firstEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> firstEntry()

Specified by:

firstEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

lastEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> lastEntry()

Specified by:

lastEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

pollFirstEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> pollFirstEntry()

Specified by:

pollFirstEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

pollLastEntry

public java.util.Map.Entry<java.lang.Integer,java.lang.Long> pollLastEntry()

Specified by:

pollLastEntry in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

descendingMap

public java.util.NavigableMap<java.lang.Integer,java.lang.Long> descendingMap()

Specified by:

descendingMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

navigableKeySet

public java.util.NavigableSet<java.lang.Integer> navigableKeySet()

Specified by:

navigableKeySet in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

descendingKeySet

public java.util.NavigableSet<java.lang.Integer> descendingKeySet()

Specified by:

descendingKeySet in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

subMap

public java.util.NavigableMap<java.lang.Integer,java.lang.Long> subMap(java.lang.Integer fromKey,
                                                                       boolean fromInclusive,
                                                                       java.lang.Integer toKey,
                                                                       boolean toInclusive)

Specified by:

subMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

headMap

public java.util.NavigableMap<java.lang.Integer,java.lang.Long> headMap(java.lang.Integer toKey,
                                                                        boolean inclusive)

Specified by:

headMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

tailMap

public java.util.NavigableMap<java.lang.Integer,java.lang.Long> tailMap(java.lang.Integer fromKey,
                                                                        boolean inclusive)

Specified by:

tailMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

subMap

public java.util.SortedMap<java.lang.Integer,java.lang.Long> subMap(java.lang.Integer fromKey,
                                                                    java.lang.Integer toKey)

Specified by:

subMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Specified by:

subMap in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

headMap

public java.util.SortedMap<java.lang.Integer,java.lang.Long> headMap(java.lang.Integer toKey)

Specified by:

headMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Specified by:

headMap in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

tailMap

public java.util.SortedMap<java.lang.Integer,java.lang.Long> tailMap(java.lang.Integer fromKey)

Specified by:

tailMap in interface java.util.NavigableMap<java.lang.Integer,java.lang.Long>

Specified by:

tailMap in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

firstKey

public java.lang.Integer firstKey()

Specified by:

firstKey in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

firstKeyInt

public int firstKeyInt()

Returns the key of the entry that would be returned by firstEntry()

Throws:

java.util.NoSuchElementException - if the map is empty

lastKey

public java.lang.Integer lastKey()

Specified by:

lastKey in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

lastKeyInt

public int lastKeyInt()

Returns the key of the entry that would be returned by lastEntry()

Throws:

java.util.NoSuchElementException - if the map is empty

keySet

public java.util.NavigableSet<java.lang.Integer> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Integer,java.lang.Long>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

values

public java.util.Collection<java.lang.Long> values()

Specified by:

values in interface java.util.Map<java.lang.Integer,java.lang.Long>

Specified by:

values in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Integer,java.lang.Long>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.Integer,java.lang.Long>

Specified by:

entrySet in interface java.util.SortedMap<java.lang.Integer,java.lang.Long>

removeLong

public long removeLong(java.lang.Object key)

Remove the entry with the specified key, returning the value of the removed entry. If no such entry existed, returns the most negative long value.

removeLong

public long removeLong(int key)

Remove the entry with the specified key, returning the value of the removed entry. If no such entry existed, returns the most negative long value.

remove

public java.lang.Long remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Integer,java.lang.Long>

remove

public java.lang.Long remove(int key)

Remove the entry with the specified key, returning the value of the removed entry. If no such entry existed, returns null.