name: Context

synopsis:


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

#include <Context.h>

GVSnode* getCentralVertex();
GVSnode* getBeforeCentralVertex();
GVSnode* getAfterCentralVertex();
GVSnode* getLastVertex();
boolean convert();
boolean convert(Context*& output, boolean extended = false);
boolean fold();
boolean extend(GVSnode* pointer_to_vertex);

quick start:


long central_position = 1;
long total_context_length = 3;

GraphVertex* left_vertex;
GraphVertex* central_vertex;
GraphVertex* right_vertex;

Context triphone_context(total_context_length, central_position);

triphone_context.assignAndAdvance((ulong)left_vertex);
triphone_context.assignAndAdvance((ulong)central_vertex);
triphone_context.assignAndAdvance((ulong)right_vertex);

description:

This class is used to represent context-dependent search symbols. The search symbol is represented by the central context of a circular delay line. The context of the search symbol, left and right search symbols, is represented by the remaining entries in the circular delay line data member.

dependencies:

CircularDelayLine.h

public constants:

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

define i/o constants:

static const String PARAM_CENTRAL;

static const String PARAM_EXTENSION_LENGTH;

define default values:

static const long DEF_LENGTH = 1;

static const long DEF_CENTRAL_INDEX = 1;

static const long DEF_LAST_LENGTH = -1;

static const long DEF_EXTENSION_LENGTH = 0;

error codes:

error codes indicating general errors:
```
static const long ERR = 90100;
```

protected data:

index of the central vertex in context:

long central_d;

length of the future context extension, used if we have a cross-symbol context:

long ext_length_d;

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

type definition:

typedef GraphVertex<SearchNode> GVSnode;

required public methods:

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

debug methods:

static boolean diagnose(Integral::DEBUG debug_level);

destructor/constructor(s):

~Context();

Context(long context_length = DEF_LENGTH, long central_index = DEF_CENTRAL_INDEX) : CircularDelayLine<Ulong>(context_length);

Context(const Context& copy_context) : CircularDelayLine<Ulong>(copy_context.length());

assign methods:

boolean assign(const Context& context_cmp);

operator= method:
```
not present.
```

i/o methods:

long sofSize() const;

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

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

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

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

equality methods:

boolean eq(const Context& context_cmp) 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);

class-specific public methods:

context access methods:

boolean isExtended();

GVSnode* getCentralVertex();

boolean setCentralVertex(ulong new_gvnode_a);

GVSnode* getBeforeCentralVertex();

GVSnode* getAfterCentralVertex();

GVSnode* getLastVertex();

boolean setLastVertex(ulong new_gvnode_a);

declare display methods:

boolean print();

boolean print(String& output);

declare hash function:
```
long hash(long capacity) const;
```

declare context conversion methods:

boolean convert();

boolean convert(Context*& output, boolean extended = false);

declare context manupulation methods:

boolean fold();

boolean extend(GVSnode* pointer_to_vertex);

private methods:

none.

examples:

none.

notes:

none.