Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Dictionary< K, V > Class Template Reference

#include <dictionary.h>

Public Member Functions

 Dictionary (uint32(*hashFn)(K &key))
 
 ~Dictionary ()
 
void clear (void)
 
bit8 add (IN K &key, IN V &value)
 
bit8 getValue (IN K &key, OUT V &value)
 
void print (IN FILE *out) const
 
uint32 getSize (void) const
 
uint32 getEntries (void) const
 
bit8 contains (IN K &key)
 
bit8 updateValue (IN K &key, IN V &value)
 
bit8 remove (IN K &key, OUT V &value)
 
bit8 remove (IN K &key)
 
bit8 removeAny (OUT K &key, OUT V &value)
 
bit8 iterate (INOUT int &index, INOUT int &offset, OUT V &value) const
 
 Dictionary (uint32(*hashFn)(const K &key))
 
 ~Dictionary ()
 
void clear (void)
 
bit8 add (IN K &key, IN V &value)
 
bool getValue (IN K &key, OUT V &value) RO
 
bool getPointer (IN K &key, OUT V **value) RO
 
void print (FILE *out) RO
 
uint32 getSize (void) RO
 
uint32 getEntries (void) RO
 
bit8 contains (IN K &key) RO
 
bit8 updateValue (IN K &key, IN V &value)
 
bit8 remove (IN K &key, OUT V &value)
 
bit8 remove (IN K &key)
 
bit8 removeAny (OUT K &key, OUT V &value)
 
bit8 iterate (INOUT int &index, INOUT int &offset, OUT V &value) RO
 
bit8 iterate (INOUT int &index, INOUT int &offset, OUT K &key, OUT V &value) RO
 
Dictionary< K, V > & operator= (Dictionary< K, V > &other)
 
 Dictionary (uint32(*hashFn)(const K &key))
 
 ~Dictionary ()
 
void clear (void)
 
bit8 add (IN K &key, IN V &value)
 
bool getValue (IN K &key, OUT V &value) RO
 
bool getPointer (IN K &key, OUT V **value) RO
 
void print (FILE *out) RO
 
uint32 getSize (void) RO
 
uint32 getEntries (void) RO
 
bit8 contains (IN K &key) RO
 
bit8 updateValue (IN K &key, IN V &value)
 
bit8 remove (IN K &key, OUT V &value)
 
bit8 remove (IN K &key)
 
bit8 removeAny (OUT K &key, OUT V &value)
 
bit8 iterate (INOUT int &index, INOUT int &offset, OUT V &value) RO
 
bit8 iterate (INOUT int &index, INOUT int &offset, OUT K &key, OUT V &value) RO
 
Dictionary< K, V > & operator= (Dictionary< K, V > &other)
 

Detailed Description

template<class K, class V>
class Dictionary< K, V >

Definition at line 61 of file dictionary.h.

Constructor & Destructor Documentation

◆ Dictionary() [1/3]

template<class K, class V>
Dictionary< K, V >::Dictionary ( uint32(* hashFn )(K &key))

Definition at line 106 of file dictionary.h.

◆ ~Dictionary() [1/3]

template<class K, class V>
Dictionary< K, V >::~Dictionary ( )

Definition at line 131 of file dictionary.h.

◆ Dictionary() [2/3]

template<class K, class V>
Dictionary< K, V >::Dictionary ( uint32(* hashFn )(const K &key))
inline

Definition at line 71 of file dictionary.h.

◆ ~Dictionary() [2/3]

template<class K, class V>
Dictionary< K, V >::~Dictionary ( )

◆ Dictionary() [3/3]

template<class K, class V>
Dictionary< K, V >::Dictionary ( uint32(* hashFn )(const K &key))
inline

Definition at line 71 of file dictionary.h.

◆ ~Dictionary() [3/3]

template<class K, class V>
Dictionary< K, V >::~Dictionary ( )

Member Function Documentation

◆ add() [1/3]

template<class K, class V>
bit8 Dictionary< K, V >::add ( IN K & key,
IN V & value )

Definition at line 297 of file dictionary.h.

◆ add() [2/3]

template<class K, class V>
bit8 Dictionary< K, V >::add ( IN K & key,
IN V & value )

◆ add() [3/3]

template<class K, class V>
bit8 Dictionary< K, V >::add ( IN K & key,
IN V & value )

◆ clear() [1/3]

template<class K, class V>
void Dictionary< K, V >::clear ( void )

Definition at line 139 of file dictionary.h.

◆ clear() [2/3]

template<class K, class V>
void Dictionary< K, V >::clear ( void )

◆ clear() [3/3]

template<class K, class V>
void Dictionary< K, V >::clear ( void )

◆ contains() [1/3]

template<class K, class V>
bit8 Dictionary< K, V >::contains ( IN K & key)

Definition at line 258 of file dictionary.h.

◆ contains() [2/3]

template<class K, class V>
bit8 Dictionary< K, V >::contains ( IN K & key)

◆ contains() [3/3]

template<class K, class V>
bit8 Dictionary< K, V >::contains ( IN K & key)

◆ getEntries() [1/3]

template<class K, class V>
uint32 Dictionary< K, V >::getEntries ( void ) const

