RWTPtrMultiSet< T, C, A > Class Template Reference
[STL-based Collections]

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

#include <rw/tpmset.h>

Inherits RW_PAssoc< std::multiset< T *, rw_deref_compare< C, T >,A >, RWTPtrMultiSet< T, C,A >, T >.

List of all members.

Public Types
typedef rw_deref_compare< C, T >	container_comp
typedef std::multiset< T *, container_comp,A >	container_type
typedef container_type::size_type	size_type
typedef container_type::difference_type	difference_type
typedef base_type::iterator	iterator
typedef base_type::const_iterator	const_iterator
typedef base_type::value_type	value_type
typedef base_type::reference	reference
typedef base_type::const_reference	const_reference
Public Member Functions
container_type &	std ()
const container_type &	std () const
iterator	begin ()
const_iterator	begin () const
bool	isEmpty () const
iterator	end ()
const_iterator	end () const
size_type	entries () const
bool	operator== (const RWTPtrMultiSet< T, C, A > &s) const
bool	operator!= (const RWTPtrMultiSet< T, C, A > &s) const
bool	operator< (const RWTPtrMultiSet< T, C, A > &s) const
void	clear ()
void	clearAndDestroy ()
bool	contains (bool(*fn)(const_value, void *), void *d) const
bool	contains (const_value a) const
const_value	find (bool(*fn)(const_value, void *), void *d) const
const_value	find (const_value a) const
value_type	find (const_value a)
size_type	occurrencesOf (bool(*fn)(const_value, void *), void *d) const
size_type	occurrencesOf (const_value a)
value_type	remove (bool(*fn)(const_value, void *), void *d)
value_type	remove (const_value a)
size_type	removeAll (bool(*fn)(const_value, void *), void *d)
size_type	removeAll (const_value a)
void	Union (const RWTPtrMultiSet< T, C, A > &s)
void	intersection (const RWTPtrMultiSet< T, C, A > &s)
void	difference (const RWTPtrMultiSet< T, C, A > &s)
void	symmetricDifference (const RWTPtrMultiSet< T, C, A > &s)
void	apply (void(*fn)(const T *, void *), void *d) const
bool	isSubsetOf (const RWTPtrMultiSet< T, C, A > &s) const
bool	isProperSubsetOf (const RWTPtrMultiSet< T, C, A > &s) const
bool	isEquivalent (const RWTPtrMultiSet< T, C, A > &s) const
bool	insert (T *a)
RWTPtrMultiSet< T, C,A > &	operator= (const RWTPtrMultiSet< T, C, A > &s)
RWTPtrMultiSet< T, C,A > &	operator= (const container_type &s)
RWTPtrMultiSet< T, C,A > &	operator= (RWTPtrMultiSet< T, C, A > &&rhs)
	RWTPtrMultiSet (const container_comp &cmp=container_comp())
	RWTPtrMultiSet (const container_type &ms)
	RWTPtrMultiSet (const RWTPtrMultiSet< T, C, A > &rws)
	RWTPtrMultiSet (RWTPtrMultiSet< T, C, A > &&rws)
	RWTPtrMultiSet (T *const *first, T *const *last, const container_comp &cmp=container_comp())
void	swap (RWTPtrMultiSet< T, C, A > &other)
Related Functions
(Note that these are not member functions.)
template<class T , class C , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrMultiSet< T, C, A > &coll)
template<class T , class C , class A >
RWFile &	operator<< (RWFile &strm, const RWTPtrMultiSet< T, C, A > &coll)
template<class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrMultiSet< T, C, A > &coll)
template<class T , class C , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrMultiSet< T, C, A > &coll)
template<class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrMultiSet< T, C, A > *&p)
template<class T , class C , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrMultiSet< T, C, A > *&p)

---

Detailed Description

