CharTrie (char-trie 1.6.0 API)

java.lang.Object
- com.simiacryptus.text.CharTrie

Direct Known Subclasses:

CharTrieIndex
```
public class CharTrie
extends Object
```
A character sequence index using a prefix tree, commonly known as a full-text index or as the data structure behind markov chains. This implementation uses serialized fixed-length ephemeral objects and a raw byte data store, preventing object/reference count overhead.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`godparentIndex` The Godparent index.
`protected SerialArrayList<com.simiacryptus.text.NodeData>`	`nodes` The Nodes.
`protected int[]`	`parentIndex` The Parent index.

Constructor Summary

Constructors
Constructor and Description
`CharTrie()` Instantiates a new Char trie.
`CharTrie(CharTrie charTrie)` Instantiates a new Char trie.
`CharTrie(SerialArrayList<com.simiacryptus.text.NodeData> nodes)` Instantiates a new Char trie.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharTrie`	`add(CharTrie z)` Add char trie.
`boolean`	`contains(String text)` Contains boolean.
`CharTrie`	`copy()` Copy char trie.
`CharTrie`	`divide(CharTrie z, int factor)` Divide char trie.
`boolean`	`equals(Object o)`
`TextAnalysis`	`getAnalyzer()` Gets analyzer.
`NodewalkerCodec`	`getCodec()` Gets codec.
`TextGenerator`	`getGenerator()` Gets generator.
`long`	`getIndexedSize()` Gets indexed size.
`int`	`getMemorySize()` Gets memory size.
`int`	`getNodeCount()` Gets node count.
`int`	`hashCode()`
`TrieNode`	`matchEnd(String search)` Match end trie node.
`TrieNode`	`matchPredictor(String search)` Match predictor trie node.
`<T extends Comparable<T>> Stream<TrieNode>`	`max(Function<TrieNode,T> fn, int maxResults)` Max stream.
`CharTrie`	`product(CharTrie z)` Product char trie.
`CharTrie`	`reduce(CharTrie right, BiFunction<TrieNode,TrieNode,TreeMap<Character,Long>> fn)` Reduce char trie.
`static BiFunction<CharTrie,CharTrie,CharTrie>`	`reducer(BiFunction<TrieNode,TrieNode,TreeMap<Character,Long>> fn)` Reducer bi function.
`CharTrie`	`reduceSimple(CharTrie z, BiFunction<Long,Long,Long> fn)` Reduce simple char trie.
`CharTrie`	`reverse()` Reverse char trie.
`CharTrie`	`rewrite(BiFunction<TrieNode,Map<Character,TrieNode>,TreeMap<Character,Long>> fn)` Rewrite char trie.
`TrieNode`	`root()` Root trie node.
`Set<Character>`	`tokens()` Tokens set.
`TrieNode`	`traverse(String search)` Locate a node by finding the maximum prefix match apply the given string
`protected CharTrie`	`truncate()` Truncate char trie.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - nodes
```
protected final SerialArrayList<com.simiacryptus.text.NodeData> nodes
```
    The Nodes.
  - parentIndex
```
protected int[] parentIndex
```
    The Parent index.
  - godparentIndex
```
protected int[] godparentIndex
```
    The Godparent index.
- Constructor Detail
  - CharTrie
```
public CharTrie(SerialArrayList<com.simiacryptus.text.NodeData> nodes)
```
    Instantiates a new Char trie.
    
    Parameters:
    
    nodes - the nodes
  - CharTrie
```
public CharTrie()
```
    Instantiates a new Char trie.
  - CharTrie
```
public CharTrie(CharTrie charTrie)
```
    Instantiates a new Char trie.
    
    Parameters:
    
    charTrie - the char trie
- Method Detail
  - reducer
```
public static BiFunction<CharTrie,CharTrie,CharTrie> reducer(BiFunction<TrieNode,TrieNode,TreeMap<Character,Long>> fn)
```
    Reducer bi function.
    
    Parameters:
    
    fn - the fn
    
    Returns:
    
    the bi function
  - root
```
public TrieNode root()
```
    Root trie node.
    
    Returns:
    
    the trie node
  - reverse
```
public CharTrie reverse()
```
    Reverse char trie.
    
    Returns:
    
    the char trie
  - rewrite
```
public CharTrie rewrite(BiFunction<TrieNode,Map<Character,TrieNode>,TreeMap<Character,Long>> fn)
```
    Rewrite char trie.
    
    Parameters:
    
    fn - the fn
    
    Returns:
    
    the char trie
  - add
```
public CharTrie add(CharTrie z)
```
    Add char trie.
    
    Parameters:
    
    z - the z
    
    Returns:
    
    the char trie
  - product
```
public CharTrie product(CharTrie z)
```
    Product char trie.
    
    Parameters:
    
    z - the z
    
    Returns:
    
    the char trie
  - divide
```
public CharTrie divide(CharTrie z,
                       int factor)
