| class | EST_Val |
The EST_Val class is a container class, used to store a single item which can be an int, float, string or other user-defined class. It is often used as the base item in the EST_Features class, to enable features to take on values of different types.
EST_Val;
EST_Val ( ) {t=val_unset;} EST_Val(const EST_Val &val); EST_Val(const int i) {t=val_int; v.ival=i;} EST_Val(const float f) {t=val_float; v.fval=f;} EST_Val(const double d) {t=val_float; v.fval=d;} EST_Val(const EST_String &s) {t=val_string; sval = s;} EST_Val(const char *s) {t=val_string; sval = s;} EST_Val(val_type type, void *p, void (*f)(void *)); ~EST_Val(void); Default constructor
operator !=()
int operator != ( const EST_String &a) const Test whether val is not equal to the string a
operator !=()
int operator != ( const double &d) const Test whether val is not equal to the double float a
| class | EST_Features |
A class for containing feature structures which can hold atomic values (int, float, string) or other feature structures
Features can either be simple features, in which their name is the name of an plain attribute (e.g. "name"), or path features where their name is a dot separated path of concatenated attributes (e.g. "df.poa.alveolar").
val()
const EST_Val& val ( const char *name) const Look up directly without decomposing name as path (just simple feature)
val()
const EST_Val& val ( const char *name, const EST_Val &def) const Look up directly without decomposing name as path (just simple feature), returning def if not found
val_path()
const EST_Val& val_path ( const EST_String &path) const Look up feature name, which may be simple feature or path
val_path()
const EST_Val& val_path ( const EST_String &path, const EST_Val &def) const Look up feature name, which may be simple feature or path, returning def if not found
operator) ()
const EST_Val& operator) ( const EST_String &path) const Look up feature name, which may be simple feature or path
operator) ()
const EST_Val& operator) ( const EST_String &path, const EST_Val &def) const Look up feature name, which may be simple feature or path, returning def if not found
f()
const EST_Val& f ( const EST_String &path) Look up feature name, which may be simple feature or path
f()
const EST_Val& f ( const EST_String &path, const EST_Val &def) Look up feature name, which may be simple feature or path, returning def if not found
These functions cast their EST_Val return value to a requested type, eithe float, int, string or features (A). In all cases the name can be a simple feature or a path, in which case their name is a dot separated string of concatenated attributes (e.g. "df.poa.alveolar").
F()
const float F ( const EST_String &path) const Look up feature name, which may be simple feature or path, and return as a float
F()
const float F ( const EST_String &path, float def) const Look up feature name, which may be simple feature or path, and return as a float, returning def if not found
I()
const int I ( const EST_String &path) const Look up feature name, which may be simple feature or path, and return as an int
I()
const int I ( const EST_String &path, int def) const Look up feature name, which may be simple feature or path, and return as an int, returning def if not found
S()
const EST_String S ( const EST_String &path) const Look up feature name, which may be simple feature or path, and return as a EST_String
S()
const EST_String S ( const EST_String &path, const EST_String &def) const Look up feature name, which may be simple feature or path, and return as a EST_String, returning def if not found
A()
EST_Features& A ( const EST_String &path) const Look up feature name, which may be simple feature or path, and return as a EST_Features
A()
EST_Features& A ( const EST_String &path, EST_Features &def) const Look up feature name, which may be simple feature or path, and return as a EST_Features, returning def if not found
set()
void set ( const EST_String &name, int ival) Add a new feature or set an existing feature nameto value ival
set()
void set ( const EST_String &name, float fval) Add a new feature or set an existing feature nameto value fval
set()
void set ( const EST_String &name, double dval) Add a new feature or set an existing feature nameto value dval
set()
void set ( const EST_String &name, const EST_String &sval) Add a new feature or set an existing feature nameto value sval
set()
void set ( const EST_String &name, const char *cval) Add a new feature or set an existing feature nameto value cval
set_val()
void set_val ( const EST_String &name, const EST_Val &sval) Add a new feature or set an existing feature nameto value val. Name must be not be a path.
set_path()
void set_path ( const EST_String &name, const EST_Val &sval) Add a new feature or set an existing feature nameto value val, where nameis a path
set_function()
void set_function ( const EST_String &name, const EST_String &f) Add a new feature feature or set an existing feature name to value f, which is the named of a registered feature function
set()
void set ( const EST_String &name, EST_Features &f) Add a new feature or set an existing feature name to value f, which itself is a EST_Features. The information in f is copied into the features.
load_sexpr()
EST_read_status load_sexpr ( EST_TokenStream &ts) load features from sexpression, contained in already opened EST_TokenStream
save_sexpr()
EST_write_status save_sexpr ( ostream &outf) const save features as s-expression in already opened ostream
| class | EST_Item |
A class for containing individual linguistic objects such as words or phones.
These contain two types of infomation. This first is specific to the \Ref{EST_Relation} we are viewing this ling item from, the second part constists of a set of features. These features may be shared by instances of this ling item in different EST_Relation within the same EST_Utterances
The shared part of an EST_Item is represented by the class EST_Item_Content. It should not normally be accessed by the general users as reverse links from the contents to each of the EST_Items it is part of are held ensure the integrity of the structures. Changing these without maintain the appropriate links is unlikely to be stable.
These functions are wrap-around functions to the basic access functions in the \Ref{EST_Features} class. In all these functioms, if the optional argument m} is set to 1, an error is thrown if the feature does not exist
F()
const float F ( const EST_String &name, float def) const return the value of the feature name cast as a float, returning def if not found
S()
const EST_String S ( const EST_String &name) const return the value of the feature name cast as a EST_String
S()
const EST_String S ( const EST_String &name, const EST_String &def) const return the value of the feature name cast as a EST_String, returning def if not found
I()
const int I ( const EST_String &name, int def) const return the value of the feature name cast as a int returning def if not found
A()
EST_Features& A ( const EST_String &name) const return the value of the feature name cast as a EST_Features
A()
EST_Features& A ( const EST_String &name, EST_Features &def) const return the value of the feature name cast as a EST_Features, returning def if not found
A separate function is provided for each permissable value type
set_function()
void set_function ( const EST_String &name, const EST_String &funcname) set feature name to val, a function registered in the feature function list
set()
void set ( const EST_String &name, EST_Features &f) set feature name to f, a set of features, which is copied into the object
set_val()
void set_val ( const EST_String &name, const EST_Val &sval) set feature name to f, whose type is EST_Val
evaluate_features()
void evaluate_features ( ) find all the attributes whose values are functions, and replace them with their evaluation
as_relation()
EST_Item* as_relation ( const char *relname) const View item from another relation (const char *) method
in_relation()
int in_relation ( const EST_String &relname) const TRUE if this item is in named relation
same_item()
int same_item ( const EST_Item *li) const True if li is the same item ignoring its relation viewpoint
| class | EST_Relation |
Relations are a container class for EST_Items. Three types of relation structure are supported:
Linear lists Trees Multi-linear structures as used in autosegmental phonology etc
evaluate_item_features()
void evaluate_item_features ( ) Evaluate the feature functions of all the items in the relation
remove_item_feature()
void remove_item_feature ( const EST_String &name) remove all occurances of feature name from relation's items
operator=()
EST_Relation& operator= ( const EST_Relation &s) Relation assignment. Copies relation into new relation but the items are the same and become shared.
load()
EST_read_status load ( const EST_String &filename, const EST_String &type="esps") Load relation from file
load()
EST_read_status load ( EST_TokenStream &ts, EST_THash<int, EST_Val> &contents) Load relation from already open tokenstream
save()
EST_write_status save ( const EST_String &filename, bool evaluate_ff = false) const Save relation to file
save()
EST_write_status save ( const EST_String &filename, const EST_String &type, bool evaluate_ff = false) const Save relation to file, evaluating all feature functions before hand
| class | EST_Utterance |
A class that contains EST_Items and EST_Relations between them. Used for holding interrelated linguistic structures.
save()
EST_write_status save ( const EST_String &filename, const EST_String &type="est_ascii") const save an utterance to an ascii file
save()
EST_write_status save ( ostream &outf, const EST_String &type) const save an utterance to an ostream
relation_present()
bool relation_present ( const EST_String name) const returns true if utterance contains named relations. {\bf name} can be either a single string or a bracketed list of strings e.g. "(Word Phone Syl)".
relation_present()
bool relation_present ( EST_StrList &names) const returns true if utterance contains all the relations named in the list {\bf name}
create_relation()
EST_Relation* create_relation ( const EST_String &relname) create a new relation called n.
- Table of Contents
- Tree traversal functions
- Tree building functions
This is a sub-library of functions for creating, traversing and accessing relations which are trees.
Tree traversal functions
root()
inline EST_Item* root ( const EST_Item *n) return root node of treeprevious sibling (sister) of n
parent()
inline EST_Item* parent ( const EST_Item *n, const char *relname) return parent of n as seen from relation relname
daughter1()
inline EST_Item* daughter1 ( const EST_Item *n, const char *relname) return first daughter of n as seen from relation relname
daughter2()
inline EST_Item* daughter2 ( const EST_Item *n, const char *relname) return second daughter of n as seen from relation relname
daughtern()
inline EST_Item* daughtern ( const EST_Item *n, const char *relname) return last daughter of n as seen from relation relname
next_sibling()
inline EST_Item* next_sibling ( const EST_Item *n, const char *relname) return next sibling (sister) of n as seen from relation relname
prev_sibling()
inline EST_Item* prev_sibling ( const EST_Item *n, const char *relname) return previous sibling (sistem) of n as seen from relation relname
root()
inline EST_Item* root ( const EST_Item *n, const char *relname) return root of tree of n as seen from relation relname
first_leaf()
inline EST_Item* first_leaf ( const EST_Item *n) return the first leaf (terminal node) which is dominated by n. Note that this is different from daughter1 etc as this descends the tree to find the lefttmost terminal node (it is like the transitive closure of daughter1).
last_leaf()
inline EST_Item* last_leaf ( const EST_Item *n) return the last leaf (terminal node) which is dominated by n. Note that this is different from daughter1 etc as this descends the tree to find the right terminal node (it is like the transitive closure of daughtern).
next_leaf()
inline EST_Item* next_leaf ( const EST_Item *n) Return next leaf in tree given n. If n is a terminal node, next_leaf() will return the next leaf in the tree. If n is not terminal, this will return the leftmost terminal node dominated by n. This will return 0 only when the last leaf in the relation has been passed.
Tree building functions
append_daughter()
EST_Item* append_daughter ( EST_Item *n, EST_Item *p=0) Add a daughter to node n, after any existing daughters, and return the next daughter. If p is 0, make a new node for the daughter, otherwise add p to this relation as n's daughter.
append_daughter()
EST_Item* append_daughter ( EST_Item *n, const char *relname, EST_Item *p=0) Add a daughter to node n as seen from relation relname, after any existing daughters, and return the next daughter. If p is 0, make a new node for the daughter, otherwise add p to this relation as n's daughter.
prepend_daughter()
EST_Item* prepend_daughter ( EST_Item *n, EST_Item *p=0) Add a daughter to node n, before any existing daughters, and return the next daughter. If p is 0, make a new node for the daughter, otherwise add p to this relation as n's daughter.
prepend_daughter()
EST_Item* prepend_daughter ( EST_Item *n, const char *relname, EST_Item *p=0) Add a daughter to node n as seen from relation relname, before any existing daughters, and return the next daughter. If p is 0, make a new node for the daughter, otherwise add p to this relation as n's daughter.
List traversal functions
next()
inline EST_Item* next ( const EST_Item *n, const char *relname) return next item of n as seen from relation relname
prev()
inline EST_Item* prev ( const EST_Item *n, const char *relname) return previous item of n as seen from relation relname
first()
inline EST_Item* first ( const EST_Item *n, const char *relname) return first item of n as seen from relation relname
last()
inline EST_Item* last ( const EST_Item *n, const char *relname) return last item of n as seen from relation relname
in_list()
int in_list ( const EST_Item *c, const EST_Item *l) Given a node l, return true if c after it in a list relation
add_after()
EST_Item* add_after ( const EST_Item *n, EST_Item *p=0) Add a item after node n, and return the new item. If n is the first item in the list, the new item becomes the head of the list, otherwise it is inserted between n and it's previous current item. If p is 0, make a new node for the new item, otherwise add p to this relation as the next item in n's relation.
add_before()
EST_Item* add_before ( const EST_Item *n, EST_Item *p=0) Add a item before node n, and return the new item. If n is the first item in the list, the new item becomes the head of the list, otherwise it is inserted between n and it's previous current item. If p is 0, make a new node for the new item, otherwise add p to this relation as the previous item in n's relation.
