Package io.github.douira.glsl_transformer.ast.query

Class DuplicatorTrie<E>

java.lang.Object

java.util.AbstractMap<K,V>

org.apache.commons.collections4.trie.AbstractBitwiseTrie<K,V>

org.apache.commons.collections4.trie.PatriciaTrie<E>

io.github.douira.glsl_transformer.ast.query.DuplicatorTrie<E>

All Implemented Interfaces:

Serializable, Map<String,E>, SortedMap<String,E>, Get<String,E>, IterableGet<String,E>, IterableMap<String,E>, IterableSortedMap<String,E>, OrderedMap<String,E>, Put<String,E>, Trie<String,E>

Direct Known Subclasses:

PermutermTrie, PrefixSuffixTrie

public abstract class DuplicatorTrie<E>
extends PatriciaTrie<E>

Base class for trie variants that insert more than one entry per key.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DuplicatorTrie.Holder<V>

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final char	DEFAULT_MARKER
protected final char	marker
protected int	modCount	The number of times this Trie has been modified.

Constructor Summary

Constructors

Constructor	Description
DuplicatorTrie()
DuplicatorTrie(char marker)
DuplicatorTrie(Map<? extends String,? extends E> m)
DuplicatorTrie(Map<? extends String,? extends E> m, char marker)

Method Summary

Modifier and Type	Method	Description
void	clear()
Comparator<? super String>	comparator()
boolean	containsKey(Object k)
protected Stream<E>	distinctPrefixQuery(String prefix)
Set<Map.Entry<String,E>>	entrySet()
String	firstKey()	Gets the first key currently in this map.
E	get(Object k)
SortedMap<String,E>	headMap(String toKey)
protected abstract void	iterateKeyVariations(String key, Consumer<String> consumer)
Set<String>	keySet()
String	lastKey()	Gets the last key currently in this map.
OrderedMapIterator<String,E>	mapIterator()	Obtains an OrderedMapIterator over the map.
String	nextKey(String key)	Gets the next key after the one specified.
SortedMap<String,E>	prefixMap(String key)	Returns a view of this Trie of all elements that are prefixed by the given key.
SortedMap<String,E>	prefixMapRaw(String key)
protected String	prepareKey(Object k)
String	previousKey(String key)	Gets the previous key before the one specified.
E	put(String key, E value)	Note that the return type is Object, rather than V as in the Map interface.
E	remove(Object k)
protected String	sanitizeKey(String key)
Map.Entry<String,E>	select(String key)	Returns the Map.Entry whose key is closest in a bitwise XOR metric to the given key.
String	selectKey(String key)	Returns the key that is closest in a bitwise XOR metric to the provided key.
E	selectValue(String key)	Returns the value whose key is closest in a bitwise XOR metric to the provided key.
int	size()
SortedMap<String,E>	subMap(String fromKey, String toKey)
SortedMap<String,E>	tailMap(String fromKey)
Collection<E>	values()

Methods inherited from class org.apache.commons.collections4.trie.AbstractBitwiseTrie

getKeyAnalyzer, toString

Methods inherited from class java.util.AbstractMap

clone, containsValue, equals, hashCode, isEmpty, putAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.collections4.Get

containsValue, isEmpty

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface org.apache.commons.collections4.Put

putAll

Field Details

DEFAULT_MARKER

public static final char DEFAULT_MARKER

See Also:

• Constant Field Values

marker

protected final char marker

modCount

protected transient int modCount

The number of times this Trie has been modified. It's used to detect concurrent modifications and fail-fast the Iterators.

Constructor Details

DuplicatorTrie

public DuplicatorTrie()

DuplicatorTrie

public DuplicatorTrie(Map<? extends String,? extends E> m)

DuplicatorTrie

public DuplicatorTrie(char marker)

DuplicatorTrie

public DuplicatorTrie(Map<? extends String,? extends E> m,
 char marker)

Method Details

iterateKeyVariations

protected abstract void iterateKeyVariations(String key,
 Consumer<String> consumer)

prepareKey

protected String prepareKey(Object k)

sanitizeKey

protected String sanitizeKey(String key)

containsKey

public boolean containsKey(Object k)

Specified by:

containsKey in interface Get<String,E>

Specified by:

containsKey in interface Map<String,E>

Parameters:

k - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

See Also:

• Map.containsKey(Object)

get

public E get(Object k)

Specified by:

get in interface Get<String,E>

Specified by:

get in interface Map<String,E>

Parameters:

k - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

See Also:

• Map.get(Object)

headMap

public SortedMap<String,E> headMap(String toKey)

Specified by:

headMap in interface SortedMap<String,E>

nextKey

public String nextKey(String key)

Description copied from interface: OrderedMap

Gets the next key after the one specified.

Specified by:

nextKey in interface OrderedMap<String,E>

Parameters:

key - the key to search for next from

Returns:

the next key, null if no match or at end

prefixMap

