Edinburgh Speech Tools  2.1-release
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Friends | List of all members
EST_Item Class Reference

#include <include/ling_class/EST_Item.h>

Public Member Functions

EST_Item_Contentcontents () const
 
void set_contents (EST_Item_Content *li)
 
const EST_String name () const
 
void set_name (const EST_String &name) const
 
EST_Featuresfeatures () const
 
const EST_Val f (const EST_String &name) const
 
const EST_Val f (const EST_String &name, const EST_Val &def) const
 
EST_Itemnext () const
 
EST_Itemprev () const
 
EST_Itemdown () const
 
EST_Itemup () const
 
EST_Itemlast () const
 
EST_Itemfirst () const
 
EST_Itemtop () const
 
EST_Itembottom () const
 
EST_Itemfirst_leaf () const
 
EST_Itemnext_leaf () const
 
EST_Itemlast_leaf () const
 
EST_Itemnext_item () const
 
EST_Iteminsert_after (EST_Item *li=0)
 
EST_Iteminsert_before (EST_Item *li=0)
 
EST_Iteminsert_below (EST_Item *li=0)
 
EST_Iteminsert_above (EST_Item *li=0)
 
EST_Itemappend_daughter (EST_Item *li=0)
 
EST_Itemprepend_daughter (EST_Item *li=0)
 
EST_Iteminsert_parent (EST_Item *li=0)
 
void unref_all ()
 
int verify () const
 
EST_Itemoperator= (const EST_Item &s)
 
Constructor Functions
 EST_Item ()
 Default constructor.
 
 EST_Item (const EST_Item &item)
 Copy constructor only makes reference to contents.
 
 EST_Item (EST_Relation *rel)
 Includes reference to relation.
 
 EST_Item (EST_Relation *rel, EST_Item *si)
 Most common form of construction.
 
 ~EST_Item ()
 Deletes it and references to it in its contents.
 
Feature access functions.

These functions are wrap-around functions to the basic access functions in the EST_Features class. In all these functions, if the optional argument m is set to 1, an error is thrown if the feature does not exist

const float F (const EST_String &name) const
 
const float F (const EST_String &name, float def) const
 
const EST_String S (const EST_String &name) const
 
const EST_String S (const EST_String &name, const EST_String &def) const
 
const int I (const EST_String &name) const
 
const int I (const EST_String &name, int def) const
 
EST_FeaturesA (const EST_String &name) const
 
EST_FeaturesA (const EST_String &name, EST_Features &def) const
 
Feature setting functions.

A separate function is provided for each permissible value type

void set (const EST_String &name, int ival)
 
void set (const EST_String &name, float fval)
 
void set (const EST_String &name, double fval)
 
void set (const EST_String &name, const EST_String &sval)
 
void set (const EST_String &name, const char *cval)
 
void set_function (const EST_String &name, const EST_String &funcname)
 
void set (const EST_String &name, EST_Features &f)
 
void set_val (const EST_String &name, const EST_Val &sval)
 
Utility feature functions
void f_remove (const EST_String &name)
 
void evaluate_features ()
 
int f_present (const EST_String &name) const
 
int length () const
 
Cross relational access
EST_Itemas_relation (const char *relname) const
 View item from another relation (const char *) method.
 
int in_relation (const EST_String &relname) const
 TRUE if this item is in named relation.
 
EST_TKVL< EST_String, EST_Val > & relations ()
 Access to the relation links.
 
const EST_Stringrelation_name () const
 The relation name of this particular item.
 
EST_Relationrelation (void) const
 The relation of this particular item.
 
int same_item (const EST_Item *li) const
 True if li is the same item ignoring its relation viewpoint.
 

Static Public Member Functions

static void splice (EST_Item *a, EST_Item *b)
 

Static Protected Member Functions

static void class_init (void)
 

Friends

class EST_Relation
 
class ling_class_init
 
int i_same_item (const EST_Item *l1, const EST_Item *l2)
 
