Package com.github.marschall.rangetree

Class LLRBRangeTree<K extends Comparable<? super K>,V>

java.lang.Object

com.github.marschall.rangetree.LLRBRangeTree<K,V>

Type Parameters:

K - the type of keys in this tree

V - the type of values in this tree

All Implemented Interfaces:

RangeMap<K,V>

public final class LLRBRangeTree<K extends Comparable<? super K>,V>
extends Object
implements RangeMap<K,V>

A range tree implementation based on a left-leaning red-black tree.

This object in not thread-safe.

Adjacency

The implementation currency does not do any adjacency testing and merging. In theory we have the two adjacent ranges that map to the same object we can merge them.

See Also:

Left-leaning Red-Black Trees

Constructor Summary

Constructors

Constructor	Description
LLRBRangeTree()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all mappings from this object.
V	computeIfAbsent(K key, Function<? super K,Map.Entry<Range<? extends K>,? extends V>> mappingFunction)	Looks up a value associated with a key.
V	get(K key)	Returns the value associated with a key.
void	put(K low, K high, V value)	Associates a range of keys with a value.
V	putIfAbsent(K low, K high, V value)	Associates a range of keys with a value only if no existing mapping exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LLRBRangeTree

public LLRBRangeTree()

Default constructor.

Method Detail

clear

public void clear()

Description copied from interface: RangeMap

Removes all mappings from this object.

Specified by:

clear in interface RangeMap<K extends Comparable<? super K>,V>

See Also:

Map.clear()

get

public V get(K key)

Description copied from interface: RangeMap

Returns the value associated with a key.

Specified by:

get in interface RangeMap<K extends Comparable<? super K>,V>

Parameters:

key - the key for which to look up a value, not null

Returns:

the value associated with key or null if not found

See Also:

Map.get(Object)

computeIfAbsent

public V computeIfAbsent(K key,
                         Function<? super K,Map.Entry<Range<? extends K>,? extends V>> mappingFunction)

Description copied from interface: RangeMap

Looks up a value associated with a key. If none is found the mapping function is applied. If the mapping produces a not null value then the mapping is created.

Specified by:

computeIfAbsent in interface RangeMap<K extends Comparable<? super K>,V>

Parameters:

key - the key for which to look up a value, not null

mappingFunction - the mapping function to apply if no value has been found, not null

Returns:

the value associated with key or null if not found

See Also:

Map.computeIfAbsent(Object, Function), AbstractMap.SimpleImmutableEntry

put

public void put(K low,
                K high,
                V value)

Description copied from interface: RangeMap

Associates a range of keys with a value.

Specified by:

put in interface RangeMap<K extends Comparable<? super K>,V>

Parameters:

low - the lower end of the range, inclusive, not null

high - the upper end of the range, inclusive, not null

value - the value to associate, possibly null

See Also:

Map.put(Object, Object)

putIfAbsent

public V putIfAbsent(K low,
                     K high,
                     V value)

Description copied from interface: RangeMap

Associates a range of keys with a value only if no existing mapping exists.

Specified by:

putIfAbsent in interface RangeMap<K extends Comparable<? super K>,V>

Parameters:

low - the lower end of the range, inclusive, not null

high - the upper end of the range, inclusive, not null

value - the value to associate, possibly null

Returns:

the value mapped to the key range before this method was called

See Also:

Map.putIfAbsent(Object, Object)