public SortedMap<String,E> prefixMap(String key)

Description copied from interface: Trie

Returns a view of this Trie of all elements that are prefixed by the given key.

In a Trie with fixed size keys, this is essentially a Map.get(Object) operation.

For example, if the Trie contains 'Anna', 'Anael', 'Analu', 'Andreas', 'Andrea', 'Andres', and 'Anatole', then a lookup of 'And' would return 'Andreas', 'Andrea', and 'Andres'.

Specified by:

prefixMap in interface Trie<String,E>

Parameters:

key - the key used in the search

Returns:

a SortedMap view of this Trie with all elements whose key is prefixed by the search key

prefixMapRaw

public SortedMap<String,E> prefixMapRaw(String key)

previousKey

public String previousKey(String key)

Description copied from interface: OrderedMap

Gets the previous key before the one specified.

Specified by:

previousKey in interface OrderedMap<String,E>

Parameters:

key - the key to search for previous from

Returns:

the previous key, null if no match or at start

put

public E put(String key,
 E value)

Description copied from interface: Put

Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.

Specified by:

put in interface Map<String,E>

Specified by:

put in interface Put<String,E>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

See Also:

• Map.put(Object, Object)

remove

public E remove(Object k)

Specified by:

remove in interface Get<String,E>

Specified by:

remove in interface Map<String,E>

Parameters:

k - key whose mapping is to be removed from the map

Returns:

the previous value associated with key, or null if there was no mapping for key.

See Also:

• Map.remove(Object)

select

public Map.Entry<String,E> select(String key)

Returns the Map.Entry whose key is closest in a bitwise XOR metric to the given key. This is NOT lexicographic closeness. For example, given the keys:

1. D = 1000100
2. H = 1001000
3. L = 1001100

If the Trie contained 'H' and 'L', a lookup of 'D' would return 'L', because the XOR distance between D & L is smaller than the XOR distance between D & H.

Parameters:

key - the key to use in the search

Returns:

the Map.Entry whose key is closest in a bitwise XOR metric to the provided key

selectKey

public String selectKey(String key)

Returns the key that is closest in a bitwise XOR metric to the provided key. This is NOT lexicographic closeness! For example, given the keys:

1. D = 1000100
2. H = 1001000
3. L = 1001100

If the Trie contained 'H' and 'L', a lookup of 'D' would return 'L', because the XOR distance between D & L is smaller than the XOR distance between D & H.

Parameters:

key - the key to use in the search

Returns:

the key that is closest in a bitwise XOR metric to the provided key

subMap

public SortedMap<String,E> subMap(String fromKey,
 String toKey)

Specified by:

subMap in interface SortedMap<String,E>

tailMap

public SortedMap<String,E> tailMap(String fromKey)

Specified by:

tailMap in interface SortedMap<String,E>

distinctPrefixQuery

protected Stream<E> distinctPrefixQuery(String prefix)

clear

public void clear()

Specified by:

clear in interface Map<K,V>

Specified by:

clear in interface Put<K,V>

Overrides:

clear in class AbstractMap<K,V>

See Also:

• Map.clear()

size

public int size()

Specified by:

size in interface Get<K,V>

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

Returns:

the number of key-value mappings in this map

See Also:

• Map.size()

selectValue

public E selectValue(String key)

Returns the value whose key is closest in a bitwise XOR metric to the provided key. This is NOT lexicographic closeness! For example, given the keys:

1. D = 1000100
2. H = 1001000
3. L = 1001100

If the Trie contained 'H' and 'L', a lookup of 'D' would return 'L', because the XOR distance between D & L is smaller than the XOR distance between D & H.

Parameters:

key - the key to use in the search

Returns:

the value whose key is closest in a bitwise XOR metric to the provided key

entrySet

public Set<Map.Entry<String,E>> entrySet()

Specified by:

entrySet in interface Get<K,V>

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

Returns:

a set view of the mappings contained in this map

See Also:

• Map.entrySet()

keySet

public Set<String> keySet()

Specified by:

keySet in interface Get<K,V>

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

Overrides:

keySet in class AbstractMap<K,V>

Returns:

a set view of the keys contained in this map

See Also:

• Map.keySet()

values

public Collection<E> values()

Specified by:

values in interface Get<K,V>

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

Overrides:

values in class AbstractMap<K,V>

Returns:

a collection view of the values contained in this map

See Also:

• Map.values()

comparator

public Comparator<? super String> comparator()

firstKey

public String firstKey()

Description copied from interface: OrderedMap

Gets the first key currently in this map.

Returns:

the first key currently in this map

lastKey

public String lastKey()

Description copied from interface: OrderedMap

Gets the last key currently in this map.

Returns:

the last key currently in this map

mapIterator

public OrderedMapIterator<String,E> mapIterator()

Description copied from interface: OrderedMap

Obtains an OrderedMapIterator over the map.

A ordered map iterator is an efficient way of iterating over maps in both directions.

Returns:

a map iterator