SourcePro® API Reference Guide

 
List of all members | Public Types | Public Member Functions | Related Functions
RWTPtrMultiSet< T, C, A > Class Template Reference

A pointer-based collection of values ordered according to a comparison object, and allowing duplicate values. More...

#include <rw/tpmset.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 container_type::const_reverse_iterator const_reverse_iterator
 
typedef rw_deref_compare< C, T > container_comp
 
typedef std::multiset< T *, key_compare, A > container_type
 
typedef container_type::difference_type difference_type
 
typedef container_type::iterator iterator
 
typedef rw_deref_compare< C, T > key_compare
 
typedef container_type::key_type key_type
 
typedef container_type::pointer pointer
 
typedef container_type::reference reference
 
typedef container_type::reverse_iterator reverse_iterator
 
typedef container_type::size_type size_type
 
typedef container_type::value_compare value_compare
 
typedef container_type::value_type value_type
 

Public Member Functions

 RWTPtrMultiSet (const key_compare &cmp=key_compare())
 
 RWTPtrMultiSet (const container_type &ms)
 
 RWTPtrMultiSet (const RWTPtrMultiSet< T, C, A > &rws)
 
 RWTPtrMultiSet (RWTPtrMultiSet< T, C, A > &&rws)
 
 RWTPtrMultiSet (container_type &&rws)
 
template<typename InputIterator >
 RWTPtrMultiSet (InputIterator first, InputIterator last, const key_compare &cmp=key_compare())
 
void apply (void(*fn)(const T *, void *), void *d) const
 
iterator begin ()
 
const_iterator begin () 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
 
const_reverse_iterator crbegin () const
 
const_reverse_iterator crend () const
 
void difference (const RWTPtrMultiSet< T, C, A > &s)
 
iterator end ()
 
const_iterator end () const
 
size_type entries () const
 
iterator erase (iterator pos)
 
iterator erase (iterator first, iterator last)
 
const T * find (bool(*fn)(const T *, void *), void *d) const
 
const T * find (const T *a) const
 
value_type find (const T *a)
 
bool insert (value_type a)
 
iterator insert (iterator hint, value_type val)
 
template<typename InputIterator >
void insert (InputIterator first, InputIterator last)
 
void intersection (const RWTPtrMultiSet< T, C, A > &s)
 
bool isEmpty () const
 
bool isEquivalent (const RWTPtrMultiSet< T, C, A > &s) const
 
bool isProperSubsetOf (const RWTPtrMultiSet< T, C, A > &s) const
 
bool isSubsetOf (const RWTPtrMultiSet< T, C, A > &s) const
 
size_type occurrencesOf (bool(*fn)(const T *, void *), void *d) const
 
size_type occurrencesOf (const T *a) const
 
RWTPtrMultiSet< T, C, A > & operator= (const RWTPtrMultiSet< T, C, A > &rhs)
 
RWTPtrMultiSet< T, C, A > & operator= (const container_type &rhs)
 
RWTPtrMultiSet< T, C, A > & operator= (RWTPtrMultiSet< T, C, A > &&rhs)
 
RWTPtrMultiSet< T, C, A > & operator= (container_type &&rhs)
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
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)
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
container_typestd ()
 
const container_typestd () const
 
void swap (RWTPtrMultiSet< T, C, A > &other)
 
void symmetricDifference (const RWTPtrMultiSet< T, C, A > &s)
 
void Union (const RWTPtrMultiSet< T, C, A > &s)
 

Related Functions

(Note that these are not member functions.)

