RWTPtrHashMultiSet< T, H, EQ, A > Class Template Reference
[STL Extension-based Collections]

A pointer-based collection of values stored according to a hash object, which allows duplicate values. More...

#include <rw/tphasht.h>

Inherits RW_PHAssoc< rw_hashmultiset< T *, rw_deref_hash< H, T >, rw_deref_compare< EQ, T >,A >, RWTPtrHashMultiSet< T, H, EQ,A >, T >.

List of all members.

Public Types
typedef rw_deref_compare< EQ, T >	container_eq
typedef rw_deref_hash< H, T >	container_hash
typedef rw_hashmultiset< T *, container_hash, container_eq,A >	container_type
typedef container_type::size_type	size_type
typedef container_type::difference_type	difference_type
typedef base1_type::iterator	iterator
typedef base1_type::const_iterator	const_iterator
typedef base1_type::value_type	value_type
typedef base1_type::reference	reference
typedef base1_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
void	clear ()
void	clearAndDestroy ()
bool	contains (bool(*fn)(const T *, void *), void *d) const
bool	contains (const T *a) const
const T *	find (bool(*fn)(const T *, void *), void *d) const
value_type	find (const T *a)
const T *	find (const T *a) const
size_type	occurrencesOf (bool(*fn)(const_value, void *), void *d) const
size_type	occurrencesOf (const_value a)
value_type	remove (bool(*fn)(const T *, void *), void *d)
value_type	remove (const T *a)
size_type	removeAll (bool(*fn)(const T *, void *), void *d)
size_type	removeAll (const T *a)
void	apply (void(*fn)(const T *, void *), void *d) const
bool	isSubsetOf (const RWTPtrHashMultiSet< T, H, EQ, A > &s) const
bool	isProperSubsetOf (const RWTPtrHashMultiSet< T, H, EQ, A > &s) const
bool	isEquivalent (const RWTPtrHashMultiSet< T, H, EQ, A > &s) const
void	Union (const RWTPtrHashMultiSet< T, H, EQ, A > &rhs)
void	intersection (const RWTPtrHashMultiSet< T, H, EQ, A > &s)
void	difference (const RWTPtrHashMultiSet< T, H, EQ, A > &s)
void	symmetricDifference (const RWTPtrHashMultiSet< T, H, EQ, A > &rhs)
bool	operator== (const RWTPtrHashMultiSet< T, H, EQ, A > &s) const
bool	operator!= (const RWTPtrHashMultiSet< T, H, EQ, A > &s) const
bool	insert (T *a)
size_type	capacity () const
float	fillRatio () const
void	resize (size_type sz)
void	swap (RWTPtrHashMultiSet< T, H, EQ, A > &other)
RWTPtrHashMultiSet< T, H, EQ,A > &	operator= (const RWTPtrHashMultiSet< T, H, EQ, A > &s)
RWTPtrHashMultiSet< T, H, EQ,A > &	operator= (RWTPtrHashMultiSet< T, H, EQ, A > &&rhs)
	RWTPtrHashMultiSet (size_type sz=1024, const H &h=H(), const EQ &eq=EQ())
	RWTPtrHashMultiSet (const RWTPtrHashMultiSet< T, H, EQ, A > &rws)
	RWTPtrHashMultiSet (RWTPtrHashMultiSet< T, H, EQ, A > &&rws)
	RWTPtrHashMultiSet (const container_type &s)
	RWTPtrHashMultiSet (T *const *first, T *const *last, size_type sz=1024, const H &h=H(), const EQ &eq=EQ())
	RWTPtrHashMultiSet (const H &h, size_type sz=64)
Related Functions
(Note that these are not member functions.)
template<class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &file, const RWTPtrHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTPtrHashMultiSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrHashMultiSet< T, H, EQ, A > *&p)
template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &file, RWTPtrHashMultiSet< T, H, EQ, A > *&p)

---

Detailed Description

template<class T, class H, class EQ, class A = std:: allocator < T* >>
class RWTPtrHashMultiSet< T, H, EQ, A >

This class maintains a pointer-based collection of values, which are stored according to a hash object of type H. 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.

H must provide a const hash function on elements of type T via public member

 unsigned long operator()(const T& x) const;

Elements within the collection are grouped together based on an equality object of type EQ. EQ must ensure this grouping via public member

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

which should return true if x and y are equivalent, otherwise false.

Note:

Any two keys that are equivalent must hash to the same value.

This class allows multiple items that are equivalent to each other. Use RWTPtrHashSet<T,H,EQ,A> if you need a class that does not allow equivalent values.

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

Synopsis

 #include <rw/tphasht.h>
 RWTPtrHashMultiSet<T,H,EQ,A> hmset;

Related Classes

Class RWTPtrHashSet<T,H,EQ,A> offers the same interface to a pointer-based collection that does not allow multiple items that compare equal to each other.

Class rw_hashmultiset<T*,rw_deref_hash<H,T>,rw_deref_compare<EQ,T>,A> is the C++ Standard Library collection that serves as the underlying implementation for this collection.

Persistence

Isomorphic

Examples

 //
 // tphmset.cpp
 //
 #include <iostream>
 #include <functional>
 #include <rw/tphasht.h>
 #include <rw/cstring.h>
 
 struct simple_hash
 {
     unsigned long
     operator() (const RWCString& ref) const {
         size_t n = ref.length ();
         return (unsigned long)(n ? n * size_t (ref [0]) : 0);
     }
 };
 
 int main ()
 {
     RWTPtrHashMultiSet<RWCString,simple_hash,std::equal_to<RWCString> > set1;
     RWTPtrHashMultiSet<RWCString,simple_hash,std::equal_to<RWCString> > set2;
 
     set1.insert(new RWCString("one"));
     set1.insert(new RWCString("two"));
     set1.insert(new RWCString("three"));
     set1.insert(new RWCString("one"));    // OK: duplicates allowd
 
     std::cout << set1.entries() << "\n";  // Prints "4"
 
     set2 = set1;
     std::cout << ((set1.isEquivalent(set2)) ? "true" : "false") << "\n";
     // Prints "true"
 
     set2.difference(set1);
 
     set1.clearAndDestroy();
     std::cout << set1.entries() << "\n"; // Prints "0"
     std::cout << set2.entries() << "\n"; // Prints "0"
 
     return 0;
 }

Program output:

 4
 true
 0
 0

---

Member Typedef Documentation

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

typedef base1_type::const_iterator RWTPtrHashMultiSet< T, H, EQ, A >::const_iterator

Typedef for the const iterator.

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

typedef base1_type::const_reference RWTPtrHashMultiSet< T, H, EQ, A >::const_reference

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

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

typedef rw_deref_compare<EQ,T> RWTPtrHashMultiSet< T, H, EQ, A >::container_eq

Typedef for the equality object.

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

typedef rw_deref_hash<H,T> RWTPtrHashMultiSet< T, H, EQ, A >::container_hash

Typedef for the hashing object.

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

typedef rw_hashmultiset<T*,container_hash,container_eq ,A > RWTPtrHashMultiSet< T, H, EQ, A >::container_type

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

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

typedef container_type::difference_type RWTPtrHashMultiSet< T, H, EQ, A >::difference_type

Typedef for the type of difference between iterators.

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

typedef base1_type::iterator RWTPtrHashMultiSet< T, H, EQ, A >::iterator

Typedef for the non-const iterator.

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

typedef base1_type::reference RWTPtrHashMultiSet< T, H, EQ, A >::reference

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

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

typedef container_type::size_type RWTPtrHashMultiSet< T, H, EQ, A >::size_type

Typedef for the type used to index into this container.

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

typedef base1_type::value_type RWTPtrHashMultiSet< T, H, EQ, A >::value_type

Typedef for the type of elements in this container.

---

Constructor & Destructor Documentation

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

RWTPtrHashMultiSet< T, H, EQ, A >::RWTPtrHashMultiSet	(	size_type	sz = 1024,
		const H &	h = H(),
		const EQ &	eq = EQ()
	)			[inline]

Constructs an empty multi-set. The hash table representation used by this multi-set will have sz buckets, use h as a hashing function, and eq to test for equality between stored elements.

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

RWTPtrHashMultiSet< T, H, EQ, A >::RWTPtrHashMultiSet

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

rws

)

[inline]

Copy constructor.

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

RWTPtrHashMultiSet< T, H, EQ, A >::RWTPtrHashMultiSet

(

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

RWTPtrHashMultiSet< T, H, EQ, A >::RWTPtrHashMultiSet

(

const container_type &

s

)

[inline]

Constructs a hashed multi-set, copying all element from s.

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

RWTPtrHashMultiSet< T, H, EQ, A >::RWTPtrHashMultiSet	(	T *const *	first,
		T *const *	last,
		size_type	sz = 1024,
		const H &	h = H(),
		const EQ &	eq = EQ()
	)			[inline]

Constructs a set by copying elements from the array of T* pointed to by first, up to, but not including, the element pointed to by last. The hash table representation used by this multi-set has sz buckets, uses h as a hashing function, and eq to test for equality between stored elements.

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

RWTPtrHashMultiSet< T, H, EQ, A >::RWTPtrHashMultiSet	(	const H &	h,
		size_type	sz = 64
	)			[inline]

Creates an empty hashed multi-set that uses the hash object h and has an initial hash table capacity of sz.

---

Member Function Documentation

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

void RWTPtrHashMultiSet< T, H, EQ, A >::apply	(	void(*)(const T *, void *)	fn,
		void *	d
	)			const [inline]

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

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

const_iterator RWTPtrHashMultiSet< T, H, EQ, A >::begin

(

)

const [inline]

Returns an iterator positioned at the first element of self.

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

iterator RWTPtrHashMultiSet< T, H, EQ, A >::begin

(

)

[inline]

Returns an iterator positioned at the first element of self.

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

size_type RWTPtrHashMultiSet< T, H, EQ, A >::capacity

(

)

const [inline]

Returns the number of buckets (slots) available in the underlying hash representation.

See also:

resize()

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

void RWTPtrHashMultiSet< T, H, EQ, A >::clear

(

void

)

[inline]

Clears the collection by removing all items from self.

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

void RWTPtrHashMultiSet< T, H, EQ, A >::clearAndDestroy

(

void

)

[inline]

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

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

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

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

void RWTPtrHashMultiSet< T, H, EQ, A >::difference

(

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

const_iterator RWTPtrHashMultiSet< T, H, EQ, A >::end

(

)

const [inline]

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

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

iterator RWTPtrHashMultiSet< T, H, EQ, A >::end

(

)

[inline]

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

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

size_type RWTPtrHashMultiSet< T, H, EQ, A >::entries

(

void

)

const [inline]

Returns the number of items in self.

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

float RWTPtrHashMultiSet< T, H, EQ, A >::fillRatio

(

)

const [inline]

Returns the ratio entries() / capacity().

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

const T* RWTPtrHashMultiSet< T, H, EQ, A >::find

(

const T *

a

)

const [inline]

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

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

value_type RWTPtrHashMultiSet< T, H, EQ, A >::find

(

const T *

a

)

[inline]

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

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

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::insert

(

T *

a

)

[inline]

Adds the item a to the collection. Returns true.

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

void RWTPtrHashMultiSet< T, H, EQ, A >::intersection

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

s

)

[inline]

Destructively performs a set-theoretic intersection of self and s, replacing the contents of self with the result.

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::isEmpty

(

)

const [inline]

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

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::isEquivalent

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

s

)

const [inline]

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

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::isProperSubsetOf

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

s

)

const [inline]

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

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::isSubsetOf

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

s

)

const [inline]

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

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

size_type RWTPtrHashMultiSet< T, H, EQ, A >::occurrencesOf

(

const_value

a

)

[inline]

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

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

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::operator!=

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

s

)

const [inline]

Returns the negation of operator==().

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

RWTPtrHashMultiSet<T,H,EQ ,A >& RWTPtrHashMultiSet< T, H, EQ, A >::operator=

(

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

RWTPtrHashMultiSet<T,H,EQ ,A >& RWTPtrHashMultiSet< T, H, EQ, A >::operator=

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

s

)

[inline]

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

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

bool RWTPtrHashMultiSet< T, H, EQ, A >::operator==

(

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

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

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

size_type RWTPtrHashMultiSet< T, H, EQ, A >::removeAll

(

const T *

a

)

[inline]

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

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

size_type RWTPtrHashMultiSet< T, H, EQ, A >::removeAll	(	bool(*)(const T *, void *)	fn,
		void *	d
	)			[inline]

Removes all elements t in self such that the expression ((*fn)(t,d)) is true. Returns the number of elements removed. Client data may be passed through parameter d.

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

void RWTPtrHashMultiSet< T, H, EQ, A >::resize

(

size_type

sz

)

[inline]

Changes the capacity of self by creating a new hashed multi-set with a capacity of sz. Copies every element of self into the new container and finally swaps the internal representation of the new container with the internal representation of self.

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

const container_type& RWTPtrHashMultiSet< T, H, EQ, 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 H, class EQ, class A = std:: allocator < T* >>

container_type& RWTPtrHashMultiSet< T, H, EQ, A >::std

(

)

[inline]

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

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

void RWTPtrHashMultiSet< T, H, EQ, A >::swap

(

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

void RWTPtrHashMultiSet< T, H, EQ, A >::symmetricDifference

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

rhs

)

[inline]

Destructively performs a set-theoretic symmetric difference operation on self and rhs. Self is replaced by the result. A symmetric difference can be informally defined as .

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

void RWTPtrHashMultiSet< T, H, EQ, A >::Union

(

const RWTPtrHashMultiSet< T, H, EQ, A > &

rhs

)

[inline]

Destructively performs a set-theoretic union operation on self and rhs. Self is replaced by the result. Note the uppercase "U" in Union to avoid conflict with the C++ reserved word.

---

Friends And Related Function Documentation

template<class T , class H , class EQ , class A >

RWFile & operator<<	(	RWFile &	file,
		const RWTPtrHashMultiSet< T, H, EQ, A > &	coll
	)			[related]

Streams the collection coll to the RWFile file, or a reference to it if it has already been saved.

template<class T , class H , class EQ , class A >

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTPtrHashMultiSet< T, H, EQ, 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 H , class EQ , class A >

RWFile & operator>>	(	RWFile &	file,
		RWTPtrHashMultiSet< T, H, EQ, A > *&	p
	)			[related]

Looks at the next element from the streamed RWFile file and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap,the application is responsible for deleting it.

template<class T , class H , class EQ , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTPtrHashMultiSet< T, H, EQ, A > *&	p
	)			[related]

Looks at the next element on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, the application is responsible for deleting it.

template<class T , class H , class EQ , class A >

RWFile & operator>>	(	RWFile &	file,
		RWTPtrHashMultiSet< T, H, EQ, A > &	coll
	)			[related]

Restores the contents of the collection coll by streaming from the RWFile file.

template<class T , class H , class EQ , class A >

RWvistream & operator>>	(	RWvistream &	strm,
		RWTPtrHashMultiSet< T, H, EQ, A > &	coll
	)			[related]

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