SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Maintains a hash-based collection of class T
pointer elements, in which there may be many equivalent instances of an element and the key insertion order is preserved.
More...
#include <rw/tools/tpordhmset.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 *, hasher, key_equal, A > | container_type |
typedef container_type::difference_type | difference_type |
typedef rw_deref_hash< H, T > | hasher |
typedef container_type::iterator | iterator |
typedef rw_deref_compare< EQ, T > | 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 |
Public Member Functions | |
RWTPtrOrderedHashMultiSet (size_type sz=64, const H &h=H(), const EQ &eq=EQ()) | |
RWTPtrOrderedHashMultiSet (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rws) | |
RWTPtrOrderedHashMultiSet (RWTPtrOrderedHashMultiSet< T, H, EQ, A > &&rws) | |
RWTPtrOrderedHashMultiSet (container_type &&rws) | |
RWTPtrOrderedHashMultiSet (const container_type &s) | |
template<typename InputIterator > | |
RWTPtrOrderedHashMultiSet (InputIterator first, InputIterator last, size_type sz=64, const H &h=H(), const EQ &eq=EQ()) | |
RWTPtrOrderedHashMultiSet (const H &h, size_type sz=64) | |
void | apply (void(*fn)(const T *, void *), void *d) const |
iterator | begin () |
const_iterator | begin () const |
size_type | capacity () const |
const_iterator | cbegin () const |
const_iterator | cend () const |
void | clear () |
void | clearAndDestroy () |
bool | contains (bool(*fn)(const T *, void *), void *d) const |
bool | contains (const T *a) const |
void | difference (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &s) |
iterator | end () |
const_iterator | end () const |
size_type | entries () const |
iterator | erase (iterator pos) |
iterator | erase (iterator first, iterator last) |
float | fillRatio () const |
const T * | find (bool(*fn)(const T *, void *), void *d) const |
value_type | find (const T *a) |
const T * | find (const T *a) const |
bool | insert (value_type a) |
iterator | insert (iterator hint, value_type val) |
template<typename InputIterator > | |
void | insert (InputIterator first, InputIterator last) |
void | intersection (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &s) |
bool | isEmpty () const |
bool | isEquivalent (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &s) const |
bool | isProperSubsetOf (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &s) const |
bool | isSubsetOf (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &s) const |
size_type | occurrencesOf (bool(*fn)(const T *, void *), void *d) const |
size_type | occurrencesOf (const T *a) const |
RWTPtrOrderedHashMultiSet< T, H, EQ, A > & | operator= (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
RWTPtrOrderedHashMultiSet< T, H, EQ, A > & | operator= (const container_type &rhs) |
RWTPtrOrderedHashMultiSet< T, H, EQ, A > & | operator= (RWTPtrOrderedHashMultiSet< T, H, EQ, A > &&rhs) |
RWTPtrOrderedHashMultiSet< T, H, EQ, A > & | operator= (container_type &&rhs) |
value_type | remove (bool(*fn)(const T *, void *), void *d) |
value_type | remove (const T *a) |
size_type | removeAll (bool(*fn)(const T *, void *), void *d) |
size_type | removeAll (const T *a) |
void | resize (size_type sz) |
container_type & | std () |
const container_type & | std () const |
void | swap (RWTPtrOrderedHashMultiSet< T, H, EQ, A > &other) |
void | symmetricDifference (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
void | Union (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
Related Functions | |
(Note that these are not member functions.) | |
template<class T , class H , class EQ , class A > | |
bool | operator!= (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &lhs, const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator!= (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &lhs, const typename RWTPtrOrderedHashMultiSet< T, H, EQ, A >::container_type &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator!= (const typename RWTPtrOrderedHashMultiSet< T, H, EQ, A >::container_type &lhs, const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
RWvostream & | operator<< (RWvostream &strm, const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
RWFile & | operator<< (RWFile &file, const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
bool | operator== (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &lhs, const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator== (const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &lhs, const typename RWTPtrOrderedHashMultiSet< T, H, EQ, A >::container_type &rhs) |
template<class T , class H , class EQ , class A > | |
bool | operator== (const typename RWTPtrOrderedHashMultiSet< T, H, EQ, A >::container_type &lhs, const RWTPtrOrderedHashMultiSet< T, H, EQ, A > &rhs) |
template<class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTPtrOrderedHashMultiSet< T, H, EQ, A > &coll) |
template<class T , class H , class EQ , class A > | |
RWvistream & | operator>> (RWvistream &strm, RWTPtrOrderedHashMultiSet< T, H, EQ, A > *&p) |
template<class T , class H , class EQ , class A > | |
RWFile & | operator>> (RWFile &file, RWTPtrOrderedHashMultiSet< T, H, EQ, A > *&p) |
RWTPtrOrderedHashMultiSet maintains a collection of class T
pointer elements stored according to a hash object of type H
. RWTPtrOrderedHashMultiSet 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
.
This class allows multiple items that are equivalent to each other. Use RWTPtrOrderedHashSet if you need a class that does not allow equivalent values.
The value
type must have operator==()
defined. This requirement is imposed by the C++ Standard Library.
Class RWTPtrOrderedHashSet offers the same interface to a pointer-based collection that does not allow multiple items that compare equal to each other.
Class rw_orderedhashmultiset<T*,hasher,key_equal,A> is the C++ Standard Library collection that serves as the underlying implementation for this class.
typedef container_type::allocator_type RWTPtrOrderedHashMultiSet< T, H, EQ, A >::allocator_type |
A type representing the allocator type for the container.
typedef container_type::const_iterator RWTPtrOrderedHashMultiSet< 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 RWTPtrOrderedHashMultiSet< T, H, EQ, A >::const_pointer |
A type that provides a const
pointer to an element in the container.
typedef container_type::const_reference RWTPtrOrderedHashMultiSet< T, H, EQ, A >::const_reference |
A type that provides a const
reference to an element in the container.
typedef rw_orderedhashmultiset< T*, hasher, key_equal, A> RWTPtrOrderedHashMultiSet< T, H, EQ, A >::container_type |
A type representing the underlying implementation container.
typedef container_type::difference_type RWTPtrOrderedHashMultiSet< T, H, EQ, A >::difference_type |
A signed integral type used to indicate the distance between two valid iterators on the same container.
typedef rw_deref_hash<H, T> RWTPtrOrderedHashMultiSet< T, H, EQ, A >::hasher |
A type representing a hash function that dereferences the arguments before comparing.
typedef container_type::iterator RWTPtrOrderedHashMultiSet< T, H, EQ, A >::iterator |
A type that provides a forward iterator over the elements in the container.
typedef rw_deref_compare<EQ, T> RWTPtrOrderedHashMultiSet< T, H, EQ, A >::key_equal |
A type representing an equality function that dereferences the arguments before comparing.
typedef container_type::key_type RWTPtrOrderedHashMultiSet< T, H, EQ, A >::key_type |
A type representing the key of the container.
typedef container_type::pointer RWTPtrOrderedHashMultiSet< T, H, EQ, A >::pointer |
A type that provides a pointer to an element in the container.
typedef container_type::reference RWTPtrOrderedHashMultiSet< T, H, EQ, A >::reference |
A type that provides a reference to an element in the container.
typedef container_type::size_type RWTPtrOrderedHashMultiSet< 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 RWTPtrOrderedHashMultiSet< T, H, EQ, A >::value_type |
A type representing the container's data type.
|
inline |
Constructs an empty multi-set. The hash table representation used by this multi-set has sz buckets, uses h as a hashing function, and eq to test for equality between stored elements.
|
inline |
Copy constructor.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by rws.
|
inline |
Move constructor. The constructed list takes ownership of the data owned by rws.
|
inline |
Constructs a multi-set, copying all elements from s.
|
inline |
Constructs a set by copying elements from the range [first, last). The hash table representation used by this multi-set has sz buckets, uses h as a hashing function, and eq to test for equality between stored 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.
|
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.
|
inline |
Removes all items from the collection and uses operator delete
to destroy the elements pointed to by those items. Do not use this method if multiple pointers to the same element are stored.
|
inline |
Returns true
if there exists an element t
in self such that the expression ((*fn)(t,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). Elements from each set are dereferenced before being compared.
|
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 such that the expression ((*fn)(t,d))
is true
, returns t
, otherwise returns rwnil. Client data may be passed through parameter d.
|
inline |
If there exists an element t
in self that compares equal to *a
, returns t
, otherwise returns rwnil.
|
inline |
If there exists an element t
in self that compares equal to *a
, returns t
, otherwise returns rwnil.
|
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 |
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 or if self is set equivalent to s, otherwise returns false
.
|
inline |
Returns the number of elements t
in self such that the expression ((*fn)(t,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 |
Clears all elements of self and replaces them by copying all elements of rhs.
|
inline |
Clears 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 and returns the first element t
in self such that the expression ((*fn)(t,d))
is true
. Returns rwnil if there is no such element. Client data may be passed through parameter d.
|
inline |
Removes and returns the first element t
in self that compares equal to *a
. Returns rwnil if there is no such element.
RWTPtrOrderedHashMultiSet< T, H, EQ, A >::size_type RWTPtrOrderedHashMultiSet< T, H, EQ, A >::removeAll | ( | bool(*)(const T *, void *) | fn, |
void * | d | ||
) |
Removes all elements t
in self such that the expression ((*fn)(t,d))
is true
. Returns the number of elements 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 elements removed.
|
inline |
Changes the capacity of self by creating a new multi-set with a capacity of sz. 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 C++ Standard Library collection that serves as the implementation for self.
|
inline |
Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.
|
inline |
Swaps the data held by self with the data held by other, including the T
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 rhs. Self is replaced by the result. A symmetric difference can be informally defined as \((A \cup B) / (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 |
Streams the collection coll to the RWFile file, 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 each is a subset of the other. Elements are dereferenced before being compared.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and each is a subset of the other. Elements are dereferenced before being compared.
|
related |
Returns true
if lhs and rhs are equal, otherwise false
. Two collections are equal if both have the same number of entries, and each is a subset of the other. Elements are dereferenced before being compared.
|
related |
Restores the contents of the collection coll from the input stream strm.
|
related |
Restores the contents of the collection coll by streaming from the RWFile file.
|
related |
Looks at the next element 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 element from the streamed 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. |