smile.nlp

Class NGram

java.lang.Object

smile.nlp.NGram

All Implemented Interfaces:

Comparable<NGram>

public class NGram
extends Object
implements Comparable<NGram>

An n-gram is a contiguous sequence of n words from a given sequence of text. An n-gram of size 1 is referred to as a unigram; size 2 is a bigram; size 3 is a trigram.

Author:

Haifeng Li

Field Summary

Fields

Modifier and Type	Field and Description
int	freq Frequency of n-gram in the corpus.
String[]	words Immutable word sequences.

Constructor Summary

Constructors

Constructor and Description
NGram(String[] words) Constructor.
NGram(String[] words, int freq) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(NGram o)
boolean	equals(Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

words

public final String[] words

Immutable word sequences.

freq

public int freq

Frequency of n-gram in the corpus.

Constructor Detail

NGram

public NGram(String[] words)

Constructor.

Parameters:

words - the n-gram word sequence.

NGram

public NGram(String[] words,
     int freq)

Constructor.

Parameters:

words - the n-gram word sequence.

freq - the frequency of n-gram in the corpus.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(NGram o)

Specified by:

compareTo in interface Comparable<NGram>