Maintains a collection of keys, each with an associated item stored according to both a hash object and the key insertion order. More...
#include <rw/tools/tvordhmap.h>
Public Types | |
typedef container_type::allocator_type | allocator_type |
typedef container_type::const_iterator | const_iterator |
typedef container_type::const_pointer | const_pointer |
typedef container_type::const_reference | const_reference |
typedef rw_orderedhashmap< K, T, H, EQ, A > | container_type |
typedef container_type::difference_type | difference_type |
typedef container_type::hasher | hasher |
typedef container_type::iterator | iterator |
typedef container_type::key_equal_type | key_equal |
typedef container_type::key_type | key_type |
typedef container_type::mapped_type | mapped_type |
typedef container_type::pointer | pointer |
typedef container_type::reference | reference |
typedef container_type::size_type | size_type |
typedef container_type::value_type | value_type |
Public Member Functions | |
RWTValOrderedHashMap () | |
RWTValOrderedHashMap (const rw_orderedhashmap< K, T, H, EQ, A > &m) | |
RWTValOrderedHashMap (const RWTValOrderedHashMap< K, T, H, EQ, A > &rws) | |
RWTValOrderedHashMap (RWTValOrderedHashMap< K, T, H, EQ, A > &&rws) | |
RWTValOrderedHashMap (container_type &&rws) | |
template<typename InputIterator > | |
RWTValOrderedHashMap (InputIterator first, InputIterator last, size_type sz=64, const H &h=H(), const EQ &eq=EQ()) | |
RWTValOrderedHashMap (const hasher &h, size_type sz=64) | |
void | apply (void(*fn)(const key_type &, const mapped_type &, void *), void *d) const |
void | apply (void(*fn)(const key_type &, mapped_type &, void *), void *d) |
iterator | begin () |
const_iterator | begin () const |
size_type | capacity () const |
const_iterator | cbegin () const |
const_iterator | cend () const |
void | clear () |
bool | contains (bool(*fn)(const_reference, void *), void *d) const |
bool | contains (const key_type &key) const |
iterator | end () |
const_iterator | end () const |
size_type | entries () const |
iterator | erase (iterator pos) |
iterator | erase (iterator first, iterator last) |
float | fillRatio () const |
bool | find (bool(*fn)(const_reference, void *), void *d, std::pair< K, T > &r) const |
bool | find (const key_type &key, key_type &r) const |
bool | findKeyAndValue (const key_type &key, key_type &kr, mapped_type &tr) const |
bool | findValue (const key_type &key, mapped_type &r) const |
iterator | insert (iterator hint, const_reference val) |
template<typename InputIterator > | |
void | insert (InputIterator first, InputIterator last) |
bool | insert (const key_type &key, const mapped_type &a) |
bool | insert (K &&key, T &&a) |
template<typename P > | |
iterator | insert (iterator hint, P &&val) |
bool | isEmpty () const |
const key_type & | maxElement () const |
const key_type & | minElement () const |
size_type | occurrencesOf (bool(*fn)(const_reference, void *), void *d) const |
size_type | occurrencesOf (const key_type &key) const |
RWTValOrderedHashMap< K, T, H, EQ, A > & | operator= (const RWTValOrderedHashMap< K, T, H, EQ, A > &rhs) |
RWTValOrderedHashMap< K, T, H, EQ, A > & | operator= (const rw_orderedhashmap< K, T, H, EQ, A > &rhs) |
RWTValOrderedHashMap< K, T, H, EQ, A > & | operator= (RWTValOrderedHashMap< K, T, H, EQ, A > &&rhs) |
RWTValOrderedHashMap< K, T, H, EQ, A > & | operator= (container_type &&rhs) |
mapped_type & | operator[] (const key_type &key) |
bool | remove (bool(*fn)(const_reference, void *), void *d) |
bool | remove (const key_type &key) |
size_type | removeAll (bool(*fn)(const_reference, void *), void *d) |
size_type | removeAll (const key_type &key) |
void | resize (size_type sz) |
container_type & | std () |
const container_type & | std () const |
void | swap (RWTValOrderedHashMap< K, T, H, EQ, A > &other) |
Related Functions | |
(Note that these are not member functions.) | |
template<class K , class T , class H , class EQ , class A > | |
bool | operator!= (const RWTValOrderedHashMap< K, T, H, EQ, A > &lhs, const RWTValOrderedHashMap< K, T, H, EQ, A > &rhs) |
template<class K , class T , class H , class EQ , class A > | |
bool | operator!= (const RWTValOrderedHashMap< K, T, H, EQ, A > &lhs, const typename RWTValOrderedHashMap< K, T, H, EQ, A >::container_type &rhs) |
template<class K , class T , class H , class EQ , class A > | |
bool | operator!= (const typename RWTValOrderedHashMap< K, T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashMap< K, T, H, EQ, A > &rhs) |
template<class K , class T , class H , class EQ , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValOrderedHashMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWFile & | operator<< (RWFile &strm, const RWTValOrderedHashMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
bool | operator== (const RWTValOrderedHashMap< K, T, H, EQ, A > &lhs, const RWTValOrderedHashMap< K, T, H, EQ, A > &rhs) |
template<class K , class T , class H , class EQ , class A > | |
bool | operator== (const RWTValOrderedHashMap< K, T, H, EQ, A > &lhs, const typename RWTValOrderedHashMap< K, T, H, EQ, A >::container_type &rhs) |
template<class K , class T , class H , class EQ , class A > | |
bool | operator== (const typename RWTValOrderedHashMap< K, T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashMap< K, T, H, EQ, A > &rhs) |
template<class K , class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValOrderedHashMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValOrderedHashMap< K, T, H, EQ, A > &coll) |
template<class K , class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValOrderedHashMap< K, T, H, EQ, A > *&p) |
template<class K , class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &strm, RWTValOrderedHashMap< K, T, H, EQ, A > *&p) |
Class RWTValOrderedHashMap maintains a collection of type K
keys, each with an associated item of type T
. These pairs are stored according to a hash object of type H
. RWTValOrderedHashMap preserves key insertion order.
A
is an allocator of objects of class T
. For more information about using custom allocators, please see the Essential Tools Module User's Guide.
H
must provide a const
function that takes a single argument convertible to type K
and returns a value of type size_t
.
Key equality is determined by an equality function of type EQ
, which takes two arguments convertible to type K
and returns a value of type bool
.
RWTValOrderedHashMap will not accept a key that is equivalent to any key already in the collection. (RWTValOrderedHashMultiMap may contain multiple keys that are equivalent to each other.) Equality is based on an equality object and not on the equality operator. If your type has an equality operator, then you may want to use the templatized std::equal_to
function object provided by the C++ Standard Library; otherwise, you must define your own equality object.
The value
type must have operator==
defined. This requirement is imposed by the C++ Standard Library.
Class RWTValHashMultiMap offers the same interface to a collection that accepts multiple keys that compare equal to each other.
Class rw_orderedhashmap<K,T,H,EQ,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::allocator_type RWTValOrderedHashMap< K, T, H, EQ, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTValOrderedHashMap< K, T, H, EQ, A >::const_iterator |
A type that provides a const
forward iterator over the elements in the container.
typedef container_type::const_pointer RWTValOrderedHashMap< K, T, H, EQ, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTValOrderedHashMap< K, T, H, EQ, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef rw_orderedhashmap<K, T, H, EQ, A> RWTValOrderedHashMap< K, T, H, EQ, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTValOrderedHashMap< K, T, H, EQ, A >::difference_type |
A signed integral type used to indicate the distance between two valid iterators on the same container.
typedef container_type::hasher RWTValOrderedHashMap< K, T, H, EQ, A >::hasher |
A type representing the hash function.
typedef container_type::iterator RWTValOrderedHashMap< K, T, H, EQ, A >::iterator |
A type that provides a forward iterator over the elements in the container.
typedef container_type::key_equal_type RWTValOrderedHashMap< K, T, H, EQ, A >::key_equal |
A type representing the equality function.
typedef container_type::key_type RWTValOrderedHashMap< K, T, H, EQ, A >::key_type |
A type representing the key of the container.
typedef container_type::mapped_type RWTValOrderedHashMap< K, T, H, EQ, A >::mapped_type |
A type representing the mapped value of the container.
typedef container_type::pointer RWTValOrderedHashMap< K, T, H, EQ, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTValOrderedHashMap< K, T, H, EQ, A >::reference |
A type that provides a reference to an element in the container.
typedef container_type::size_type RWTValOrderedHashMap< K, T, H, EQ, A >::size_type |
An unsigned integral type used for counting the number of elements in the container.
typedef container_type::value_type RWTValOrderedHashMap< K, T, H, EQ, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty map.
|
inline |
Constructs a map by copying all elements of m.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed map takes ownership of the data owned by rws.
|
inline |
Move constructor. The constructed map takes ownership of the data owned by rws.
|
inline |
Constructs a map by copying elements from the range [first, last). The underlying representation has sz buckets, uses h for its hashing function, and uses eq to determine equality between elements.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Creates an empty map which uses the hash object h and has an initial capacity of sz.
void RWTValOrderedHashMap< K, T, H, EQ, A >::apply | ( | void(*)(const key_type &, const mapped_type &, void *) | fn, |
void * | d | ||
) | const |
Invokes the function pointer fn on each association in the collection. Client data may be passed through parameter d.
void RWTValOrderedHashMap< K, T, H, EQ, A >::apply | ( | void(*)(const key_type &, mapped_type &, void *) | fn, |
void * | d | ||
) |
Invokes the function pointer fn on each association in the collection. Client data may be passed through parameter d.
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns the number of buckets (slots) available in the underlying hash representation. See resize().
|
inline |
Returns an iterator referring to the first element in the container.
If the container is empty, returns end().
|
inline |
Returns an iterator referring to the element after the last element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Clears the collection by removing all items from self. Each key and its associated item will have its destructor called.
|
inline |
Returns true
if there exists an association a
in self such that the expression ((*fn)(a,d))
is true
, otherwise returns false
. Client data may be passed through parameter d.
|
inline |
Returns true
if there exists a key j
in self that compares equal to key, otherwise returns false
.
|
inline |
Returns an iterator referring to the element after the last element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Returns an iterator referring to the element after the last element in the container.
Dereferencing the iterator returned by this function results in undefined behavior.
|
inline |
Returns the number of associations in self.
|
inline |
Removes the item pointed to by pos from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.
|
inline |
Removes the items in the range [first, last) from the collection. Returns an iterator that points to the next item in the collection, or end() if the last item in the collection was removed.
|
inline |
Returns the ratio entries() / capacity().
|
inline |
If there exists an association a
in self such that the expression ((*fn)(a,d))
is true
, assigns a
to r and returns true
. Otherwise, returns false
and leaves the value of r unchanged. Client data may be passed through parameter d.
|
inline |
If there exists a key j
in self that compares equal to key, assigns j
to r and returns true
. Otherwise, returns false
and leaves the value of r unchanged.
|
inline |
If there exists a key j
in self that compares equal to key, assigns j
to kr, assigns the item associated with j
to tr, and returns true
. Otherwise, returns false
and leaves the values of kr and tr unchanged.
|
inline |
If there exists a key j
in self that compares equal to key, assigns the item associated with j
to r and returns true
. Otherwise, returns false
and leaves the value of r unchanged.
|
inline |
Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and returns an iterator to the new item.
The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value is inserted at a different location according to the container's hash object.
|
inline |
Inserts the elements in the range [first, last) into self. If the element is already present in the collection, it will be ignored.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Adds key with associated item a to the collection. Returns true
if the insertion is successful, otherwise returns false
. Insertion will fail if the collection already holds an association with the equivalent key.
|
inline |
Adds key with associated item a to the collection. Returns true
if the insertion is successful, otherwise returns false
. Insertion will fail if the collection already holds an association with the equivalent key.
|
inline |
Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and returns an iterator to the new item.
The hint parameter indicates where in the collection the new value should be inserted. This value is only a hint, and will be ignored if the value is inserted at a different location according to the container's hash object.
P
is a type that is convertible to value_type.
|
inline |
Returns true
if there are no items in the collection, otherwise false
.
|
inline |
Returns a reference to the maximum key in the collection. Type key_type must have well-defined less-than semantics (K::operator<(const K&)
or equivalent).
|
inline |
Returns a reference to the minimum key in the collection. Type key_type must have well-defined less-than semantics (K::operator<(const K&)
or equivalent).
|
inline |
Returns the number of associations a
in self such that the expression ((*fn)(a,d))
is true
. Client data may be passed through parameter d.
|
inline |
Returns the number of keys j
in self that compare equal to key.
|
inline |
Destroys all elements of self and replaces them by copying all associations from rhs.
|
inline |
Destroys all elements of self and replaces them by copying all associations from rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
inline |
Move assignment. Self takes ownership of the data owned by rhs.
|
inline |
Looks up key and returns a reference to its associated item. If the key is not in the dictionary, then it is added with an associated item provided by the default constructor for type mapped_type.
|
inline |
Removes the first association a
in self such that the expression ((*fn)(a,d))
is true
, and returns true
. Returns false
if there is no such element. Client data may be passed through parameter d.
|
inline |
Removes the first association with key j
in self such that the expression (j == key)
is true
, and returns true
. Returns false
if there is no such association.
RWTValOrderedHashMap< K, T, H, EQ, A >::size_type RWTValOrderedHashMap< K, T, H, EQ, A >::removeAll | ( | bool(*)(const_reference, void *) | fn, |
void * | d | ||
) |
Removes all associations a
in self such that the expression ((*fn)(a,d))
is true
. Returns the number of items removed. Client data may be passed through parameter d.
|
inline |
Removes all elements j
in self that compare equal to key. Returns the number of items removed.
|
inline |
Changes the capacity of self by creating a new map with a capacity of sz. This method copies every element of self into the new container and finally swaps the internal representation of the new container with the internal representation of self.
|
inline |
Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library-compliant collections.
|
inline |
Returns a reference to the underlying collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard Library interface as well as interoperability with other software components that make use of the C++ Standard Library-compliant collections.
|
inline |
Swaps the data held by self with the data held by other, including the H
and EQ
objects. This method does not copy or destroy any of the items swapped; rather, it swaps the underlying hash tables.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Equivalent to !(lhs == rhs)
.
|
related |
Saves the collection coll to the output stream strm, or a reference to it if it has already been saved.
|
related |
Saves the collection coll to the RWFile strm, or a reference to it if it has already been saved.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and if for each key in the first container, the set of values associated with that key is equal to the set of values associated with that key in the second container.
|
related |
Restores the contents of the collection coll from the input stream strm.
|
related |
Restores the contents of the collection coll from the RWFile strm.
|
related |
Looks at the next object on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.
|
related |
Looks at the next object on the RWFile strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then the application is responsible for deleting it.
Copyright © 2021 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |