it.unimi.dsi.fastutil.objects
Class Object2BooleanAVLTreeMap<K>

java.lang.Object
  it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction<K>
      it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap<K>
          it.unimi.dsi.fastutil.objects.AbstractObject2BooleanSortedMap<K>
              it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap<K>

All Implemented Interfaces:

Function<K,Boolean>, Object2BooleanFunction<K>, Object2BooleanMap<K>, Object2BooleanSortedMap<K>, Serializable, Cloneable, Map<K,Boolean>, SortedMap<K,Boolean>

public class Object2BooleanAVLTreeMap<K>
extends AbstractObject2BooleanSortedMap<K>
implements Serializable, Cloneable

A type-specific AVL 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.objects.AbstractObject2BooleanMap

AbstractObject2BooleanMap.BasicEntry<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2BooleanSortedMap

Object2BooleanSortedMap.FastSortedEntrySet<K>

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Object2BooleanMap

Object2BooleanMap.FastEntrySet<K>

Field Summary

static long

serialVersionUID

Constructor Summary

Object2BooleanAVLTreeMap()
Creates a new empty tree map.

Object2BooleanAVLTreeMap(Comparator<? super K> c)
Creates a new empty tree map with the given comparator.

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

Object2BooleanAVLTreeMap(K[] k, boolean[] v, Comparator<? super K> c)
Creates a new tree map using the elements of two parallel arrays and the given comparator.

Object2BooleanAVLTreeMap(Map<? extends K,? extends Boolean> m)
Creates a new tree map copying a given map.

Object2BooleanAVLTreeMap(Object2BooleanMap<? extends K> m)
Creates a new tree map copying a given map.

Object2BooleanAVLTreeMap(Object2BooleanSortedMap<K> m)
Creates a new tree map copying a given sorted map (and its Comparator).

Object2BooleanAVLTreeMap(SortedMap<K,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).
Object2BooleanAVLTreeMap<K>	clone() Returns a deep copy of this tree map.
Comparator<? super K>	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(Object k) Checks whether the given value is contained in AbstractObject2BooleanMap.keySet().
boolean	containsValue(boolean v) Checks whether the given value is contained in AbstractObject2BooleanMap.values().
K	firstKey()
Boolean	get(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
boolean	getBoolean(Object k) Returns the value to which the given key is mapped.
Object2BooleanSortedMap<K>	headMap(K to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
ObjectSortedSet<K>	keySet() Returns a type-specific sorted set view of the keys contained in this map.
K	lastKey()
ObjectSortedSet<Object2BooleanMap.Entry<K>>	object2BooleanEntrySet() Returns a type-specific sorted-set view of the mappings contained in this map.
boolean	put(K k, boolean v) Adds a pair to the map.
Boolean	put(K ok, Boolean ov) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
Boolean	remove(Object ok) Delegates to the corresponding type-specific method, taking care of returning null on a missing key.
boolean	removeBoolean(Object k) Removes the mapping with the given key.
int	size() Returns the intended number of keys in this function, or -1 if no such number exists.
Object2BooleanSortedMap<K>	subMap(K from, K to) Returns a view of the portion of this sorted map whose keys range from fromKey, inclusive, to toKey, exclusive.
Object2BooleanSortedMap<K>	tailMap(K 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.objects.AbstractObject2BooleanSortedMap

entrySet

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap

containsValue, equals, hashCode, putAll, toString

Methods inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanFunction

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2BooleanFunction

defaultReturnValue, defaultReturnValue

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, putAll

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap()

Creates a new empty tree map.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(Comparator<? super K> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(Map<? extends K,? extends Boolean> m)

Creates a new tree map copying a given map.

Parameters:

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

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(SortedMap<K,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.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(Object2BooleanMap<? extends K> m)

Creates a new tree map copying a given map.

Parameters:

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

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(Object2BooleanSortedMap<K> 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.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(K[] k,
                                boolean[] v,
                                Comparator<? super K> 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:

IllegalArgumentException - if k and v have different lengths.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(K[] 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:

IllegalArgumentException - if k and v have different lengths.

Method Detail

put

public boolean put(K k,
                   boolean v)

Description copied from interface: Object2BooleanFunction

Adds a pair to the map.

Specified by:

put in interface Object2BooleanFunction<K>

Overrides:

put in class AbstractObject2BooleanFunction<K>

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)

removeBoolean

public boolean removeBoolean(Object k)

Description copied from interface: Object2BooleanFunction

Removes the mapping with the given key.

Specified by:

removeBoolean in interface Object2BooleanFunction<K>

Overrides:

removeBoolean in class AbstractObject2BooleanFunction<K>

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 Boolean put(K ok,
                   Boolean ov)

Description copied from class: AbstractObject2BooleanFunction

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<K,Boolean>

Specified by:

put in interface Map<K,Boolean>

Overrides:

put in class AbstractObject2BooleanFunction<K>

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 Boolean remove(Object ok)

Description copied from class: AbstractObject2BooleanFunction

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<K,Boolean>

Specified by:

remove in interface Map<K,Boolean>

Overrides:

remove in class AbstractObject2BooleanFunction<K>

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: AbstractObject2BooleanMap

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

Specified by:

containsValue in interface Object2BooleanMap<K>

Overrides:

containsValue in class AbstractObject2BooleanMap<K>

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<K,Boolean>

Specified by:

clear in interface Map<K,Boolean>

Overrides:

clear in class AbstractObject2BooleanFunction<K>

See Also:

Map.clear()

containsKey

public boolean containsKey(Object k)

Description copied from class: AbstractObject2BooleanMap

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

Specified by:

containsKey in interface Function<K,Boolean>

Specified by:

containsKey in interface Map<K,Boolean>

Overrides:

containsKey in class AbstractObject2BooleanMap<K>

Parameters:

k - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.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<K,Boolean>

Specified by:

size in interface Map<K,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 Map<K,Boolean>

Overrides:

isEmpty in class AbstractObject2BooleanMap<K>

getBoolean

public boolean getBoolean(Object k)

Description copied from interface: Object2BooleanFunction

Returns the value to which the given key is mapped.

Specified by:

getBoolean in interface Object2BooleanFunction<K>

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)

get

public Boolean get(Object ok)

Description copied from class: AbstractObject2BooleanFunction

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:

get in interface Function<K,Boolean>

Specified by:

get in interface Map<K,Boolean>

Overrides:

get in class AbstractObject2BooleanFunction<K>

Parameters:

ok - the key.

Returns:

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

See Also:

Map.get(Object)

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,Boolean>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,Boolean>

object2BooleanEntrySet

public ObjectSortedSet<Object2BooleanMap.Entry<K>> object2BooleanEntrySet()

Description copied from interface: Object2BooleanSortedMap

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:

object2BooleanEntrySet in interface Object2BooleanMap<K>

Specified by:

object2BooleanEntrySet in interface Object2BooleanSortedMap<K>

Returns:

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

See Also:

Object2BooleanSortedMap.entrySet()

keySet

public ObjectSortedSet<K> 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 Object2BooleanMap<K>

Specified by:

keySet in interface Object2BooleanSortedMap<K>

Specified by:

keySet in interface Map<K,Boolean>

Specified by:

keySet in interface SortedMap<K,Boolean>

Overrides:

keySet in class AbstractObject2BooleanSortedMap<K>

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 Object2BooleanMap<K>

Specified by:

values in interface Object2BooleanSortedMap<K>

Specified by:

values in interface Map<K,Boolean>

Specified by:

values in interface SortedMap<K,Boolean>

Overrides:

values in class AbstractObject2BooleanSortedMap<K>

Returns:

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

See Also:

Map.values()

comparator

public Comparator<? super K> comparator()

Description copied from interface: Object2BooleanSortedMap

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 Object2BooleanSortedMap<K>

Specified by:

comparator in interface SortedMap<K,Boolean>

See Also:

SortedMap.comparator()

headMap

public Object2BooleanSortedMap<K> headMap(K to)

Description copied from interface: Object2BooleanSortedMap

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

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

Specified by:

headMap in interface Object2BooleanSortedMap<K>

Specified by:

headMap in interface SortedMap<K,Boolean>

See Also:

SortedMap.headMap(Object)

tailMap

public Object2BooleanSortedMap<K> tailMap(K from)

Description copied from interface: Object2BooleanSortedMap

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

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

Specified by:

tailMap in interface Object2BooleanSortedMap<K>

Specified by:

tailMap in interface SortedMap<K,Boolean>

See Also:

SortedMap.tailMap(Object)

subMap

public Object2BooleanSortedMap<K> subMap(K from,
                                         K to)

Description copied from interface: Object2BooleanSortedMap

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

Note that this specification strengthens the one given in SortedMap.subMap(Object,Object).

Specified by:

subMap in interface Object2BooleanSortedMap<K>

Specified by:

subMap in interface SortedMap<K,Boolean>

See Also:

SortedMap.subMap(Object,Object)

clone

public Object2BooleanAVLTreeMap<K> 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 Object

Returns:

a deep copy of this tree map.