int move_item (EST_Item *from, EST_Item *to)
 
int merge_item (EST_Item *from, EST_Item *to)
 
int move_sub_tree (EST_Item *from, EST_Item *to)
 
int exchange_sub_trees (EST_Item *from, EST_Item *to)
 
ostream & operator<< (ostream &s, const EST_Item &a)
 
bool operator!= (const EST_Item &a, const EST_Item &b)
 
bool operator== (const EST_Item &a, const EST_Item &b)
 

Detailed Description

A class for containing individual linguistic objects such as words or phones.

These contain two types of information. This first is specific to the EST_Relation we are viewing this ling item from, the second part consists of a set of features. These features may be shared by instances of this ling item in different EST_Relation within the same EST_Utterance.

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.

We believe this structure is the most efficient for the most natural use we envisage. Traversal of the items ....

Definition at line 83 of file EST_Item.h.

Member Function Documentation

const float EST_Item::F ( const EST_String name) const
inline

return the value of the feature name cast as a float

Definition at line 135 of file EST_Item.h.

const float EST_Item::F ( const EST_String name,
float  def 
) const
inline

return the value of the feature name cast as a float, returning def if not found.

Definition at line 139 of file EST_Item.h.

const EST_String EST_Item::S ( const EST_String name) const
inline

return the value of the feature name cast as a EST_String

Definition at line 144 of file EST_Item.h.

const EST_String EST_Item::S ( const EST_String name,
const EST_String def 
) const
inline

return the value of the feature name cast as a EST_String, returning def if not found.

Definition at line 150 of file EST_Item.h.

const int EST_Item::I ( const EST_String name) const
inline

return the value of the feature name cast as a int

Definition at line 155 of file EST_Item.h.

const int EST_Item::I ( const EST_String name,
int  def 
) const
inline

return the value of the feature name cast as a int returning def if not found.

Definition at line 159 of file EST_Item.h.

EST_Features& EST_Item::A ( const EST_String name) const
inline

return the value of the feature name cast as a EST_Features

Definition at line 164 of file EST_Item.h.

EST_Features& EST_Item::A ( const EST_String name,
EST_Features def 
) const
inline

return the value of the feature name cast as a EST_Features, returning def if not found.

Definition at line 170 of file EST_Item.h.

void EST_Item::set ( const EST_String name,
int  ival 
)
inline

set feature name to val

Definition at line 180 of file EST_Item.h.

void EST_Item::set ( const EST_String name,
float  fval 
)
inline

set feature name to val

Definition at line 184 of file EST_Item.h.

void EST_Item::set ( const EST_String name,
double  fval 
)
inline

set feature name to val

Definition at line 188 of file EST_Item.h.

void EST_Item::set ( const EST_String name,
const EST_String sval 
)
inline

set feature name to val

Definition at line 192 of file EST_Item.h.

void EST_Item::set ( const EST_String name,
const char *  cval 
)
inline

set feature name to val

Definition at line 196 of file EST_Item.h.

void EST_Item::set_function ( const EST_String name,
const EST_String funcname 
)
inline

set feature name to val, a function registered in the feature function list.

Definition at line 202 of file EST_Item.h.

void EST_Item::set ( const EST_String name,
EST_Features f 
)
inline

set feature name to f, a set of features, which is copied into the object.

Definition at line 208 of file EST_Item.h.

void EST_Item::set_val ( const EST_String name,
const EST_Val sval 
)
inline

set feature name to f, whose type is EST_Val.

Definition at line 215 of file EST_Item.h.

void EST_Item::f_remove ( const EST_String name)
inline

remove feature name

Definition at line 223 of file EST_Item.h.

void EST_Item::evaluate_features ( )

find all the attributes whose values are functions, and replace them with their evaluation.

Definition at line 172 of file EST_Item.cc.

int EST_Item::f_present ( const EST_String name) const
inline

TRUE if feature is present, FALSE otherwise

Definition at line 231 of file EST_Item.h.


The documentation for this class was generated from the following files: