it.unimi.dsi.fastutil.ints
Class Int2BooleanRBTreeMap

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractInt2BooleanFunction
      it.unimi.dsi.fastutil.ints.AbstractInt2BooleanMap
          it.unimi.dsi.fastutil.ints.AbstractInt2BooleanSortedMap
              it.unimi.dsi.fastutil.ints.Int2BooleanRBTreeMap

All Implemented Interfaces:

Function<java.lang.Integer,java.lang.Boolean>, Int2BooleanFunction, Int2BooleanMap, Int2BooleanSortedMap, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Integer,java.lang.Boolean>, java.util.SortedMap<java.lang.Integer,java.lang.Boolean>

public class Int2BooleanRBTreeMap
extends AbstractInt2BooleanSortedMap
implements java.io.Serializable, java.lang.Cloneable

A type-specific red-black tree map with a fast, small-footprint implementation.

The iterators provided by the views of this class are type-specific bidirectional iterators. Moreover, the iterator returned by iterator() can be safely cast to a type-specific list iterator.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2BooleanMap

AbstractInt2BooleanMap.BasicEntry

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2BooleanSortedMap

Int2BooleanSortedMap.FastSortedEntrySet

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2BooleanMap

Int2BooleanMap.FastEntrySet

Constructor Summary

Int2BooleanRBTreeMap()
Creates a new empty tree map.

Int2BooleanRBTreeMap(java.util.Comparator<? super java.lang.Integer> c)
Creates a new empty tree map with the given comparator.

Int2BooleanRBTreeMap(int[] k, boolean[] v)
Creates a new tree map using the elements of two parallel arrays.

Int2BooleanRBTreeMap(int[] k, boolean[] v, java.util.Comparator<? super java.lang.Integer> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Int2BooleanRBTreeMap(Int2BooleanMap m)
Creates a new tree map copying a given map.

Int2BooleanRBTreeMap(Int2BooleanSortedMap m)
Creates a new tree map copying a given sorted map (and its Comparator).

Int2BooleanRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Boolean> m)
Creates a new tree map copying a given map.

Int2BooleanRBTreeMap(java.util.SortedMap<java.lang.Integer,java.lang.Boolean> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

void	clear() Removes all associations from this function (optional operation).
Int2BooleanRBTreeMap	clone() Returns a deep copy of this tree map.
IntComparator	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(int k) Checks whether the given value is contained in AbstractInt2BooleanMap.keySet().
boolean	containsValue(boolean v) Checks whether the given value is contained in AbstractInt2BooleanMap.values().
int	firstIntKey()
boolean	get(int k) Returns the value to which the given key is mapped.
Int2BooleanSortedMap	headMap(int to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
ObjectSortedSet<Int2BooleanMap.Entry>	int2BooleanEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
boolean	isEmpty()
IntSortedSet	keySet() Returns a type-specific sorted set view of the keys contained in this map.
int	lastIntKey()
boolean	put(int k, boolean v) Adds a pair to the map.
java.lang.Boolean	put(java.lang.Integer ok, java.lang.Boolean ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
boolean	remove(int k) Removes the mapping with the given key.
java.lang.Boolean	remove(java.lang.Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
Int2BooleanSortedMap	subMap(int from, int to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Int2BooleanSortedMap	tailMap(int from) Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.
BooleanCollection	values() Returns a type-specific collection view of the values contained in this map.

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2BooleanSortedMap

entrySet, firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2BooleanMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2BooleanFunction

containsKey, defaultReturnValue, defaultReturnValue, get

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2BooleanFunction

defaultReturnValue, defaultReturnValue

Methods inherited from interface it.unimi.dsi.fastutil.Function

containsKey, get

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, putAll

Constructor Detail

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap()

Creates a new empty tree map.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(java.util.Comparator<? super java.lang.Integer> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Boolean> m)

Creates a new tree map copying a given map.

Parameters:

m - a Map to be copied into the new tree map.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(java.util.SortedMap<java.lang.Integer,java.lang.Boolean> m)

Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:

m - a SortedMap to be copied into the new tree map.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(Int2BooleanMap m)

Creates a new tree map copying a given map.

Parameters:

m - a type-specific map to be copied into the new tree map.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(Int2BooleanSortedMap m)

Creates a new tree map copying a given sorted map (and its Comparator).

Parameters:

m - a type-specific sorted map to be copied into the new tree map.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(int[] k,
                            boolean[] v,
                            java.util.Comparator<? super java.lang.Integer> c)

Creates a new tree map using the elements of two parallel arrays and the given comparator.

Parameters:

k - the array of keys of the new tree map.

v - the array of corresponding values in the new tree map.

c - a (possibly type-specific) comparator.

Throws:

java.lang.IllegalArgumentException - if k and v have different lengths.

Int2BooleanRBTreeMap

public Int2BooleanRBTreeMap(int[] k,
                            boolean[] v)

Creates a new tree map using the elements of two parallel arrays.

Parameters:

k - the array of keys of the new tree map.

v - the array of corresponding values in the new tree map.

Throws:

java.lang.IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public boolean put(int k,
                   boolean v)

Description copied from interface: Int2BooleanFunction

Adds a pair to the map.

Specified by:

put in interface Int2BooleanFunction

Overrides:

put in class AbstractInt2BooleanFunction

Parameters:

k - the key.

v - the value.

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.put(Object,Object)

remove

public boolean remove(int k)

Description copied from interface: Int2BooleanFunction

Removes the mapping with the given key.

Specified by:

remove in interface Int2BooleanFunction

Overrides:

remove in class AbstractInt2BooleanFunction

Returns:

the old value, or the default return value if no value was present for the given key.

See Also:

Function.remove(Object)

put

public java.lang.Boolean put(java.lang.Integer ok,
                             java.lang.Boolean ov)

Description copied from class: AbstractInt2BooleanFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

put in interface Function<java.lang.Integer,java.lang.Boolean>

Specified by:

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

Overrides:

put in class AbstractInt2BooleanFunction

Parameters:

ok - the key.

ov - the value.

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.put(Object,Object)

remove

public java.lang.Boolean remove(java.lang.Object ok)

Description copied from class: AbstractInt2BooleanFunction

Delegates to the corresponding type-specific method, taking care of returning null on a missing key.

This method must check whether the provided key is in the map using containsKey(). Thus, it probes the map twice. Implementors of subclasses should override it with a more efficient method.

Specified by:

remove in interface Function<java.lang.Integer,java.lang.Boolean>

Specified by:

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

Overrides:

remove in class AbstractInt2BooleanFunction

Returns:

the old value, or null if no value was present for the given key.

See Also:

Map.remove(Object)

containsValue

public boolean containsValue(boolean v)

Description copied from class: AbstractInt2BooleanMap

Checks whether the given value is contained in AbstractInt2BooleanMap.values().

Specified by:

containsValue in interface Int2BooleanMap

Overrides:

containsValue in class AbstractInt2BooleanMap

See Also:

Map.containsValue(Object)

clear

public void clear()

Description copied from interface: Function

Removes all associations from this function (optional operation).

Specified by:

clear in interface Function<java.lang.Integer,java.lang.Boolean>

Specified by:

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

Overrides:

clear in class AbstractInt2BooleanFunction

See Also:

Map.clear()

containsKey

public boolean containsKey(int k)

Description copied from class: AbstractInt2BooleanMap

Checks whether the given value is contained in AbstractInt2BooleanMap.keySet().

Specified by:

containsKey in interface Int2BooleanFunction

Overrides:

containsKey in class AbstractInt2BooleanMap

See Also:

Function.containsKey(Object)

size

public int size()

Description copied from interface: Function

Returns the intended number of keys in this function, or -1 if no such number exists.

Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.

Specified by:

size in interface Function<java.lang.Integer,java.lang.Boolean>

Specified by:

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

Returns:

the intended number of keys in this function, or -1 if that number is not available.

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractInt2BooleanMap

get

public boolean get(int k)

Description copied from interface: Int2BooleanFunction

Returns the value to which the given key is mapped.

Specified by:

get in interface Int2BooleanFunction

Parameters:

k - the key.

Returns:

the corresponding value, or the default return value if no value was present for the given key.

See Also:

Function.get(Object)

firstIntKey

public int firstIntKey()

Specified by:

firstIntKey in interface Int2BooleanSortedMap

See Also:

SortedMap.firstKey()

lastIntKey

public int lastIntKey()

Specified by:

lastIntKey in interface Int2BooleanSortedMap

See Also:

SortedMap.lastKey()

int2BooleanEntrySet

public ObjectSortedSet<Int2BooleanMap.Entry> int2BooleanEntrySet()

Description copied from interface: Int2BooleanSortedMap

Returns a type-specific sorted-set view of the mappings contained in this map. Note that this specification strengthens the one given in the corresponding type-specific unsorted map.

Specified by:

int2BooleanEntrySet in interface Int2BooleanMap

Specified by:

int2BooleanEntrySet in interface Int2BooleanSortedMap

Returns:

a type-specific sorted-set view of the mappings contained in this map.

See Also:

Int2BooleanSortedMap.entrySet()

keySet

public IntSortedSet keySet()

Returns a type-specific sorted set view of the keys contained in this map.

In addition to the semantics of Map.keySet(), you can safely cast the set returned by this call to a type-specific sorted set interface.

Specified by:

keySet in interface Int2BooleanMap

Specified by:

keySet in interface Int2BooleanSortedMap

Specified by:

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

Specified by:

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

Overrides:

keySet in class AbstractInt2BooleanSortedMap

Returns:

a type-specific sorted set view of the keys contained in this map.

See Also:

Map.keySet()

values

public BooleanCollection values()

Returns a type-specific collection view of the values contained in this map.

In addition to the semantics of Map.values(), you can safely cast the collection returned by this call to a type-specific collection interface.

Specified by:

values in interface Int2BooleanMap

Specified by:

values in interface Int2BooleanSortedMap

Specified by:

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

Specified by:

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

Overrides:

values in class AbstractInt2BooleanSortedMap

Returns:

a type-specific collection view of the values contained in this map.

See Also:

Map.values()

comparator

public IntComparator comparator()

Description copied from interface: Int2BooleanSortedMap

Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.

Note that this specification strengthens the one given in SortedMap.comparator().

Specified by:

comparator in interface Int2BooleanSortedMap

Specified by:

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

See Also:

SortedMap.comparator()

headMap

public Int2BooleanSortedMap headMap(int to)

Description copied from interface: Int2BooleanSortedMap

Returns a view of the portion of this sorted map whose keys are strictly less than toKey.

Specified by:

headMap in interface Int2BooleanSortedMap

See Also:

SortedMap.headMap(Object)

tailMap

public Int2BooleanSortedMap tailMap(int from)

Description copied from interface: Int2BooleanSortedMap

Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey.

Specified by:

tailMap in interface Int2BooleanSortedMap

See Also:

SortedMap.tailMap(Object)

subMap

public Int2BooleanSortedMap subMap(int from,
                                   int to)

Description copied from interface: Int2BooleanSortedMap

Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.

Specified by:

subMap in interface Int2BooleanSortedMap

See Also:

SortedMap.subMap(Object,Object)

clone

public Int2BooleanRBTreeMap clone()

Returns a deep copy of this tree map.

This method performs a deep copy of this tree map; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of this tree map.