template<class T , class C , class A >
bool operator!= (const RWTPtrMultiSet< T, C, A > &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator!= (const RWTPtrMultiSet< T, C, A > &lhs, const typename RWTPtrMultiSet< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator!= (const typename RWTPtrMultiSet< T, C, A >::container_type &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator< (const RWTPtrMultiSet< T, C, A > &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator< (const RWTPtrMultiSet< T, C, A > &lhs, const typename RWTPtrMultiSet< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator< (const typename RWTPtrMultiSet< T, C, A >::container_type &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
RWvostreamoperator<< (RWvostream &strm, const RWTPtrMultiSet< T, C, A > &coll)
 
template<class T , class C , class A >
RWFileoperator<< (RWFile &strm, const RWTPtrMultiSet< T, C, A > &coll)
 
template<class T , class C , class A >
bool operator<= (const RWTPtrMultiSet< T, C, A > &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator<= (const RWTPtrMultiSet< T, C, A > &lhs, const typename RWTPtrMultiSet< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator<= (const typename RWTPtrMultiSet< T, C, A >::container_type &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator== (const RWTPtrMultiSet< T, C, A > &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator== (const RWTPtrMultiSet< T, C, A > &lhs, const typename RWTPtrMultiSet< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator== (const typename RWTPtrMultiSet< T, C, A >::container_type &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator> (const RWTPtrMultiSet< T, C, A > &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator> (const RWTPtrMultiSet< T, C, A > &lhs, const typename RWTPtrMultiSet< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator> (const typename RWTPtrMultiSet< T, C, A >::container_type &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator>= (const RWTPtrMultiSet< T, C, A > &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
bool operator>= (const RWTPtrMultiSet< T, C, A > &lhs, const typename RWTPtrMultiSet< T, C, A >::container_type &rhs)
 
template<class T , class C , class A >
bool operator>= (const typename RWTPtrMultiSet< T, C, A >::container_type &lhs, const RWTPtrMultiSet< T, C, A > &rhs)
 
template<class T , class C , class A >
RWvistreamoperator>> (RWvistream &strm, RWTPtrMultiSet< T, C, A > &coll)
 
template<class T , class C , class A >
RWFileoperator>> (RWFile &strm, RWTPtrMultiSet< T, C, A > &coll)
 
template<class T , class C , class A >
RWvistreamoperator>> (RWvistream &strm, RWTPtrMultiSet< T, C, A > *&p)
 
template<class T , class C , class A >
RWFileoperator>> (RWFile &strm, RWTPtrMultiSet< T, C, A > *&p)
 

Detailed Description

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
class RWTPtrMultiSet< T, C, A >

This class maintains a pointer-based collection of values, which are ordered according to a comparison object of type C. Class T is the type pointed to by the items in the collection. 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.

C must induce a total ordering on elements of type T via a public member

bool operator()(const T& x, const T& y)

that returns true if x should precede y within the collection. The structure std::less<T> from the C++ Standard Library header file <functional> is an example. Note that items in the collection will be dereferenced before being compared.

RWTPtrMultiSet may contain multiple items that compare equal to each other. (RWTPtrSet will not accept an item that compares equal to an item already in the collection.)

The value type must have operator== and operator< defined. This requirement is imposed by the C++ Standard Library.

Synopsis
#include <rw/tpmset.h>
See also

Class RWTPtrSet offers the same interface to a pointer-based collection that will not accept multiple items that compare equal to each other. RWTPtrMultiMap maintains a pointer-based collection of key-value pairs.

Class std::multiset<T*, key_compare,A > is the C++ Standard Library collection that serves as the underlying implementation for this class.

Persistence
Isomorphic.
Example
// tpmset.cpp
//
#include <rw/tpmset.h>
#include <rw/cstring.h>
#include <iostream.h>
#include <functional>
int main(){
set.insert(new RWCString("one"));
set.insert(new RWCString("two"));
set.insert(new RWCString("three"));
set.insert(new RWCString("one")); // OK: duplicates allowed
std::cout << set.entries() << std::endl; // Prints "4"
std::cout << set.entries() << std::endl; // Prints "0"
return 0;
}

Program output:

4
0

Member Typedef Documentation

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::allocator_type RWTPtrMultiSet< T, C, A >::allocator_type

A type representing the allocator type for the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_iterator RWTPtrMultiSet< T, C, A >::const_iterator

A type that provides a const bidirectional iterator over the elements in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_pointer RWTPtrMultiSet< T, C, A >::const_pointer

A type that provides a const pointer to an element in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_reference RWTPtrMultiSet< T, C, A >::const_reference

A type that provides a const reference to an element in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::const_reverse_iterator RWTPtrMultiSet< T, C, A >::const_reverse_iterator

A type that provides a const bidirectional, reverse-order iterator over the elements in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef rw_deref_compare<C, T> RWTPtrMultiSet< T, C, A >::container_comp
Deprecated:
As of SourcePro 12.5, use key_compare instead.

A type representing a comparison function that dereferences the arguments before comparing.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef std::multiset<T*, key_compare, A> RWTPtrMultiSet< T, C, A >::container_type

A type representing the underlying implementation container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::difference_type RWTPtrMultiSet< T, C, A >::difference_type

A signed integral type used to indicate the distance between two valid iterators on the same container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::iterator RWTPtrMultiSet< T, C, A >::iterator

A type that provides a bidirectional iterator over the elements in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef rw_deref_compare<C, T> RWTPtrMultiSet< T, C, A >::key_compare

A type representing a comparison function that dereferences the arguments before comparing.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::key_type RWTPtrMultiSet< T, C, A >::key_type

A type representing the key of the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::pointer RWTPtrMultiSet< T, C, A >::pointer

A type that provides a pointer to an element in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::reference RWTPtrMultiSet< T, C, A >::reference

A type that provides a reference to an element in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::reverse_iterator RWTPtrMultiSet< T, C, A >::reverse_iterator

A type that provides a bidirectional, reverse-order iterator over the elements in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::size_type RWTPtrMultiSet< T, C, A >::size_type

An unsigned integral type used for counting the number of elements in the container.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::value_compare RWTPtrMultiSet< T, C, A >::value_compare

A type representing a comparison function that dereferences the arguments before comparing.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
typedef container_type::value_type RWTPtrMultiSet< T, C, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet ( const key_compare cmp = key_compare())
inline

Constructs an empty set.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet ( const container_type ms)
inline

Constructs a multimap by copying all elements from ms.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet ( const RWTPtrMultiSet< T, C, A > &  rws)
inline

Copy constructor.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet ( RWTPtrMultiSet< T, C, A > &&  rws)
inline

Move constructor. The constructed list takes ownership of the data owned by rws.

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet ( container_type &&  rws)
inline

Move constructor. The constructed list takes ownership of the data owned by rws.

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
template<typename InputIterator >
RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet ( InputIterator  first,
InputIterator  last,
const key_compare cmp = key_compare() 
)
inline

Constructs a set by copying elements from the range [first, last).

InputIterator is an input iterator type that points to elements that are convertible to value_type objects.

Member Function Documentation

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::apply ( void(*)(const T *, void *)  fn,
void *  d 
) const
inline

Invokes the function pointer fn on each item in the collection. Client data may be passed through parameter d.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrMultiSet< T, C, A >::begin ( )
inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrMultiSet< T, C, A >::begin ( ) const
inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrMultiSet< T, C, A >::cbegin ( ) const
inline

Returns an iterator referring to the first element in the container.

If the container is empty, returns end().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrMultiSet< T, C, A >::cend ( ) const
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::clear ( void  )
inline

Clears the collection by removing all items from self.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::clearAndDestroy ( void  )
inline

Removes all items from the collection and uses operator delete to destroy the objects pointed to by those items. Do not use this method if multiple pointers to the same object are stored.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::contains ( bool(*)(const T *, void *)  fn,
void *  d 
) const
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::contains ( const T *  a) const
inline

Returns true if there exists an element t in self that compares equal to *a, otherwise returns false.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrMultiSet< T, C, A >::crbegin ( ) const
inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrMultiSet< T, C, A >::crend ( ) const
inline

Returns an iterator referring to the element before the first element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::difference ( const RWTPtrMultiSet< T, C, A > &  s)
inline

Sets self to the set-theoretic difference given by (self - s). Elements from each set are dereferenced before being compared.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrMultiSet< T, C, A >::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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_iterator RWTPtrMultiSet< T, C, A >::end ( ) const
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrMultiSet< T, C, A >::entries ( void  ) const
inline

Returns the number of elements in self.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrMultiSet< T, C, A >::erase ( iterator  pos)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrMultiSet< T, C, A >::erase ( iterator  first,
iterator  last 
)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const T* RWTPtrMultiSet< T, C, A >::find ( bool(*)(const T *, void *)  fn,
void *  d 
) const
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const T* RWTPtrMultiSet< T, C, A >::find ( const T *  a) const
inline

If there exists an element t in self such that the expression (*t == *a) is true, returns t. Otherwise, returns rwnil.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrMultiSet< T, C, A >::find ( const T *  a)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::insert ( value_type  a)
inline

Adds the item a to the collection. Returns true.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
iterator RWTPtrMultiSet< T, C, A >::insert ( iterator  hint,
value_type  val 
)
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 should be inserted at a different location according to the container's comparison object.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
template<typename InputIterator >
void RWTPtrMultiSet< T, C, A >::insert ( InputIterator  first,
InputIterator  last 
)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::intersection ( const RWTPtrMultiSet< T, C, A > &  s)
inline

Sets self to the intersection of self and s. Elements from each set are dereferenced before being compared.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::isEmpty ( ) const
inline

Returns true if there are no items in the collection, otherwise false.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::isEquivalent ( const RWTPtrMultiSet< T, C, A > &  s) const
inline

Returns true if self and s are identical, otherwise returns false.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::isProperSubsetOf ( const RWTPtrMultiSet< T, C, A > &  s) const
inline

Returns true if self is a proper subset of s, otherwise returns false.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
bool RWTPtrMultiSet< T, C, A >::isSubsetOf ( const RWTPtrMultiSet< T, C, A > &  s) const
inline

Returns true if self is a subset of s or if self is set equivalent to rhs, otherwise false.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrMultiSet< T, C, A >::occurrencesOf ( bool(*)(const T *, void *)  fn,
void *  d 
) const
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrMultiSet< T, C, A >::occurrencesOf ( const T *  a) const
inline

Returns the number of elements t in self that compare equal to *a.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet<T, C, A>& RWTPtrMultiSet< T, C, A >::operator= ( const RWTPtrMultiSet< T, C, A > &  rhs)
inline

Clears all elements of self and replaces them by copying all elements of rhs.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet<T, C, A>& RWTPtrMultiSet< T, C, A >::operator= ( const container_type rhs)
inline

Clears all elements of self and replaces them by copying all elements of rhs.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet<T, C, A>& RWTPtrMultiSet< T, C, A >::operator= ( RWTPtrMultiSet< T, C, A > &&  rhs)
inline

Move assignment. Self takes ownership of the data owned by rhs.

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
RWTPtrMultiSet<T, C, A>& RWTPtrMultiSet< T, C, A >::operator= ( container_type &&  rhs)
inline

Move assignment. Self takes ownership of the data owned by rhs.

Condition:
This method is available only on platforms with rvalue reference support.
template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reverse_iterator RWTPtrMultiSet< T, C, A >::rbegin ( )
inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrMultiSet< T, C, A >::rbegin ( ) const
inline

Returns an iterator referring to the last element in the container.

If the container is empty, returns rend().

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrMultiSet< T, C, A >::remove ( bool(*)(const T *, void *)  fn,
void *  d 
)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
value_type RWTPtrMultiSet< T, C, A >::remove ( const T *  a)
inline

Removes and returns the first element t in self that compares equal to *a. Returns rwnil if there is no such element.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrMultiSet< T, C, 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 items removed. Client data may be passed through parameter d.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
size_type RWTPtrMultiSet< T, C, A >::removeAll ( const T *  a)
inline

Removes all elements t in self that compare equal to *a. Returns the number of items removed.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
reverse_iterator RWTPtrMultiSet< T, C, A >::rend ( )
inline

Returns an iterator referring to the element before the first element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const_reverse_iterator RWTPtrMultiSet< T, C, A >::rend ( ) const
inline

Returns an iterator referring to the element before the first element in the container.

Dereferencing the iterator returned by this function results in undefined behavior.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
container_type& RWTPtrMultiSet< T, C, A >::std ( )
inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
const container_type& RWTPtrMultiSet< T, C, A >::std ( ) const
inline

Returns a reference to the underlying C++ Standard Library collection that serves as the implementation for self.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::swap ( RWTPtrMultiSet< T, C, A > &  other)
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.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::symmetricDifference ( const RWTPtrMultiSet< T, C, A > &  s)
inline

Sets self to the symmetric difference of self and s. Elements from each set are dereferenced before being compared.

template<class T, class C = std::less<T>, class A = std::allocator<T*>>
void RWTPtrMultiSet< T, C, A >::Union ( const RWTPtrMultiSet< T, C, A > &  s)
inline

Sets self to the union of self and s. Elements from each set are dereferenced before being compared.

Note
The uppercase "U" in Union avoids conflict with the C++ reserved word.

Friends And Related Function Documentation

template<class T , class C , class A >
bool operator!= ( const RWTPtrMultiSet< T, C, A > &  lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to !(lhs == rhs).

template<class T , class C , class A >
bool operator!= ( const RWTPtrMultiSet< T, C, A > &  lhs,
const typename RWTPtrMultiSet< T, C, A >::container_type rhs 
)
related

Equivalent to !(lhs == rhs).

template<class T , class C , class A >
bool operator!= ( const typename RWTPtrMultiSet< T, C, A >::container_type lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to !(lhs == rhs).

template<class T , class C , class A >
bool operator< ( const RWTPtrMultiSet< T, C, A > &  lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

template<class T , class C , class A >
bool operator< ( const RWTPtrMultiSet< T, C, A > &  lhs,
const typename RWTPtrMultiSet< T, C, A >::container_type rhs 
)
related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

template<class T , class C , class A >
bool operator< ( const typename RWTPtrMultiSet< T, C, A >::container_type lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Returns true if lhs is lexicographically less than rhs, otherwise false. Items in each collection are dereferenced before being compared. Assumes that type T has well-defined less-than semantics.

template<class T , class C , class A >
RWvostream & operator<< ( RWvostream strm,
const RWTPtrMultiSet< T, C, A > &  coll 
)
related

Saves the collection coll onto the output stream strm, or a reference to it if it has already been saved.

template<class T , class C , class A >
RWFile & operator<< ( RWFile strm,
const RWTPtrMultiSet< T, C, A > &  coll 
)
related

Saves the collection coll onto the RWFile strm, or a reference to it if it has already been saved.

template<class T , class C , class A >
bool operator<= ( const RWTPtrMultiSet< T, C, A > &  lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to !(rhs < lhs).

template<class T , class C , class A >
bool operator<= ( const RWTPtrMultiSet< T, C, A > &  lhs,
const typename RWTPtrMultiSet< T, C, A >::container_type rhs 
)
related

Equivalent to !(rhs < lhs).

template<class T , class C , class A >
bool operator<= ( const typename RWTPtrMultiSet< T, C, A >::container_type lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to !(rhs < lhs).

template<class T , class C , class A >
bool operator== ( const RWTPtrMultiSet< T, C, A > &  lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
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 individual elements that, in turn, compare equal to each other. Elements are dereferenced before being compared.

template<class T , class C , class A >
bool operator== ( const RWTPtrMultiSet< T, C, A > &  lhs,
const typename RWTPtrMultiSet< T, C, A >::container_type rhs 
)
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 individual elements that, in turn, compare equal to each other. Elements are dereferenced before being compared.

template<class T , class C , class A >
bool operator== ( const typename RWTPtrMultiSet< T, C, A >::container_type lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
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 individual elements that, in turn, compare equal to each other. Elements are dereferenced before being compared.

template<class T , class C , class A >
bool operator> ( const RWTPtrMultiSet< T, C, A > &  lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to (rhs < lhs).

template<class T , class C , class A >
bool operator> ( const RWTPtrMultiSet< T, C, A > &  lhs,
const typename RWTPtrMultiSet< T, C, A >::container_type rhs 
)
related

Equivalent to (rhs < lhs).

template<class T , class C , class A >
bool operator> ( const typename RWTPtrMultiSet< T, C, A >::container_type lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to (rhs < lhs).

template<class T , class C , class A >
bool operator>= ( const RWTPtrMultiSet< T, C, A > &  lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to !(lhs < rhs).

template<class T , class C , class A >
bool operator>= ( const RWTPtrMultiSet< T, C, A > &  lhs,
const typename RWTPtrMultiSet< T, C, A >::container_type rhs 
)
related

Equivalent to !(lhs < rhs).

template<class T , class C , class A >
bool operator>= ( const typename RWTPtrMultiSet< T, C, A >::container_type lhs,
const RWTPtrMultiSet< T, C, A > &  rhs 
)
related

Equivalent to !(lhs < rhs).

template<class T , class C , class A >
RWvistream & operator>> ( RWvistream strm,
RWTPtrMultiSet< T, C, A > &  coll 
)
related

Restores the contents of the collection coll from the input stream strm.

template<class T , class C , class A >
RWFile & operator>> ( RWFile strm,
RWTPtrMultiSet< T, C, A > &  coll 
)
related

Restores the contents of the collection coll from the RWFile strm.

template<class T , class C , class A >
RWvistream & operator>> ( RWvistream strm,
RWTPtrMultiSet< T, C, A > *&  p 
)
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.

template<class T , class C , class A >
RWFile & operator>> ( RWFile strm,
RWTPtrMultiSet< T, C, A > *&  p 
)
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 © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.