de.up.ling.irtg.automata

Class IntTrie<E>

java.lang.Object

de.up.ling.irtg.automata.IntTrie<E>

Type Parameters:

E -

All Implemented Interfaces:

Serializable

public class IntTrie<E>
extends Object
implements Serializable

This is a trie data structure used to map sequences of integers to a value. This is generally used by tree automata to map sequences of state ids to possible rules.

Author:

koller

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntTrie.EntryVisitor<E> This defines an interface for a class which consumes keys stored in the trie together with the value they are associated with.

Constructor Summary

Constructors

Constructor and Description
IntTrie() Creates a new instance that always uses HashMaps to connect it's states.
IntTrie(MapFactory factory) This creates a new instance which builds the maps it uses by calling the provided factory.

Method Summary

Modifier and Type	Method and Description
void	foreach(Consumer<E> fn) Applies the given consumer to all the values in this map.
void	foreachValueForKeySets(List<IntSet> keySets, Consumer<E> fn) Applys the consumer to all the non-null value that can be reached with the given keys.
void	foreachWithKeys(IntTrie.EntryVisitor<E> visitor) Applies the given visitor to every key value pair stored in the trie.
E	get(int[] key) Returns the value associate with the key, or null if there is no such value.
Collection<E>	getValues() Returns a collection of all the values stored in the trie.
void	print(BiFunction<Integer,Integer,String> keyToString, Function<E,String> valueToString) Prints out the automaton with the given mappings for keys and values.
void	printStatistics() Prints a summary of the trie in its current states.
E	put(int[] key, E value) Adds a new key value pair to the trie.
void	setValueCounter(ToLongFunction<E> valueCounter) The value counter is used to map entries in the try into longs, which can then be added up to get some summary statistics.
IntTrie<E>	step(int oneStepKey) Obtais the subtrie reached with the given key.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IntTrie

public IntTrie(MapFactory factory)

This creates a new instance which builds the maps it uses by calling the provided factory. This can be used to optimize performance by changing the way mappings between nodes in the trie are stored.

Parameters:

factory -

IntTrie

public IntTrie()

Creates a new instance that always uses HashMaps to connect it's states.

Method Detail

setValueCounter

public void setValueCounter(ToLongFunction<E> valueCounter)

The value counter is used to map entries in the try into longs, which can then be added up to get some summary statistics.

Parameters:

valueCounter -

put

public E put(int[] key,
             E value)

Adds a new key value pair to the trie. Returns the previously known entry, or null if an entry for this key was not known.

Parameters:

key -

value -

Returns:

get

public E get(int[] key)

Returns the value associate with the key, or null if there is no such value.

Parameters:

key -

Returns:

step

public IntTrie<E> step(int oneStepKey)

Obtais the subtrie reached with the given key.

Parameters:

oneStepKey -

Returns:

foreachValueForKeySets

public void foreachValueForKeySets(List<IntSet> keySets,
                                   Consumer<E> fn)

Applys the consumer to all the non-null value that can be reached with the given keys. If a key is not associated with a value, then it is ignored.

Parameters:

keySets -

fn -

foreach

public void foreach(Consumer<E> fn)

Applies the given consumer to all the values in this map.

Parameters:

fn -

foreachWithKeys

public void foreachWithKeys(IntTrie.EntryVisitor<E> visitor)

Applies the given visitor to every key value pair stored in the trie.

Parameters:

visitor -

getValues

public Collection<E> getValues()

Returns a collection of all the values stored in the trie.

Returns:

toString

public String toString()

Overrides:

toString in class Object

printStatistics

public void printStatistics()

Prints a summary of the trie in its current states. This includes the number of nodes for a given depth, the maximum key value for a given depth and the number of values per depth.

print

public void print(BiFunction<Integer,Integer,String> keyToString,
                  Function<E,String> valueToString)

Prints out the automaton with the given mappings for keys and values. The keyToString function is applied to keys and their depth in order to encode them.

Parameters:

keyToString -

valueToString -