map with hashing access More...
#include <utilmm/hash/hash_map.hh>
Public Types | |
| typedef Key | key_type |
| Key type. More... | |
| typedef Data | data_type |
| Data type. More... | |
| typedef std::pair< Key const, Data > | value_type |
| Value type for cells. More... | |
| typedef container_type::iterator | iterator |
| iterator type More... | |
| typedef container_type::const_iterator | const_iterator |
| const iterator type More... | |
Public Member Functions | |
| void | swap (hash_map &other) |
| swapping function More... | |
| size_t | size () const |
| element count More... | |
| size_t | max_size () const |
| max element number More... | |
| bool | empty () const |
| Emptyness test. More... | |
| iterator | begin () |
| beginning of table More... | |
| iterator | end () |
| end of table More... | |
| const_iterator | begin () const |
| beginning of table More... | |
| const_iterator | end () const |
| end of table More... | |
| iterator | find (key_arg key) |
| Search for key. More... | |
| const_iterator | find (key_arg key) const |
| Search key. More... | |
| std::pair< iterator, bool > | insert (value_arg val) |
| Cell insertion. More... | |
| void | erase (iterator const &first, iterator const &last) |
| Remove range. More... | |
| void | erase (iterator const &i) |
| Remove element. More... | |
| void | erase (key_arg key) |
| remove element More... | |
| void | clear () |
| Remove all elements. More... | |
Detailed Description
template<typename Key, typename Data, class Hash = hash<Key>, class Equal = std::equal_to<Key>>
class utilmm::hash_map< Key, Data, Hash, Equal >
map with hashing access
This is an unsorted map where keys are accessed using a hash function
- Parameters
-
Key the key Data The data associated to Key Hash hashing functor fo Key Eqaul equality functor for Key
- See also
- utilmm::hash
Member Typedef Documentation
◆ const_iterator
| typedef container_type::const_iterator utilmm::hash_map< Key, Data, Hash, Equal >::const_iterator |
const iterator type
const iterator type The type used to iterate through this class without any modification
◆ data_type
| typedef Data utilmm::hash_map< Key, Data, Hash, Equal >::data_type |
Data type.
This is the type of the data asociated to the key
◆ iterator
| typedef container_type::iterator utilmm::hash_map< Key, Data, Hash, Equal >::iterator |
iterator type
iterator type The type used to iterate through and manipulate this class
◆ key_type
| typedef Key utilmm::hash_map< Key, Data, Hash, Equal >::key_type |
Key type.
◆ value_type
| typedef std::pair<Key const, Data> utilmm::hash_map< Key, Data, Hash, Equal >::value_type |
Value type for cells.
Value type for cells.
For hash_map value_type is a std::pair containing the key and the associated data.
Member Function Documentation
◆ begin() [1/2]
|
inline |
beginning of table
Beginning of table.
- Returns
- an iterator pointing to the beginning of the container
- See also
- end()
◆ begin() [2/2]
|
inline |
beginning of table
Beginning of table.
- Returns
- a const iterator pointing to the beginning of the container
- See also
- end() const
◆ clear()
|
inline |
Remove all elements.
remove all elements This function is strictly equivelent to erase(begin(), end())
Referenced by utilmm::cached_fn< Arg, Ret, Hash, Equal >::empty_cache().
◆ empty()
|
inline |
Emptyness test.
Emptyness test.
- Return values
-
true if this instance has no element false else
- See also
- size() const
◆ end() [1/2]
|
inline |
end of table
End of table.
- Returns
- an iterator pointing to the end of the container
- See also
- begin()
Referenced by utilmm::hash_map< base_type *, size_t, hash_ptr< Ty, Hash >, eq_ptr< Ty, Equal > >::erase(), and utilmm::smart::ref_count::uniq_memory< Ty, Hash, Equal >::null_cell().
◆ end() [2/2]
|
inline |
◆ erase() [1/3]
|
inline |
Remove range.
Remove elements.
- Parameters
-
first an iterator last an iterator
removes all the element of the table in the range [first, last [
Referenced by utilmm::hash_map< base_type *, size_t, hash_ptr< Ty, Hash >, eq_ptr< Ty, Equal > >::erase().
◆ erase() [2/3]
|
inline |
Remove element.
- Parameters
-
i The lement to remove
This function removes the element pointed by i form the table
◆ erase() [3/3]
|
inline |
remove element
- Parameters
-
key the key of the element
This function erase, if any, the element whose key is key
◆ find() [1/2]
|
inline |
Search for key.
- Parameters
-
key the key to find.
This function tries to search in table an element with key key
- Returns
- An iterator pointing to the element with key key or
end()if not found.
Referenced by utilmm::hash_map< base_type *, size_t, hash_ptr< Ty, Hash >, eq_ptr< Ty, Equal > >::erase().
◆ find() [2/2]
|
inline |
Search key.
Search for key.
- Parameters
-
key the key to find.
This function tries to search in table an element with key key
- Returns
- An iterator pointing to the element with key key or
end()if not found.
◆ insert()
|
inline |
Cell insertion.
- Parameters
-
val The value to insert
This function tries to insert val in current instance. It will not insert it if ther's already a cell with the same key as val
- Returns
- A pair where
firstis aniteratorpointing to cell with the same key as val andsecondis true if and only ifvalwas inserted.
◆ max_size()
|
inline |
max element number
max elmement number
- Returns
- The maximum possible number of elements
◆ size()
|
inline |
element count
element count
- Returns
- the number of element present in current container
Referenced by utilmm::cached_fn< Arg, Ret, Hash, Equal >::cache_size().
◆ swap()
|
inline |
swapping function
swapping values function This function exchange the value of current instance with the value of another instance.
- Parameters
-
other The other instance
The documentation for this class was generated from the following file:
- utilmm/hash/hash_map.hh
