wxHashMap Class Reference

#include <wx/hashmap.h>

List of all members.

---

Detailed Description

This is a simple, type-safe, and reasonably efficient hash map class, whose interface is a subset of the interface of STL containers. In particular, the interface is modeled after std::map, and the various, non-standard, std::hash_map.

Library:  wxBase

Category:  group_class_FIXME

Public Member Functions
void	clear ()
size_type	count (const key_type &key) const
bool	empty () const
Insert_Result	insert (const value_type &v)
mapped_type	operator[] (const key_type &key)
size_type	size () const
	wxHashMap (size_type size=10)
	wxHashMap (const wxHashMap &map)
const_iterator	begin ()
const iterator	begin ()
const_iterator	end ()
const iterator	end ()
size_type	erase (const key_type &key)
void	erase (iterator it)
void	erase (const_iterator it)
iterator	find (const key_type &key) const
const_iterator	find (const key_type &key) const

---

Constructor & Destructor Documentation

wxHashMap::wxHashMap

(

size_type

size = 10

)

Copy constructor.

wxHashMap::wxHashMap

(

const wxHashMap &

map

)

Copy constructor.

---

Member Function Documentation

const_iterator wxHashMap::begin

(

)

Returns an iterator pointing at the first element of the hash map. Please remember that hash maps do not guarantee ordering.

const iterator wxHashMap::begin

(

)

Returns an iterator pointing at the first element of the hash map. Please remember that hash maps do not guarantee ordering.

void wxHashMap::clear

(

)

Removes all elements from the hash map.

size_type wxHashMap::count

(

const key_type &

key

)

const

Counts the number of elements with the given key present in the map. This function returns only 0 or 1.

bool wxHashMap::empty

(

)

const

Returns true if the hash map does not contain any elements, false otherwise.

const_iterator wxHashMap::end

(

)

Returns an iterator pointing at the one-after-the-last element of the hash map. Please remember that hash maps do not guarantee ordering.

const iterator wxHashMap::end

(

)

Returns an iterator pointing at the one-after-the-last element of the hash map. Please remember that hash maps do not guarantee ordering.

size_type wxHashMap::erase

(

const key_type &

key

)

Erases the element pointed to by the iterator. After the deletion the iterator is no longer valid and must not be used.

void wxHashMap::erase

(

iterator

it

)

Erases the element pointed to by the iterator. After the deletion the iterator is no longer valid and must not be used.

void wxHashMap::erase

(

const_iterator

it

)

Erases the element pointed to by the iterator. After the deletion the iterator is no longer valid and must not be used.

iterator wxHashMap::find

(

const key_type &

key

)

const

If an element with the given key is present, the functions returns an iterator pointing at that element, otherwise an invalid iterator is returned (i.e. hashmap.find( non_existent_key ) == hashmap.end()).

const_iterator wxHashMap::find

(

const key_type &

key

)

const

If an element with the given key is present, the functions returns an iterator pointing at that element, otherwise an invalid iterator is returned (i.e. hashmap.find( non_existent_key ) == hashmap.end()).

Insert_Result wxHashMap::insert

(

const value_type &

v

)

Inserts the given value in the hash map. The return value is equivalent to a std::pairiterator(), bool; the iterator points to the inserted element, the boolean value is true if v was actually inserted.

mapped_type wxHashMap::operator[]

(

const key_type &

key

)

Use the key as an array subscript. The only difference is that if the given key is not present in the hash map, an element with the default value_type() is inserted in the table.

size_type wxHashMap::size

(

)

const

Returns the number of elements in the map.