SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Maintains a hash-based collection of class T
elements, in which there may be many equivalent instances of an element and the key insertion order is preserved.
More...
#include <rw/tools/tvordhmset.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_orderedhashmultiset< 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::pointer | pointer |
typedef container_type::reference | reference |
typedef container_type::size_type | size_type |
typedef container_type::value_type | value_type |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class H , class EQ , class A > | |
bool | operator!= (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator!= (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator!= (const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTValOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
RWFile & | operator<< (RWFile &file, const RWTValOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
bool | operator== (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator== (const RWTValOrderedHashMultiSet< T, H, EQ, A > &lhs, const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator== (const typename RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type &lhs, const RWTValOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTValOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTValOrderedHashMultiSet< T, H, EQ, A > *&p) |
template<class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTValOrderedHashMultiSet< T, H, EQ, A > *&p) |
RWTValOrderedHashMultiSet maintains a collection of class T
elements, stored according to a hash object of type H
. RWTValOrderedHashMultiSet preserves the key insertion order. If the collection already contains items with the same key, the item will be inserted immediately after those items.
Class 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 T
and returns a value of type size_t
.
Equivalent elements within the collection are grouped together based on an equality object of type EQ
. EQ
must ensure this grouping via a function that takes two arguments convertible to type T
and returns a value of type bool
.
RWTValOrderedHashMultiSet may contain multiple elements that are equivalent to each other.
The value
type must have operator==()
defined. This requirement is imposed by the C++ Standard Library.
Class RWTValOrderedHashSet offers the same interface to a collection that does not accept multiple items that compare equal to each other.
Class rw_orderedhashmultiset<T,H,EQ,A> is the C++ Standard Library collection class that serves as the underlying implementation for RWTValOrderedHashMultiSet.
typedef container_type::allocator_type RWTValOrderedHashMultiSet< T, H, EQ, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTValOrderedHashMultiSet< 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 RWTValOrderedHashMultiSet< T, H, EQ, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTValOrderedHashMultiSet< T, H, EQ, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef rw_orderedhashmultiset<T, H, EQ, A> RWTValOrderedHashMultiSet< T, H, EQ, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTValOrderedHashMultiSet< 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 RWTValOrderedHashMultiSet< T, H, EQ, A >::hasher |
A type representing the hash function.
typedef container_type::iterator RWTValOrderedHashMultiSet< T, H, EQ, A >::iterator |
A type that provides a forward iterator over the elements in the container.
typedef container_type::key_equal_type RWTValOrderedHashMultiSet< T, H, EQ, A >::key_equal |
A type representing the equality function.
typedef container_type::key_type RWTValOrderedHashMultiSet< T, H, EQ, A >::key_type |
A type representing the key of the container.
typedef container_type::pointer RWTValOrderedHashMultiSet< T, H, EQ, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTValOrderedHashMultiSet< T, H, EQ, A >::reference |
A type that provides a reference to an element in the container.
typedef container_type::size_type RWTValOrderedHashMultiSet< 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 RWTValOrderedHashMultiSet< T, H, EQ, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty set. The underlying hash table representation has sz buckets, uses h as its hashing function, and uses eq to determine equivalence between elements.
|
inline |
Constructs a set by copying all elements of s.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed multi-set takes ownership of the data owned by rws.
|
inline |
Move constructor. The constructed multi-set takes ownership of the data owned by rws.
|
inline |
Constructs a set by copying elements from the range [first, last). The underlying hash table representation has sz buckets, uses h as its hashing function, and uses eq to determine equivalence between elements.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Creates an empty multi-set that uses the hash object h and has an initial hash table capacity of sz.
|
inline |
Invokes the function pointer fn on each item 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 item has its destructor called.
|
inline |
Returns true
if there exists an element t
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 an element t
in self that compares equal to a, otherwise returns false
.
|
inline |
Sets self to the set-theoretic difference given by (self - s)
.
|
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 elements 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 element t
in self that compares equal to a
, assigns t
to k and returns true
. Otherwise, returns false
and leaves the value of k unchanged. Client data may be passed through parameter d.
|
inline |
If there exists an element t
in self such that the expression (t == a)
is true
, assigns t
to k and returns true
. Otherwise, returns false
and leaves the value of k unchanged.
|
inline |
Adds the item a to the collection. Returns true
.
|
inline |
Inserts val into self. 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.
InputIterator
is an input iterator type that points to elements that are convertible to value_type objects.
|
inline |
Adds the item a to the collection. Returns true
.
|
inline |
Inserts val into self. 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 |
Destructively performs a set-theoretic intersection of self and s, replacing the contents of self with the result.
|
inline |
Returns true
if there are no items in the collection, otherwise returns false
.
|
inline |
Returns true
if self and s are identical, otherwise returns false
.
|
inline |
Returns true
if self is a proper subset of s, otherwise returns false
.
|
inline |
Returns true
if self is a subset of s, otherwise returns false
.
|
inline |
Returns the number of elements t
in self such that the expression ((*fn)(a,d))
is true
. Client data may be passed through parameter d.
|
inline |
Returns the number of elements t
in self that compare equal to a.
|
inline |
Destroys all elements of self and replaces them by copying all elements of rhs.
|
inline |
Destroys all elements of self and replaces them by copying all elements of 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 |
Removes the first element t
in self such that the expression ((*fn)(a,d))
is true
, and returns true
. If there is no such element, returns false
. Client data may be passed through parameter d.
|
inline |
Removes the first element t
in self that compares equal to a and returns true
. If there is no such element, returns false
.
RWTValOrderedHashMultiSet< T, H, EQ, A >::size_type RWTValOrderedHashMultiSet< T, H, EQ, A >::removeAll | ( | bool(*)(const_reference, void *) | fn, |
void * | d | ||
) |
Removes all elements t
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 t
in self that compare equal to a. Returns the number of items removed.
|
inline |
Changes the capacity of self by creating a new multi-set with a capacity of sz. resize() 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 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 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.
|
inline |
Destructively performs a set-theoretic symmetric difference operation on self and s. Self is replaced by the result. A symmetric difference can be informally defined as \((A \cup B) \setminus (A \cap B)\).
|
inline |
Destructively performs a set-theoretic union operation on self and rhs. Self is replaced by the result. Note the uppercase 'U'
in Union
to avoid conflict with the C++ reserved word.
|
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 file, or a reference to the file if the collection 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 iterating through both collections produces, in turn, individual elements that compare equal to each other.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and iterating through both collections produces, in turn, individual elements that compare equal to each other.
|
related |
Restores the contents of the collection coll from the input stream strm.
|
related |
Restores the contents of the collection coll from the RWFile file.
|
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, the application is responsible for deleting it.
|
related |
Looks at the next object on the stream represented by RWFile file 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, the application is responsible for deleting it.
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |