// Purpose: interface of wxHashMap
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
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,
+ In particular, the interface is modelled after std::map, and the various,
non-standard, std::hash_map (http://www.cppreference.com/wiki/stl/map/start).
Example:
@code
WX_DECLARE_HASH_MAP( int,
wxString,
- wxIntegerHash,
- wxIntegerEqual,
+ ::wxIntegerHash,
+ ::wxIntegerEqual,
MyHash );
// using an user-defined class for keys
WX_DECLARE_HASH_MAP( MyKey, // type of the keys
SOME_TYPE, // any type you like
- MyKeyHash, // hasher
- MyKeyEqual, // key equality predicate
+ ::MyKeyHash, // hasher
+ ::MyKeyEqual, // key equality predicate
CLASSNAME); // name of the class
@endcode
/**
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.
+ returned.
+
@code
hashmap.find( non_existent_key ) == hashmap.end()
@endcode