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

A pointer-based collection of values ordered according to a comparison object. More...

#include <rw/tpset.h>

Inherits RW_PAssoc< std::set< T *, rw_deref_compare< C, T >,A >, RWTPtrSet< T, C,A >, T >.

List of all members.

Public Types
typedef rw_deref_compare< C, T >	container_comp
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 RWTPtrSet< T, C, A > &s) const
bool	operator!= (const RWTPtrSet< T, C, A > &s) const
bool	operator< (const RWTPtrSet< 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
value_type	find (const_value a)
const_value	find (const_value a) const
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)
bool	isSubsetOf (const RWTPtrSet< T, C, A > &s) const
bool	isProperSubsetOf (const RWTPtrSet< T, C, A > &s) const
bool	isEquivalent (const RWTPtrSet< T, C, A > &s) const
void	Union (const RWTPtrSet< T, C, A > &s)
void	intersection (const RWTPtrSet< T, C, A > &s)
void	difference (const RWTPtrSet< T, C, A > &s)
void	symmetricDifference (const RWTPtrSet< T, C, A > &s)
void	apply (void(*fn)(const_value, void *), void *d) const
bool	insert (value_type a)
RWTPtrSet< T, C,A > &	operator= (const RWTPtrSet< T, C, A > &s)
RWTPtrSet< T, C,A > &	operator= (const container_type &s)
RWTPtrSet< T, C,A > &	operator= (RWTPtrSet< T, C, A > &&rhs)
	RWTPtrSet (const container_comp &cmp=container_comp())
	RWTPtrSet (const container_type &s)
	RWTPtrSet (const RWTPtrSet< T, C, A > &rws)
	RWTPtrSet (RWTPtrSet< T, C, A > &&rws)
	RWTPtrSet (T *const *first, T *const *last, const container_comp &cmp=container_comp())
void	swap (RWTPtrSet< 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 RWTPtrSet< T, C, A > &coll)
template<class T , class C , class A >
RWFile &	operator<< (RWFile &strm, const RWTPtrSet< T, C, A > &coll)
template<class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrSet< T, C, A > &coll)
template<class T , class C , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrSet< T, C, A > &coll)
template<class T , class C , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrSet< T, C, A > *&p)
template<class T , class C , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrSet< T, C, A > *&p)

---

Detailed Description

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

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

RWTPtrSet<T,C,A> will not accept an item that compares equal to an item already in the collection. (RWTPtrMultiSet<T,C,A> may contain multiple items that compare equal to each other.) Equality is based on the comparison object and not on the == operator. Given a comparison object comp, items a and b are equal if !comp(a,b) && !comp(b,a).

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

Synopsis

 #include <rw/tpset.h>
 RWTPtrSet<T,C,A> s;

Related Classes

Class RWTPtrMultiSet<T,C,A> offers the same interface to a pointer-based collection that accepts multiple items that compare equal to each other. RWTPtrMap<K,T,C,A> is a pointer-based collection of key-value pairs.

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

Persistence

Isomorphic

Examples

 #include <iostream>
 #include <functional>

 #include <rw/tpset.h>
 #include <rw/cstring.h>

 int main()
 {
   RWTPtrSet<RWCString, std::less<RWCString> > set;

   set.insert(new RWCString("one"));
   set.insert(new RWCString("two"));
   set.insert(new RWCString("three"));

   RWCString* entry = new RWCString("one");
   if (!set.insert(entry))  // Rejected: duplicate entry
   {
     delete entry;
   }

   std::cout << set.entries() << std::endl;   // Prints "3"
   set.clearAndDestroy();
   std::cout << set.entries() << std::endl;   // Prints "0"

   return 0;
 }

Program output:

 3
 0

---

Member Typedef Documentation

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

typedef base_type::const_iterator RWTPtrSet< 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 RWTPtrSet< 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> RWTPtrSet< T, C, A >::container_comp

Typedef for the comparison object.

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

typedef container_type::difference_type RWTPtrSet< 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 RWTPtrSet< T, C, A >::iterator

Typedef for the non-const iterator.

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

typedef base_type::reference RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< 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* >>

RWTPtrSet< T, C, A >::RWTPtrSet

(

const container_comp &

cmp = container_comp()

)

[inline]

Constructs an empty set.

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

RWTPtrSet< T, C, A >::RWTPtrSet

(

const container_type &

s

)

[inline]

Creates a pointer based set by copying all elements from s.

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

RWTPtrSet< T, C, A >::RWTPtrSet

(

const RWTPtrSet< T, C, A > &

rws

)

[inline]

Copy constructor.

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

RWTPtrSet< T, C, A >::RWTPtrSet

(

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

RWTPtrSet< T, C, A >::RWTPtrSet	(	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 RWTPtrSet< T, C, A >::apply	(	void(*)(const_value, 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 RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< T, C, A >::contains

(

const_value

a

)

const [inline]

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

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

bool RWTPtrSet< 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 RWTPtrSet< T, C, A >::difference

(

const RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< T, C, A >::entries

(

void

)

const [inline]

Returns the number of items in self.

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

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

(

const_value

a

)

const [inline]

If there exists an element t in self that compares equal with *a, returns t. Otherwise, returns rwnil.

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

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

(

const_value

a

)

[inline]

If there exists an element t in self that compares equal with *a, returns t. Otherwise, returns rwnil.

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

const_value RWTPtrSet< 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 RWTPtrSet< T, C, A >::insert

(

value_type

a

)

[inline]

Adds the item a to the collection. Returns true if the insertion is successful, otherwise returns false. The function will return true unless the collection already holds an element with an equivalent key.

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

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

(

const RWTPtrSet< 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 RWTPtrSet< 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 RWTPtrSet< T, C, A >::isEquivalent

(

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

(

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

(

const RWTPtrSet< 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 RWTPtrSet< T, C, A >::occurrencesOf

(

const_value

a

)

[inline]

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

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

size_type RWTPtrSet< 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 RWTPtrSet< T, C, A >::operator!=

(

const RWTPtrSet< T, C, A > &

s

)

const [inline]

Returns the negation of operator==().

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

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

(

const RWTPtrSet< 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* >>

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

(

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

RWTPtrSet<T,C ,A >& RWTPtrSet< 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* >>

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

(

const RWTPtrSet< 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 RWTPtrSet< T, C, A >::operator==

(

const RWTPtrSet< 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 RWTPtrSet< T, C, A >::remove

(

const_value

a

)

[inline]

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

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

value_type RWTPtrSet< 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 RWTPtrSet< T, C, A >::removeAll

(

const_value

a

)

[inline]

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

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

size_type RWTPtrSet< 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& RWTPtrSet< 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& RWTPtrSet< 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 RWTPtrSet< T, C, A >::swap

(

RWTPtrSet< 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 RWTPtrSet< T, C, A >::symmetricDifference

(

const RWTPtrSet< 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 RWTPtrSet< T, C, A >::Union

(

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

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