Edinburgh Speech Tools  2.4-release
EST_TStringHash< V > Class Template Reference

#include <include/EST_THash.h>

Inheritance diagram for EST_TStringHash< V >:
Collaboration diagram for EST_TStringHash< V >:

Public Types

typedef EST_Hash_Pair< EST_String, V > Entry
 An entry returned by the iterator is a key value pair.
 
typedef EST_THash< EST_String, V >::IPointer TN_IPointer
 
typedef EST_TStructIterator< EST_THash< EST_String, V >, typename EST_THash< EST_String, V >::IPointer, EST_Hash_Pair< EST_String, V > > Entries
 Give the iterator a sensible name.
 
typedef EST_TRwStructIterator< EST_THash< EST_String, V >, typename EST_THash< EST_String, V >::IPointer, EST_Hash_Pair< EST_String, V > > RwEntries
 
typedef EST_String KeyEntry
 
typedef EST_THash< EST_String, V >::IPointer_k TN_IPointer_k
 Give the iterator a sensible name.
 
typedef EST_TIterator< EST_THash< EST_String, V >, typename EST_THash< EST_String, V >::IPointer_k, EST_StringKeyEntries
 
typedef EST_TRwIterator< EST_THash< EST_String, V >, typename EST_THash< EST_String, V >::IPointer_k, EST_StringKeyRwEntries
 
- Public Types inherited from EST_THash< EST_String, V >
typedef EST_Hash_Pair< EST_String, V > Entry
 An entry returned by the iterator is a key value pair.
 
typedef EST_TStructIterator< EST_THash< EST_String, V >, IPointer, EST_Hash_Pair< EST_String, V > > Entries
 Give the iterator a sensible name.
 
typedef EST_TRwStructIterator< EST_THash< EST_String, V >, IPointer, EST_Hash_Pair< EST_String, V > > RwEntries
 
typedef EST_String KeyEntry
 An entry returned by this iterator is just a key.
 
typedef EST_TIterator< EST_THash< EST_String, V >, IPointer_k, EST_StringKeyEntries
 Give the iterator a sensible name.
 
typedef EST_TRwIterator< EST_THash< EST_String, V >, IPointer_k, EST_StringKeyRwEntries
 

Public Member Functions

 EST_TStringHash (int size)
 Create a string hash table of <parameter>size</parameter> buckets.
 
- Public Member Functions inherited from EST_THash< EST_String, V >
 EST_THash (int size, unsigned int(*hash_function)(const EST_String &key, unsigned int size)=NULL)
 
 EST_THash (const EST_THash< EST_String, V > &from)
 Create a copy.
 
 ~EST_THash (void)
 Destroy the table.
 
void clear (void)
 Empty the table.
 
unsigned int num_entries (void) const
 Return the total number of entries in the table.
 
int present (const EST_String &key) const
 Does the key have an entry?
 
V & val (const EST_String &key, int &found) const
 
V & val (const EST_String &key) const
 Return the value associated with the key.
 
const EST_Stringkey (const V &val, int &found) const
 
const EST_Stringkey (const V &val) const
 
void copy (const EST_THash< EST_String, V > &from)
 Copy all entries.
 
void map (void(*func)(EST_String &, V &))
 Apply <parameter>func</parameter> to each entry in the table.
 
int add_item (const EST_String &key, const V &value, int no_search=0)
 Add an entry to the table.
 
int remove_item (const EST_String &rkey, int quiet=0)
 Remove an entry from the table.
 
EST_THash< EST_String, V > & operator= (const EST_THash< EST_String, V > &from)
 Assignment is a copy operation.
 
void dump (ostream &stream, int all=0)
 Print the table to <parameter>stream</parameter> in a human readable format.
 

Additional Inherited Members

- Protected Types inherited from EST_THash< EST_String, V >
typedef struct IPointer_s IPointer
 
typedef struct IPointer_k_s IPointer_k
 
- Protected Member Functions inherited from EST_THash< EST_String, V >
void skip_blank (IPointer &ip) const
 Shift to point at something.
 
void point_to_first (IPointer &ip) const
 Go to start of the table.
 
void move_pointer_forwards (IPointer &ip) const
 Move pointer forwards, at the end of the bucket, move down.
 
bool points_to_something (const IPointer &ip) const
 We are at the end if the pointer ever becomes NULL.
 
EST_Hash_Pair< EST_String, V > & points_at (const IPointer &ip)
 Return the contents of this entry.
 
void skip_blank (IPointer_k &ip) const
 Shift to point at something.
 
void point_to_first (IPointer_k &ip) const
 Go to start of the table.
 
void move_pointer_forwards (IPointer_k &ip) const
 Move pointer forwards, at the end of the bucket, move down.
 
bool points_to_something (const IPointer_k &ip) const
 We are at the end if the pointer ever becomes NULL.
 
EST_Stringpoints_at (const IPointer_k &ip)
 Return the key of this entry.
 

Detailed Description

template<class V>
class EST_TStringHash< V >

A specialised hash table for when the key is an EST_String.

This is just a version of <classname>EST_THash</classname> which has a different default hash function.

Definition at line 281 of file EST_THash.h.


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