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:

it.unimi.dsi.fastutil.objects.Object2BooleanFunction<K>, Object2BooleanMap<K>, Object2BooleanSortedMap<K>, java.io.Serializable, java.lang.Cloneable, java.util.function.Function<K,java.lang.Boolean>, java.util.function.Predicate<K>, java.util.Map<K,java.lang.Boolean>, java.util.SortedMap<K,java.lang.Boolean>

public class Object2BooleanAVLTreeMap<K>
extends AbstractObject2BooleanSortedMap<K>
implements java.io.Serializable, java.lang.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.AbstractObject2BooleanSortedMap

AbstractObject2BooleanSortedMap.KeySetIterator<K>, AbstractObject2BooleanSortedMap.ValuesCollection, AbstractObject2BooleanSortedMap.ValuesIterator<K>

Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.objects.AbstractObject2BooleanMap

AbstractObject2BooleanMap.BasicEntry<K>, AbstractObject2BooleanMap.BasicEntrySet<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

Fields

Modifier and Type	Field and Description
protected java.util.Comparator<? super K>	actualComparator This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.
protected int	count Number of entries in this map.
protected it.unimi.dsi.fastutil.objects.ObjectSortedSet<Object2BooleanMap.Entry<K>>	entries Cached set of entries.
protected it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap.Entry<K>	firstEntry The first key in this map.
protected it.unimi.dsi.fastutil.objects.ObjectSortedSet<K>	keys Cached set of keys.
protected it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap.Entry<K>	lastEntry The last key in this map.
protected boolean	modified The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.
protected java.util.Comparator<? super K>	storedComparator This map's comparator, as provided in the constructor.
protected it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap.Entry<K>	tree A reference to the root entry.
protected it.unimi.dsi.fastutil.booleans.BooleanCollection	values Cached collection of values.

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

defRetValue

Constructor Summary

Constructors

Constructor and Description
Object2BooleanAVLTreeMap() Creates a new empty tree map.
Object2BooleanAVLTreeMap(java.util.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, java.util.Comparator<? super K> c) Creates a new tree map using the elements of two parallel arrays and the given comparator.
Object2BooleanAVLTreeMap(java.util.Map<? extends K,? extends java.lang.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(java.util.SortedMap<K,java.lang.Boolean> m) Creates a new tree map copying a given sorted map (and its Comparator).

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
Object2BooleanAVLTreeMap<K>	clone() Returns a deep copy of this tree map.
java.util.Comparator<? super K>	comparator() Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.
boolean	containsKey(java.lang.Object k) Returns true if this function contains a mapping for the specified key.
boolean	containsValue(boolean v) Returns true if this map maps one or more keys to the specified value.
K	firstKey()
boolean	getBoolean(java.lang.Object k)
Object2BooleanSortedMap<K>	headMap(K to) Returns a view of the portion of this sorted map whose keys are strictly less than toKey.
boolean	isEmpty()
it.unimi.dsi.fastutil.objects.ObjectSortedSet<K>	keySet() Returns a type-specific sorted set view of the keys contained in this map.
K	lastKey()
it.unimi.dsi.fastutil.objects.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)
boolean	removeBoolean(java.lang.Object k)
int	size() Returns the number of key/value mappings in this map.
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.
it.unimi.dsi.fastutil.booleans.BooleanCollection	values() Returns a type-specific collection view of the values contained in this map.

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

equals, hashCode, putAll, toString

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

defaultReturnValue, defaultReturnValue

Methods inherited from class java.lang.Object

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

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

entrySet

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

computeBoolean, computeBooleanIfAbsent, computeBooleanIfAbsentPartial, computeBooleanIfPresent, computeIfAbsent, computeIfAbsent, containsValue, defaultReturnValue, defaultReturnValue, forEach, get, getOrDefault, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replace

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

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, test

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

apply

Methods inherited from interface java.util.function.Function

compose, identity

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

tree

protected transient it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap.Entry<K> tree

A reference to the root entry.

count

protected int count

Number of entries in this map.

firstEntry

protected transient it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap.Entry<K> firstEntry

The first key in this map.

lastEntry

protected transient it.unimi.dsi.fastutil.objects.Object2BooleanAVLTreeMap.Entry<K> lastEntry

The last key in this map.

entries

protected transient it.unimi.dsi.fastutil.objects.ObjectSortedSet<Object2BooleanMap.Entry<K>> entries

Cached set of entries.

keys

protected transient it.unimi.dsi.fastutil.objects.ObjectSortedSet<K> keys

Cached set of keys.

values

protected transient it.unimi.dsi.fastutil.booleans.BooleanCollection values

Cached collection of values.

modified

protected transient boolean modified

The value of this variable remembers, after a put() or a remove(), whether the domain of the map has been modified.

storedComparator

protected java.util.Comparator<? super K> storedComparator

This map's comparator, as provided in the constructor.

actualComparator

protected transient java.util.Comparator<? super K> actualComparator

This map's actual comparator; it may differ from storedComparator because it is always a type-specific comparator, so it could be derived from the former by wrapping.

Constructor Detail

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap()

Creates a new empty tree map.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(java.util.Comparator<? super K> c)

Creates a new empty tree map with the given comparator.

Parameters:

c - a (possibly type-specific) comparator.

Object2BooleanAVLTreeMap

public Object2BooleanAVLTreeMap(java.util.Map<? extends K,? 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.

Object2BooleanAVLTreeMap

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

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,
                                java.util.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:

java.lang.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:

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

Method Detail

put

public boolean put(K k,
                   boolean v)

Specified by:

put in interface it.unimi.dsi.fastutil.objects.Object2BooleanFunction<K>

removeBoolean

public boolean removeBoolean(java.lang.Object k)

Specified by:

removeBoolean in interface it.unimi.dsi.fastutil.objects.Object2BooleanFunction<K>

containsValue

public boolean containsValue(boolean v)

Description copied from class: AbstractObject2BooleanMap

Returns true if this map maps one or more keys to the specified value.

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

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Object2BooleanMap<K>

Specified by:

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

containsKey

public boolean containsKey(java.lang.Object k)

Description copied from class: AbstractObject2BooleanMap

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface Object2BooleanMap<K>

Specified by:

containsKey in interface java.util.Map<K,java.lang.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: Object2BooleanMap

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Object2BooleanMap<K>

Specified by:

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

Returns:

the number of key-value mappings in this map.

See Also:

Size64

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractObject2BooleanMap<K>

getBoolean

public boolean getBoolean(java.lang.Object k)

Specified by:

getBoolean in interface it.unimi.dsi.fastutil.objects.Object2BooleanFunction<K>

firstKey

public K firstKey()

Specified by:

firstKey in interface java.util.SortedMap<K,java.lang.Boolean>

lastKey

public K lastKey()

Specified by:

lastKey in interface java.util.SortedMap<K,java.lang.Boolean>

object2BooleanEntrySet

public it.unimi.dsi.fastutil.objects.ObjectSortedSet<Object2BooleanMap.Entry<K>> object2BooleanEntrySet()

Description copied from interface: Object2BooleanSortedMap

Returns a type-specific sorted-set view of the mappings contained in this 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 it.unimi.dsi.fastutil.objects.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 java.util.Map<K,java.lang.Boolean>

Specified by:

keySet in interface java.util.SortedMap<K,java.lang.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 it.unimi.dsi.fastutil.booleans.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 java.util.Map<K,java.lang.Boolean>

Specified by:

values in interface java.util.SortedMap<K,java.lang.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 java.util.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.

Specified by:

comparator in interface Object2BooleanSortedMap<K>

Specified by:

comparator in interface java.util.SortedMap<K,java.lang.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.

Specified by:

headMap in interface Object2BooleanSortedMap<K>

Specified by:

headMap in interface java.util.SortedMap<K,java.lang.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.

Specified by:

tailMap in interface Object2BooleanSortedMap<K>

Specified by:

tailMap in interface java.util.SortedMap<K,java.lang.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.

Specified by:

subMap in interface Object2BooleanSortedMap<K>

Specified by:

subMap in interface java.util.SortedMap<K,java.lang.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 java.lang.Object

Returns:

a deep copy of this tree map.