template<class T, class C, 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<T,C,A> may contain multiple items that compare equal to each other. (RWTPtrSet<T,C,A> 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>
 RWTPtrMultiSet<T,C,A>  s;

Related Classes

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

Class multiset<T*, rw_deref_compare<C,T>,A > is the C++ Standard Library collection that serves as the underlying implementation for RWTPtrMultiSet<T,C,A>.

Persistence

Isomorphic.

Examples

 // tpmset.cpp
 //
 #include <rw/tpmset.h>
 #include <rw/cstring.h>
 #include <iostream.h>
 #include <functional>
 int main(){
   RWTPtrMultiSet<RWCString, std::less<RWCString> > set;
   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"
   set.clearAndDestroy();
   std::cout << set.entries() << std::endl;       // Prints "0"
   return 0;
 }

Program output:

 4
 0

---

Member Typedef Documentation

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

typedef base_type::const_iterator RWTPtrMultiSet< T, C, A >::const_iterator

Typedef for the const iterator.

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

typedef base_type::const_reference RWTPtrMultiSet< T, C, A >::const_reference

Typedef for a const reference to a value in this container.

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

typedef rw_deref_compare<C,T> RWTPtrMultiSet< T, C, A >::container_comp

Typedef for the comparison object.

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

typedef std::multiset<T*, container_comp ,A > RWTPtrMultiSet< T, C, A >::container_type

Typedef for the C++ Standard Library collection that serves as the underlying implementation for this class.

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

typedef container_type::difference_type RWTPtrMultiSet< T, C, A >::difference_type

Typedef for the type of difference between iterators.

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

typedef base_type::iterator RWTPtrMultiSet< T, C, A >::iterator

Typedef for the non-const iterator.

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

typedef base_type::reference RWTPtrMultiSet< T, C, A >::reference

Typedef for a non-const reference to a value in this container.

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

typedef container_type::size_type RWTPtrMultiSet< T, C, A >::size_type

Typedef for the type used to index into this container.

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

typedef base_type::value_type RWTPtrMultiSet< T, C, A >::value_type

Typedef for the type of elements in this container.

---

Constructor & Destructor Documentation

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

RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet

(

const container_comp &

cmp = container_comp()

)

[inline]

Constructs an empty set.

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

RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet

(

const RWTPtrMultiSet< T, C, A > &

rws

)

[inline]

Copy constructor.

template<class T, class C, 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 only available on platforms with rvalue reference support.

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

RWTPtrMultiSet< T, C, A >::RWTPtrMultiSet	(	T *const *	first,
		T *const *	last,
		const container_comp &	cmp = container_comp()
	)			[inline]

Constructs a set by copying elements from the array of T*s pointed to by first, up to, but not including, the element pointed to by last.

---

Member Function Documentation

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

void RWTPtrMultiSet< T, C, A >::apply	(	void(*)(const T *, void *)	fn,
		void *	d
	)			const [inline]

Applies the user-defined function pointed to by fn to every item in the collection. Client data may be passed through parameter d.

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

const_iterator RWTPtrMultiSet< T, C, A >::begin

(

)

const [inline]

Returns an iterator positioned at the first element of self.

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

iterator RWTPtrMultiSet< T, C, A >::begin

(

)

[inline]

Returns an iterator positioned at the first element of self.

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

bool RWTPtrMultiSet< T, C, A >::contains

(

const_value

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, class A = std:: allocator < T* >>

bool RWTPtrMultiSet< T, C, A >::contains	(	bool(*)(const_value, 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, 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, class A = std:: allocator < T* >>

const_iterator RWTPtrMultiSet< T, C, A >::end

(

)

const [inline]

Returns an iterator positioned "just past" the last element in self.

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

iterator RWTPtrMultiSet< T, C, A >::end

(

)

[inline]

Returns an iterator positioned "just past" the last element in self.

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

size_type RWTPtrMultiSet< T, C, A >::entries

(

void

)

const [inline]

Returns the number of items in self.

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

value_type RWTPtrMultiSet< T, C, A >::find

(

const_value

a

)

[inline]

Returns an iterator positioned "just past" the last element in self.

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

const_value RWTPtrMultiSet< T, C, A >::find

(

const_value

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, class A = std:: allocator < T* >>

const_value RWTPtrMultiSet< T, C, A >::find	(	bool(*)(const_value, 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, class A = std:: allocator < T* >>

bool RWTPtrMultiSet< T, C, A >::insert

(

T *

a

)

[inline]

Adds the item a to the collection. Returns true.

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

bool RWTPtrMultiSet< T, C, A >::isEquivalent

(

const RWTPtrMultiSet< T, C, A > &

s

)

const [inline]

Returns true if there is set equivalence between self and s, otherwise returns false.

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

size_type RWTPtrMultiSet< T, C, A >::occurrencesOf

(

const_value

a

)

[inline]

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

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

size_type RWTPtrMultiSet< T, C, A >::occurrencesOf	(	bool(*)(const_value, 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, class A = std:: allocator < T* >>

bool RWTPtrMultiSet< T, C, A >::operator!=

(

const RWTPtrMultiSet< T, C, A > &

s

)

const [inline]

Returns the negation of operator==().

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

bool RWTPtrMultiSet< T, C, A >::operator<

(

const RWTPtrMultiSet< T, C, A > &

s

)

const [inline]

Returns true if self compares lexicographically less than s, otherwise returns 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 = 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 only available on platforms with rvalue reference support.

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

RWTPtrMultiSet<T,C ,A >& RWTPtrMultiSet< T, C, A >::operator=

(

const container_type &

s

)

[inline]

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

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

RWTPtrMultiSet<T,C ,A >& RWTPtrMultiSet< T, C, A >::operator=

(

const RWTPtrMultiSet< T, C, A > &

s

)

[inline]

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

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

bool RWTPtrMultiSet< T, C, A >::operator==

(

const RWTPtrMultiSet< T, C, A > &

s

)

const [inline]

Returns true if self compares equal to s, otherwise returns 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. Elements are dereferenced before being compared.

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

value_type RWTPtrMultiSet< T, C, A >::remove

(

const_value

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, class A = std:: allocator < T* >>

value_type RWTPtrMultiSet< T, C, A >::remove	(	bool(*)(const_value, 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, class A = std:: allocator < T* >>

size_type RWTPtrMultiSet< T, C, A >::removeAll

(

const_value

a

)

[inline]

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

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

size_type RWTPtrMultiSet< T, C, A >::removeAll	(	bool(*)(const_value, void *)	fn,
		void *	d
	)			[inline]

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, 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, 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, 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, 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, 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 >

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 >

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,
		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.

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 > &	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 > &	coll
	)			[related]

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