name: NGramParser

synopsis:


g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_mmedia.a

#include <NGramParser.h>

boolean setOrder(long order);
long getOrder() const;
boolean load(Sof& sof, HashTable<Long, NGramNode>& gram_hash, const Vector<String>& symbol_table, const long& tag, const String& name);
boolean NGramParser::store(Sof& file, const HashTable<Long, NGramNode>& gram_hash, const Vector<String>& symbol_table, const long& tag, const String& name) const;

quick start:


Sof tmp_sof;
String file_name;
Vector symbol_table;
HashTable gram_hash;

file_name.assign(L"tidigits_trigram.arpa");
tmp_sof.open(file_name, File::READ_ONLY);

NGramParser np_00;

np_00.load(tmp_sof, gram_hash, symbol_table, 1, L"NGramModel");

tmp_sof.close();

description:

This class manages the N-gram grammar. It can be used to convert NIST_ARPA or other grammar format to ISIP internal format.

dependencies:

public constants:

define the class name:
```
static const String CLASS_NAME;
```

define the file format choices:

enum FORMAT { NGRAM_ARPA = 0, DEF_FORMAT = NGRAM_ARPA };

define default values and arguments:
```
static const long DEF_ORDER = (long)0;
```

error codes:

error codes indicating general errors:

static const long ERR = 50600;

static const long ERR_ORDER = 50601;

static const long ERR_TAG = 506012;

static const long ERR_SYMBOL = 50603;

static const long ERR_HASH = 50604;

static const long ERR_FORMAT = 50605;

static const long ERR_NUM_GRAM = 50606;

protected data:

declare the order of N-gram:

long order_d;

declare the debugging parameters:
```
static Integral::DEBUG debug_level_d;
```
declare the memory manager:
```
static MemoryManager mgr_d;
```

required public methods:

static methods:
```
static const String& name();
```

debug methods:

static boolean diagnose(Integral::DEBUG debug_level);

boolean debug(const unichar* msg) const;

static boolean setDebug(Integral::DEBUG debug_level);

destructor/constructor(s):

~NGramParser();

NGramParser(long order = DEF_ORDER);

assign methods:
```
boolean assign(const NGramParser& arg);
```

operator= method:

NGramParser& operator= (const NGramParser& arg);

i/o methods:

long sofSize() const;

boolean read(Sof& sof, const long& tag, const String& cname = CLASS_NAME);

boolean write(Sof& sof, long tag, const String& cname = CLASS_NAME) const;

equality methods:

boolean eq(const NGramParser& arg) const;

memory management methods:

static void* operator new(size_t size);

static void* operator new[](size_t size);

static void operator delete(void* ptr);

static void operator delete[](void* ptr);

static boolean setGrowSize(long grow_size);

boolean clear(Integral::CMODE ctype = Integral::DEF_CMODE);

class-specific public methods:

declare ngram order methods:

boolean setOrder(long order);

long getOrder() const;

declare i/o methods:

boolean load(Sof& sof, HashTable<Long, NGramNode>& gram_hash, const Vector<String>& symbol_table, const long& tag, const String& name);

boolean NGramParser::store(Sof& file, const HashTable<Long, NGramNode>& gram_hash, const Vector<String>& symbol_table, const long& tag, const String& name) const;

private methods:

declare private methods:

boolean storeToHash(HashTable<Long, NGramNode>& gram_hash, SingleLinkedList<NGramNode>& symbol_list, NGramNode* prefix_node);

examples:

none.

notes:

none.