Definition at line 252 of file dictionary.h.

◆ getEntries() [2/3]

template<class K, class V>
uint32 Dictionary< K, V >::getEntries ( void )

Definition at line 320 of file dictionary.h.

◆ getEntries() [3/3]

template<class K, class V>
uint32 Dictionary< K, V >::getEntries ( void )

◆ getPointer() [1/2]

template<class K, class V>
bool Dictionary< K, V >::getPointer ( IN K & key,
OUT V ** value )

Definition at line 565 of file dictionary.h.

◆ getPointer() [2/2]

template<class K, class V>
bool Dictionary< K, V >::getPointer ( IN K & key,
OUT V ** value )

◆ getSize() [1/3]

template<class K, class V>
uint32 Dictionary< K, V >::getSize ( void ) const

Definition at line 246 of file dictionary.h.

◆ getSize() [2/3]

template<class K, class V>
uint32 Dictionary< K, V >::getSize ( void )

Definition at line 314 of file dictionary.h.

◆ getSize() [3/3]

template<class K, class V>
uint32 Dictionary< K, V >::getSize ( void )

◆ getValue() [1/3]

template<class K, class V>
bool Dictionary< K, V >::getValue ( IN K & key,
OUT V & value )

Definition at line 474 of file dictionary.h.

◆ getValue() [2/3]

template<class K, class V>
bool Dictionary< K, V >::getValue ( IN K & key,
OUT V & value )

◆ getValue() [3/3]

template<class K, class V>
bool Dictionary< K, V >::getValue ( IN K & key,
OUT V & value )

◆ iterate() [1/5]

template<class K, class V>
bit8 Dictionary< K, V >::iterate ( INOUT int & index,
INOUT int & offset,
OUT K & key,
OUT V & value )

Definition at line 267 of file dictionary.h.

◆ iterate() [2/5]

template<class K, class V>
bit8 Dictionary< K, V >::iterate ( INOUT int & index,
INOUT int & offset,
OUT K & key,
OUT V & value )

◆ iterate() [3/5]

template<class K, class V>
bit8 Dictionary< K, V >::iterate ( INOUT int & index,
INOUT int & offset,
OUT V & value ) const

Definition at line 201 of file dictionary.h.

◆ iterate() [4/5]

template<class K, class V>
bit8 Dictionary< K, V >::iterate ( INOUT int & index,
INOUT int & offset,
OUT V & value )

Definition at line 218 of file dictionary.h.

◆ iterate() [5/5]

template<class K, class V>
bit8 Dictionary< K, V >::iterate ( INOUT int & index,
INOUT int & offset,
OUT V & value )

◆ operator=() [1/2]

template<class K, class V>
Dictionary< K, V > & Dictionary< K, V >::operator= ( Dictionary< K, V > & other)

Definition at line 206 of file dictionary.h.

◆ operator=() [2/2]

template<class K, class V>
Dictionary< K, V > & Dictionary< K, V >::operator= ( Dictionary< K, V > & other)

◆ print() [1/3]

template<class K, class V>
void Dictionary< K, V >::print ( FILE * out)

Definition at line 181 of file dictionary.h.

◆ print() [2/3]

template<class K, class V>
void Dictionary< K, V >::print ( FILE * out)

◆ print() [3/3]

template<class K, class V>
void Dictionary< K, V >::print ( IN FILE * out) const

Definition at line 172 of file dictionary.h.

◆ remove() [1/6]

template<class K, class V>
bit8 Dictionary< K, V >::remove ( IN K & key)

Definition at line 417 of file dictionary.h.

◆ remove() [2/6]

template<class K, class V>
bit8 Dictionary< K, V >::remove ( IN K & key)

◆ remove() [3/6]

template<class K, class V>
bit8 Dictionary< K, V >::remove ( IN K & key)

◆ remove() [4/6]

template<class K, class V>
bit8 Dictionary< K, V >::remove ( IN K & key,
OUT V & value )

Definition at line 346 of file dictionary.h.

◆ remove() [5/6]

template<class K, class V>
bit8 Dictionary< K, V >::remove ( IN K & key,
OUT V & value )

◆ remove() [6/6]

template<class K, class V>
bit8 Dictionary< K, V >::remove ( IN K & key,
OUT V & value )

◆ removeAny() [1/3]

template<class K, class V>
bit8 Dictionary< K, V >::removeAny ( OUT K & key,
OUT V & value )

Definition at line 426 of file dictionary.h.

◆ removeAny() [2/3]

template<class K, class V>
bit8 Dictionary< K, V >::removeAny ( OUT K & key,
OUT V & value )

◆ removeAny() [3/3]

template<class K, class V>
bit8 Dictionary< K, V >::removeAny ( OUT K & key,
OUT V & value )

◆ updateValue() [1/3]

template<class K, class V>
bit8 Dictionary< K, V >::updateValue ( IN K & key,
IN V & value )

Definition at line 282 of file dictionary.h.

◆ updateValue() [2/3]

template<class K, class V>
bit8 Dictionary< K, V >::updateValue ( IN K & key,
IN V & value )

◆ updateValue() [3/3]

template<class K, class V>
bit8 Dictionary< K, V >::updateValue ( IN K & key,
IN V & value )

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