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

Maintains a collection of values ordered according to a comparison object. More...

#include <rw/tvmset.h>

Inherits RW_VAssoc< std::multiset< T, C,A >, RWTValMultiSet< T, C,A > >.

List of all members.

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

---

Detailed Description

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

This class maintains a collection of values, which are ordered according to a comparison object of type C. Class T is the type of 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) const

which returns true if x should precede y within the collection. The structure std::less<T> from the C++ Standard header file <functional> is an example.

RWTValMultiSet<T,C,A> may contain multiple items that compare equal to each other. (RWTValSet<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/tvmset.h>
 RWTValMultiSet<T,C,A>

Related Classes

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

Class std::multiset<T,C,A> is the C++ Standard collection that serves as the underlying implementation for RWTValMultiSet<T,C,A>.

Persistence

Isomorphic.

Examples

 #include <rw/tvmset.h>
 #include <rw/cstring.h>
 #include <iostream>
 #include <functional>
 
 int main()
 {
  RWTValMultiSet<RWCString,std::less<RWCString> > set;
 
   set.insert("one");
   set.insert("two");
   set.insert("three");
   set.insert("one");               // OK, duplicates allowed
 
   std::cout << set.entries() << std::endl;   // Prints "4"
   return 0;
 }

Program Output:

 4

---

Member Typedef Documentation

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

typedef container_type::const_iterator RWTValMultiSet< T, C, A >::const_iterator

Typedef for the const iterator.

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

typedef container_type::const_reference RWTValMultiSet< 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 std::multiset<T,C ,A > RWTValMultiSet< T, C, A >::container_type

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

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

typedef container_type::iterator RWTValMultiSet< T, C, A >::iterator

Typedef for the non-const iterator.

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

typedef container_type::reference RWTValMultiSet< 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 RWTValMultiSet< 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 container_type::value_type RWTValMultiSet< 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 >>

RWTValMultiSet< T, C, A >::RWTValMultiSet

(

const C &

cmp = C()

)

[inline]

Constructs an empty set.

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

RWTValMultiSet< T, C, A >::RWTValMultiSet

(

const container_type &

s

)

[inline]

Constructs a set by copying all elements of s.

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

RWTValMultiSet< T, C, A >::RWTValMultiSet

(

const RWTValMultiSet< T, C, A > &

rws

)

[inline]

Copy constructor.

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

RWTValMultiSet< T, C, A >::RWTValMultiSet

(

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

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

Constructs a set by copying elements from the array of Ts 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 RWTValMultiSet< T, C, A >::apply	(	void(*)(const_reference, 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 RWTValMultiSet< 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 RWTValMultiSet< 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 RWTValMultiSet< T, C, A >::clear

(

void

)

[inline]

Clears the collection by removing all items from self. Each item has its destructor called.

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

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

(

const_reference

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 RWTValMultiSet< T, C, A >::contains	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [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.

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

void RWTValMultiSet< T, C, A >::difference

(

const container_type &

s

)

[inline]

Sets self to the set-theoretic difference given by (self - s).

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

void RWTValMultiSet< T, C, A >::difference

(

const RWTValMultiSet< T, C, A > &

s

)

[inline]

Sets self to the set-theoretic difference given by (self - s).

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

const_iterator RWTValMultiSet< 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 RWTValMultiSet< 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 RWTValMultiSet< T, C, A >::entries

(

void

)

const [inline]

Returns the number of items in self.

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

bool RWTValMultiSet< T, C, A >::find	(	const_reference	a,
		value_type &	k
	)			const [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.

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

bool RWTValMultiSet< T, C, A >::find	(	bool(*)(const_reference, void *)	fn,
		void *	d,
		value_type &	k
	)			const [inline]

If there exists an element t in self such that the expression ((*fn)(a, d)) is true, 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.

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

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

(

value_type &&

a

)

[inline]

Adds the item a to the collection. Returns true.

Condition:

This method is only available on platforms with rvalue reference support.

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

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

(

const_reference

a

)

[inline]

Adds the item a to the collection. Returns true.

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

void RWTValMultiSet< T, C, A >::intersection

(

const container_type &

s

)

[inline]

Sets self to the intersection of self and s.

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

void RWTValMultiSet< T, C, A >::intersection

(

const RWTValMultiSet< T, C, A > &

s

)

[inline]

Sets self to the intersection of self and s.

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

bool RWTValMultiSet< 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 RWTValMultiSet< T, C, A >::isEquivalent

(

const RWTValMultiSet< 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 RWTValMultiSet< T, C, A >::isProperSubsetOf

(

const RWTValMultiSet< 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 RWTValMultiSet< T, C, A >::isSubsetOf

(

const RWTValMultiSet< T, C, A > &

s

)

const [inline]

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

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

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

(

const_reference

a

)

const [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 RWTValMultiSet< T, C, A >::occurrencesOf	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			const [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.

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

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

(

const RWTValMultiSet< T, C, A > &

rwc

)

const [inline]

Returns the negation of operator==().

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

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

(

const container_type &

stdc

)

const [inline]

Returns the negation of operator==().

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

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

(

const RWTValMultiSet< T, C, A > &

s

)

const [inline]

Returns true if self compares lexicographically less than s, otherwise returns false. Assumes that type T has well-defined less-than semantics (T::operator<(const T&) or equivalent).

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

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

(

const container_type &

s

)

const [inline]

Returns true if self compares lexicographically less than s, otherwise returns false. Assumes that type T has well-defined less-than semantics (T::operator<(const T&) or equivalent).

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

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

(

container_type &&

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

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

(

const container_type &

s

)

[inline]

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

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

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

(

const RWTValMultiSet< T, C, A > &

s

)

[inline]

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

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

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

(

const RWTValMultiSet< 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.

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

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

(

const container_type &

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.

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

bool RWTValMultiSet< T, C, A >::remove

(

const_reference

a

)

[inline]

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

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

bool RWTValMultiSet< T, C, A >::remove	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			[inline]

Removes the first element t 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.

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

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

(

const_reference

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 RWTValMultiSet< T, C, A >::removeAll	(	bool(*)(const_reference, void *)	fn,
		void *	d
	)			[inline]

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.

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

const container_type& RWTValMultiSet< T, C, A >::std

(

)

const [inline]

Returns a reference to the underlying C++ Standard collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard interface as well as interoperability with other software components that make use of the C++ Standard collections.

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

container_type& RWTValMultiSet< T, C, A >::std

(

)

[inline]

Returns a reference to the underlying C++ Standard collection that serves as the implementation for self. This reference may be used freely, providing access to the C++ Standard interface as well as interoperability with other software components that make use of the C++ Standard collections.

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

void RWTValMultiSet< T, C, A >::swap

(

RWTValMultiSet< T, C, A > &

other

)

[inline]

Swaps the data held by self with the data held by other, including the C object. 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 RWTValMultiSet< T, C, A >::symmetricDifference

(

const container_type &

s

)

[inline]

Sets self to the symmetric difference of self and s.

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

void RWTValMultiSet< T, C, A >::symmetricDifference

(

const RWTValMultiSet< T, C, A > &

s

)

[inline]

Sets self to the symmetric difference of self and s.

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

void RWTValMultiSet< T, C, A >::Union

(

const container_type &

s

)

[inline]

Sets self to the union of self and s.

Note:

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

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

void RWTValMultiSet< T, C, A >::Union

(

const RWTValMultiSet< T, C, A > &

s

)

[inline]

Sets self to the union of self and s.

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 RWTValMultiSet< 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 RWTValMultiSet< 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,
		RWTValMultiSet< 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,
		RWTValMultiSet< 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,
		RWTValMultiSet< 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,
		RWTValMultiSet< T, C, A > &	coll
	)			[related]

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