edu.cmu.sphinx.linguist.dictionary

Class Pronunciation

java.lang.Object

edu.cmu.sphinx.linguist.dictionary.Pronunciation

public class Pronunciation
extends java.lang.Object

Provides pronunciation information for a word.

Field Summary

Fields

Modifier and Type	Field and Description
static Pronunciation	UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pronunciation(java.util.List<Unit> units) Creates a pronunciation with defaults
protected	Pronunciation(java.util.List<Unit> units, java.lang.String tag, float probability) Creates a pronunciation
	Pronunciation(Unit[] units, java.lang.String tag, float probability) Creates a pronunciation

Method Summary

Modifier and Type	Method and Description
void	dump() Dumps a pronunciation
float	getProbability() Retrieves the probability for the pronunciation.
java.lang.String	getTag() Retrieves the tag associated with the pronunciation or null if there is no tag associated with this pronunciation.
Unit[]	getUnits() Retrieves the units for this pronunciation
Word	getWord() Retrieves the word that this Pronunciation object represents.
void	setWord(Word word) Sets the word this pronunciation represents.
java.lang.String	toDetailedString() Returns a detailed string representation of this Pronunciation.
java.lang.String	toString() Returns a string representation of this Pronunication.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final Pronunciation UNKNOWN

Constructor Detail

Pronunciation

public Pronunciation(Unit[] units,
                     java.lang.String tag,
                     float probability)

Creates a pronunciation

Parameters:

units - represents the pronunciation

tag - a grammar specific tag

probability - the probability of this pronunciation occurring

Pronunciation

protected Pronunciation(java.util.List<Unit> units,
                        java.lang.String tag,
                        float probability)

Creates a pronunciation

Parameters:

units - represents the pronunciation

tag - a grammar specific tag

probability - the probability of this pronunciation occurring

Pronunciation

protected Pronunciation(java.util.List<Unit> units)

Creates a pronunciation with defaults

Parameters:

units - represents the pronunciation

Method Detail

setWord

public void setWord(Word word)

Sets the word this pronunciation represents.

Parameters:

word - the Word this Pronunciation represents

getWord

public Word getWord()

Retrieves the word that this Pronunciation object represents.

Returns:

the word

getUnits

public Unit[] getUnits()

Retrieves the units for this pronunciation

Returns:

the units for this pronunciation

getTag

public java.lang.String getTag()

Retrieves the tag associated with the pronunciation or null if there is no tag associated with this pronunciation. Pronunciations can optionally be tagged to allow applications to distinguish between different pronunciations.

Returns:

the tag or null if no tag is available.

getProbability

public float getProbability()

Retrieves the probability for the pronunciation. A word may have multiple pronunciations that are not all equally probable. All probabilities for particular word sum to 1.0.

Returns:

the probability of this pronunciation as a value between 0 and 1.0.

TODO: FIX Note that probabilities are currently maintained in the linear domain (unlike just about everything else)

dump

public void dump()

Dumps a pronunciation

toString

public java.lang.String toString()

Returns a string representation of this Pronunication.

Overrides:

toString in class java.lang.Object

Returns:

a string of this Pronunciation

toDetailedString

public java.lang.String toDetailedString()

Returns a detailed string representation of this Pronunciation.

Returns:

a string of this Pronunciation