```
    Divide char trie.
    
    Parameters:
    
    z - the z
    
    factor - the factor
    
    Returns:
    
    the char trie
  - reduceSimple
```
public CharTrie reduceSimple(CharTrie z,
                             BiFunction<Long,Long,Long> fn)
```
    Reduce simple char trie.
    
    Parameters:
    
    z - the z
    
    fn - the fn
    
    Returns:
    
    the char trie
  - reduce
```
public CharTrie reduce(CharTrie right,
                       BiFunction<TrieNode,TrieNode,TreeMap<Character,Long>> fn)
```
    Reduce char trie.
    
    Parameters:
    
    right - the right
    
    fn - the fn
    
    Returns:
    
    the char trie
  - traverse
```
public TrieNode traverse(String search)
```
    Locate a node by finding the maximum prefix match apply the given string
    
    Parameters:
    
    search - the search
    
    Returns:
    
    trie node
  - getNodeCount
```
public int getNodeCount()
```
    Gets node count.
    
    Returns:
    
    the node count
  - matchEnd
```
public TrieNode matchEnd(String search)
```
    Match end trie node.
    
    Parameters:
    
    search - the search
    
    Returns:
    
    the trie node
  - matchPredictor
```
public TrieNode matchPredictor(String search)
```
    Match predictor trie node.
    
    Parameters:
    
    search - the search
    
    Returns:
    
    the trie node
  - copy
```
public CharTrie copy()
```
    Copy char trie.
    
    Returns:
    
    the char trie
  - getMemorySize
```
public int getMemorySize()
```
    Gets memory size.
    
    Returns:
    
    the memory size
  - getIndexedSize
```
public long getIndexedSize()
```
    Gets indexed size.
    
    Returns:
    
    the indexed size
  - getCodec
```
public NodewalkerCodec getCodec()
```
    Gets codec.
    
    Returns:
    
    the codec
  - getGenerator
```
public TextGenerator getGenerator()
```
    Gets generator.
    
    Returns:
    
    the generator
  - getAnalyzer
```
public TextAnalysis getAnalyzer()
```
    Gets analyzer.
    
    Returns:
    
    the analyzer
  - truncate
```
protected CharTrie truncate()
```
    Truncate char trie.
    
    Returns:
    
    the char trie
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - tokens
```
public Set<Character> tokens()
```
    Tokens set.
    
    Returns:
    
    the set
  - contains
```
public boolean contains(String text)
```
    Contains boolean.
    
    Parameters:
    
    text - the text
    
    Returns:
    
    the boolean
  - max
```
public <T extends Comparable<T>> Stream<TrieNode> max(Function<TrieNode,T> fn,
                                                      int maxResults)
```
    Max stream.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    fn - the fn
    
    maxResults - the max results
    
    Returns:
    
    the stream

Class CharTrie

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nodes

parentIndex

godparentIndex

Constructor Detail

CharTrie

CharTrie

CharTrie

Method Detail

reducer

root

reverse

rewrite

add

product

divide

reduceSimple

reduce

traverse

getNodeCount

matchEnd

matchPredictor

copy

getMemorySize

getIndexedSize

getCodec

getGenerator

getAnalyzer

truncate

equals

hashCode

tokens

contains

max