Text.Pronounce

This is a library for interpresting the parsed Carnegie Mellon University Pronouncing Dictionary. It is modelled after Allison Parrish's python library, pronouncing.

Datatypes

type CMUdict = Map Text [Text]

A Map from Entries to lists of possible pronunciations, serving as our representation of the CMU Pronouncing Dictionary

type UsesBin = Bool

A type used to represent the option of decoding the dictionary from a binary file or parsing it from text

type DictComp = Reader CMUdict

We are using the Reader monad to perform computations in the context of the CMU dictionary without having to pass it in or worry about initializing every time

type EntryWord = Text

Convenient type aliases for transcription and entry

type Phones = Text

type Stress = Text

Using Text.Pronounce

initDict :: Maybe FilePath -> UsesBin -> IO CMUdict

Initializes the cmu pronunctiation dictionary into our program, given an optional file name of the dictionary

stdDict :: IO CMUdict

Default settings for initDict

runPronounce :: DictComp a -> CMUdict -> a

Get the value from a series of Dictionary Computations by supplying the dictionary to the computation. This is just runReader.

Basic Functions

phonesForEntry :: EntryWord -> DictComp [Phones]

Look up the pronunciation (list of possible phones) of a word in the dictionary

stressesForEntry :: EntryWord -> DictComp [Stress]

Gives the stress pattern for a given word in the dictionary

stresses :: Phones -> Stress

Isolates the stress pattern from a sequence of phones

syllableCount :: Phones -> Int

Gives the syllable count of a given pronunciation

Searching the Dictionary

searchDictBy :: (Phones -> Bool) -> DictComp CMUdict

Initializes a dictionary computation based on a selector function that operates on an individual phones. It returns a DictComp containing a CMUdict of all the entries that have at least one value satisfying the predicate.

search :: Phones -> DictComp [EntryWord]

Given a sequence of phones, find all words that contain that sequence of phones

searchStresses :: Stress -> DictComp [EntryWord]

Given a stress pattern, find all words that satisfy that pattern

Rhyming

rhymingPart :: Phones -> Phones

Finds the rhyming part of the given phones.

rhymes :: EntryWord -> DictComp [EntryWord]

Given a word, finds all other words that rhyme with it

Some Helper Functions

dictAppend :: (Applicative f, Monoid a) => DictComp (f a) -> DictComp (f a) -> DictComp (f a)

Useful for nondeterministically combining several dictionary computations. Generally, one would call foldr1 (<||>) to get all the possible results of mapping a DictComp over a line of text (multiple words).

(<||>) :: (Applicative f, Monoid a) => DictComp (f a) -> DictComp (f a) -> DictComp (f a) infixl 3

Useful for nondeterministically combining several dictionary computations. Generally, one would call foldr1 (<||>) to get all the possible results of mapping a DictComp over a line of text (multiple words).

liftD :: Functor f => (a -> b) -> DictComp (f a) -> DictComp (f b)

Lift functions to act on elements within a functor in a dictionary computation, such as a list of possible phones or stresses