NLP.HistPL.Lexicon

The module provides functions for working with the binary representation of the historical dictionary of Polish.

It is intended to be imported qualified, to avoid name clashes with Prelude functions, e.g.

 import qualified NLP.HistPL.Lexicon as H

Use save and load functions to save/load the entire dictionary in/from a given directory.

To search the dictionary, open the binary directory with an open function. For example, during a GHCi session:

>>> hpl <- H.open "srpsdp.bin"

Set the OverloadedStrings extension for convenience:

>>> :set -XOverloadedStrings

To search the dictionary use the lookup function, e.g.

>>> entries <- H.lookup hpl "dufliwego"

You can use functions defined in the NLP.HistPL.Types module to query the entries for a particular feature, e.g.

>>> map (H.text . H.lemma) entries
[["dufliwy"]]

Finally, if you need to follow an ID pointer kept in one entry as a reference to another one, use the loadI or tryLoadI functions.

Dictionary

data HistPL

A binary version of the old Polish dictionary.

Constructors

HistPL

Fields

dictPath :: FilePath

A path to the binary dictionary.

formMap :: DAWG UID () Code

A dictionary with lexicon forms.

data Code

Code represents a word origin. See the save function to learn why do we provide this information.

Constructors

Orig

only from historical dictionary

Both

from both historical and another dictionary

Copy

only from another dictionary

Instances

Eq Code

Ord Code

Show Code

Binary Code

Key

type Key = Key UID

A dictionary key which uniquely identifies the lexical entry.

type UID = Int

A unique identifier among entries with the same keyForm.

Open

tryOpen :: FilePath -> IO (Maybe HistPL)

Open the binary dictionary residing in the given directory. Return Nothing if the directory doesn't exist or if it doesn't constitute a dictionary.

open :: FilePath -> IO HistPL

Open the binary dictionary residing in the given directory. Raise an error if the directory doesn't exist or if it doesn't constitute a dictionary.

Query

By Form

lookup :: HistPL -> Text -> IO [(LexEntry, Code)]

Lookup the form in the dictionary. The resultant list constitutes a map from entries to Codes.

lookupMany :: HistPL -> [Text] -> IO [(LexEntry, Code)]

Lookup a set of forms in the dictionary. The resultant list constitutes a map from entries to Codes.

By Prefix

nthSuffix :: HistPL -> Text -> Int -> Maybe Text

Get suffix of the i-th form starting with a given prefix.

withPrefix :: HistPL -> Text -> Int

Compute the number of entries with a given prefix.

By Key

dictKeys :: HistPL -> Producer Key IO ()

List of dictionary keys.

tryLoadK :: HistPL -> Key -> IO (Maybe LexEntry)

Load lexical entry given its key. Return Nothing if there is no entry with such a key.

loadK :: HistPL -> Key -> IO LexEntry

Load lexical entry given its key. Raise error if there is no entry with such a key.

By ID

dictIDs :: HistPL -> Producer Text IO ()

List of dictionary IDs.

tryLoadI :: HistPL -> Text -> IO (Maybe LexEntry)

Load lexical entry given its ID. Return Nothing if there is no entry with such ID.

loadI :: HistPL -> Text -> IO LexEntry

Load lexical entry given its ID. Raise error if there is no entry with such a key.

Conversion

save :: FilePath -> Consumer (Maybe (LexEntry, Set Text)) IO ()

Construct dictionary from a list of lexical entries and save it in the given directory. To each entry an additional set of forms can be assigned. The stream of entry pairs should be terminated by the Nothing value.

load :: HistPL -> Producer (Key, LexEntry) IO ()

A producer of all dictionary entries.

Modules

NLP.HistPL.Types module exports hierarchy of data types stored in the binary dictionary.

module NLP.HistPL.Types