name: NBestPath

synopsis:


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

#include <NBestPath.h>

long getNumPaths() const;
boolean setPaths(SingleLinkedList<NBestNode>& arg);
SingleLinkedList<NBestNode>& getPaths();
boolean setFrameIndex(long arg);
long getFrameIndex();
boolean setMaxScore(float arg);
float getMaxScore();
boolean insertPath(NBestNode* path);
boolean growPaths(NBestPath**& path_list, float scale, float penalty, long max_paths, float beam);
boolean prune(float beam, long max_paths);

quick start:


long nbest_beam = 50;
long max_paths = 10;

NBestNode nnode;
NBestPath npath;

npath.insertPath(nnode);
npath.prune(nbest_beam, max_paths);

description:

This class represents a path in the hypothesis space corresponding to one of the N most likely hypotheses generated by the recognizer.

dependencies:

NBestNode.h

public constants:

define public constants:

static const String CLASS_NAME;

static const String DEF_PARAM;

static const float DEF_MAX_SCORE = -1.0e10;

static const long DEF_FRAME_INDEX = 0;

error codes:

error codes indicating general errors:

protected data:

define the linked list of partial paths:

SingleLinkedList<NBestNode> paths_d;

define the frame at which this path list was created:

Long frame_index_d;

define the score of the best partial path in this list:

Float max_score_d;

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

required public methods:

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

debug methods:

static boolean diagnose(Integral::DEBUG debug_level);

static boolean setDebug(Integral::DEBUG debug_level);

destructor/constructor(s):

~NBestPath();

NBestPath();

NBestPath(const NBestPath& copy_sym);

assign methods:

boolean assign(const NBestPath& copy_node);

operator= method:

NBestPath& operator=(const NBestPath& arg);

i/o methods:

long sofSize() const;

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

boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);

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

boolean writeData(Sof& sof, const String& pname = DEF_PARAM) const;

equality methods:
```
boolean eq(const NBestPath& obj) 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 class specific methods:

long getNumPaths() const;

boolean setPaths(SingleLinkedList<NBestNode>& arg);

SingleLinkedList<NBestNode>& getPaths();

boolean setFrameIndex(long arg);

long getFrameIndex();

boolean setMaxScore(float arg);

float getMaxScore();

boolean insertPath(NBestNode* path);

boolean growPaths(NBestPath**& path_list, float scale, float penalty, long max_paths, float beam);

boolean prune(float beam, long max_paths);

private methods:

none.

examples:

none.

notes:

none.