GPL_Map

gpl

1998 12-05

CLASS

GPL_Map - C++ generic map of values

SYNOPSIS

GPL_Map provides a mapping between values. It contains a list of mappings between a key and a value. Each object of the key class, K, may appear in only one pair. Each object of the value class, V, may appear in many pairs. The key class, K, must have a default constructor, an assignment operator, and the equality operator. The value class, V, must have a default constructor, an assignment operator, and the equality operator.

PARENTS

GPL_Reference

public

CONSTRUCTORS

GPL_Map(unsigned long (*h)(const K & k), const unsigned long initialSize)

OPERATORS

GPL_Map<K, V> & operator=(const GPL_Map<K, V> & map)

map

GPL_Reference::operator=()

V & operator[](const K & key)
Return the value associated with the key key. If the map contains no pair for key, a new pair is inserted. In this case, the returned value will be the result of the default constructor for V.

GPL_Boolean operator==(const GPL_Map<K, V> & map) const
Return TRUE if the map and map contain the same pairs and FALSE otherwise.

GPL_Boolean operator!=(const GPL_Map<K, V> & map) const
Return FALSE if the map and map contain the same pairs and TRUE otherwise.

MEMBER FUNCTIONS

unsigned long GetCount(void) const

unsigned long GetSize(void) const
Return the number of buckets being used.

GPL_Array<K> GetKeys(void) const
Return an array consisting of all of the keys in the map.

long Compare(const GPL_Map<K, V> & map) const
Return 0 if this map and map both contain the same number of internal storage buckets and each bucket contains a list of key/value pairs that exactly matches the respective list. Otherwise return anything but 0.

GPL_Boolean Contains(const K & key) const
Return TRUE if the map contains a pair for key.

GPL_Boolean LookUp(const K & key, V & value) const
Return TRUE if the map contains a pair for key and FALSE if not. If successful, put the value associated with key in value.

V & Find(const K & key)
Return the value associated with the key key. If the map contains no pair for key, a new pair is inserted. In this case, the returned value will be the result of the default constructor for V.

Remove(const K & key)
Removes the value associated with key. Returns TRUE if a value was removed and FALSE otherwise.

GPL_Boolean Replace(const K & key, const V & value)
Insert in the map the value value for the key key. This does overwrite an existing value. Return TRUE if a value was replaced and FALSE if a value did not already exist.

GPL_Boolean Insert(const K & key, const V & value)
Inserts in the map the value value for the key key. This does not overwrite an existing value; Replace() provides that functionality. Return TRUE if a value was inserted and FALSE if a value already existed.

void Clear(void)
Remove all keys and values from the map.