org.deeplearning4j.models.word2vec

Class Huffman

java.lang.Object

org.deeplearning4j.models.word2vec.Huffman

public class Huffman
extends Object

Huffman tree builder

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
int	MAX_CODE_LENGTH

Constructor Summary

Constructors

Constructor and Description
Huffman(Collection<? extends SequenceElement> words)
Huffman(Collection<? extends SequenceElement> words, int CODE_LENGTH) Builds Huffman tree for collection of SequenceElements, with defined CODE_LENGTH Default CODE_LENGTH is 40

Method Summary

Modifier and Type	Method and Description
void	applyIndexes(VocabCache<? extends SequenceElement> cache) This method updates VocabCache and all it's elements with Huffman indexes Please note: it should be the same VocabCache as was used for Huffman tree initialization
void	build()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_CODE_LENGTH

public final int MAX_CODE_LENGTH

Constructor Detail

Huffman

public Huffman(Collection<? extends SequenceElement> words)

Huffman

public Huffman(Collection<? extends SequenceElement> words,
               int CODE_LENGTH)

Builds Huffman tree for collection of SequenceElements, with defined CODE_LENGTH Default CODE_LENGTH is 40

Parameters:

words -

CODE_LENGTH - CODE_LENGTH defines maximum length of code path, and effectively limits vocabulary size.

Method Detail

build

public void build()

applyIndexes

public void applyIndexes(VocabCache<? extends SequenceElement> cache)

This method updates VocabCache and all it's elements with Huffman indexes Please note: it should be the same VocabCache as was used for Huffman tree initialization

Parameters:

cache - VocabCache to be updated.