RWTPtrHashSet< T, H, EQ, A > Class Template Reference

A hash-based container for pointer types. More...

#include <rw/tphset.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 rw_deref_compare< EQ, T >	container_eq
typedef rw_deref_hash< H, T >	container_hash
typedef rw_hashset< T *, hasher, key_equal, A >	container_type
typedef container_type::difference_type	difference_type
typedef rw_deref_hash< H, T >	hasher
typedef container_type::iterator	iterator
typedef rw_deref_compare< EQ, T >	key_equal
typedef container_type::key_type	key_type
typedef container_type::pointer	pointer
typedef container_type::reference	reference
typedef container_type::size_type	size_type
typedef container_type::value_type	value_type

Public Member Functions
	RWTPtrHashSet (const container_type &s)
	RWTPtrHashSet (const H &h, size_type sz=64)
	RWTPtrHashSet (const RWTPtrHashSet< T, H, EQ, A > &rws)
	RWTPtrHashSet (container_type &&rws)
template<typename InputIterator >
	RWTPtrHashSet (InputIterator first, InputIterator last, size_type sz=64, const H &h=H(), const EQ &eq=EQ())
	RWTPtrHashSet (RWTPtrHashSet< T, H, EQ, A > &&rws)
	RWTPtrHashSet (size_type sz=64, const H &h=H(), const EQ &eq=EQ())
void	apply (void(*fn)(const T &, void *), void *d) const
void	apply (void(*fn)(const T *, void *), void *d) const
iterator	begin ()
const_iterator	begin () const
size_type	capacity () 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
RWTPtrHashSet< T, H, EQ, A > &	difference (const RWTPtrHashSet< T, H, EQ, A > &s)
iterator	end ()
const_iterator	end () const
size_type	entries () const
iterator	erase (iterator first, iterator last)
iterator	erase (iterator pos)
float	fillRatio () const
const T *	find (bool(*fn)(const T *, void *), void *d) const
const T *	find (const T *a) const
value_type	find (const T *key)
template<typename InputIterator >
void	insert (InputIterator first, InputIterator last)
iterator	insert (iterator hint, value_type val)
bool	insert (value_type a)
RWTPtrHashSet< T, H, EQ, A > &	intersection (const RWTPtrHashSet< T, H, EQ, A > &s)
bool	isEmpty () const
bool	isEquivalent (const RWTPtrHashSet< T, H, EQ, A > &s) const
bool	isProperSubsetOf (const RWTPtrHashSet< T, H, EQ, A > &s) const
bool	isSubsetOf (const RWTPtrHashSet< T, H, EQ, A > &s) const
size_type	occurrencesOf (bool(*fn)(const T *, void *), void *d) const
size_type	occurrencesOf (const T *a) const
RWTPtrHashSet< T, H, EQ, A > &	operator= (const container_type &rhs)
RWTPtrHashSet< T, H, EQ, A > &	operator= (const RWTPtrHashSet< T, H, EQ, A > &rhs)
RWTPtrHashSet< T, H, EQ, A > &	operator= (container_type &&rhs)
RWTPtrHashSet< T, H, EQ, A > &	operator= (RWTPtrHashSet< T, H, EQ, A > &&rhs)
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	resize (size_type sz)
container_type &	std ()
const container_type &	std () const
void	swap (RWTPtrHashSet< T, H, EQ, A > &other)
RWTPtrHashSet< T, H, EQ, A > &	symmetricDifference (const RWTPtrHashSet< T, H, EQ, A > &s)
RWTPtrHashSet< T, H, EQ, A > &	Union (const RWTPtrHashSet< T, H, EQ, A > &s)

Related Symbols
(Note that these are not member symbols.)
template<class T , class H , class EQ , class A >
bool	operator!= (const RWTPtrHashSet< T, H, EQ, A > &lhs, const RWTPtrHashSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
bool	operator!= (const RWTPtrHashSet< T, H, EQ, A > &lhs, const typename RWTPtrHashSet< T, H, EQ, A >::container_type &rhs)
template<class T , class H , class EQ , class A >
bool	operator!= (const typename RWTPtrHashSet< T, H, EQ, A >::container_type &lhs, const RWTPtrHashSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &strm, const RWTPtrHashSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrHashSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
bool	operator== (const RWTPtrHashSet< T, H, EQ, A > &lhs, const RWTPtrHashSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
bool	operator== (const RWTPtrHashSet< T, H, EQ, A > &lhs, const typename RWTPtrHashSet< T, H, EQ, A >::container_type &rhs)
template<class T , class H , class EQ , class A >
bool	operator== (const typename RWTPtrHashSet< T, H, EQ, A >::container_type &lhs, const RWTPtrHashSet< T, H, EQ, A > &rhs)
template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrHashSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrHashSet< T, H, EQ, A > *&p)
template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrHashSet< T, H, EQ, A > &coll)
template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrHashSet< T, H, EQ, A > *&p)

Detailed Description

template<class T, class H = RWTHash<T>, class EQ = std::equal_to<T>, class A = std::allocator<T*>>
class RWTPtrHashSet< 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 function that takes a single argument convertible to type T and returns a value of type size_t.

Note

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

Element equality is determined by an equality function of type EQ, which takes two arguments convertible to type T and returns a value of type bool.

Note

Any two elements that are equivalent are disallowed for this container.

RWTPtrHashSet will not accept an item that is equivalent to an item already in the collection. (RWTPtrHashMultiSet may contain multiple items that are equivalent to each other.) Equality is based on the equality object and not on the equality operator.

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

Synopsis

#include <rw/tphset.h>
RWTPtrHashSet<T, H, EQ, A> s;

See also

Class RWTPtrHashMultiSet offers the same interface to a pointer-based collection that accepts multiple items that compare equal to each other.

Class rw_hashset<T*,hasher,key_equal,A> is the C++ Standard Library collection that serves as the underlying implementation for RWTPtrHashSet.

Persistence

Isomorphic

Example

#include <functional>
#include <iostream>
 
#include <rw/cstring.h>
#include <rw/tphset.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);
  }
};
 
void printit(const RWCString* s, void*) { std::cout << *s << " "; }
 
int main() {
  RWTPtrHashSet<RWCString, simple_hash, std::equal_to<RWCString> > myset;
  RWCString s;
 
  myset.insert(new RWCString("one"));
  myset.insert(new RWCString("two"));
  myset.insert(new RWCString("three"));
 
  RWCString* entry = new RWCString("one");
  if (!myset.insert(entry))  // Rejected: duplicate entry
  {
    delete entry;
  }
 
  std::cout << "There are " << myset.entries()
            << " items in the hash set and they are: \n";  // Prints "3"
 
  myset.apply(printit, NULL);
 
  std::cout << std::endl;
 
  myset.clearAndDestroy();
 
  return 0;
}

Program output:

There are 3 items in the hash set and they are:
one two three

Member Typedef Documentation

allocator_type

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

typedef container_type::allocator_type RWTPtrHashSet< T, H, EQ, A >::allocator_type

A type representing the allocator type for the container.

const_iterator

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

typedef container_type::const_iterator RWTPtrHashSet< T, H, EQ, A >::const_iterator

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

const_pointer

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

typedef container_type::const_pointer RWTPtrHashSet< T, H, EQ, A >::const_pointer

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

const_reference

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

typedef container_type::const_reference RWTPtrHashSet< T, H, EQ, A >::const_reference

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

container_eq

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

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

Deprecated

As of SourcePro 12.5, use key_equal instead.

A type representing an equality function that dereferences the arguments before comparing.

container_hash

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

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

Deprecated

As of SourcePro 12.5, use hasher instead.

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

container_type

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

typedef rw_hashset<T*, hasher, key_equal, A> RWTPtrHashSet< T, H, EQ, A >::container_type

A type representing the underlying implementation container.

difference_type

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

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

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

hasher

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

typedef rw_deref_hash<H, T> RWTPtrHashSet< T, H, EQ, A >::hasher

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

iterator

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

typedef container_type::iterator RWTPtrHashSet< T, H, EQ, A >::iterator

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

key_equal

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

typedef rw_deref_compare<EQ, T> RWTPtrHashSet< T, H, EQ, A >::key_equal

A type representing an equality function that dereferences the arguments before comparing.

key_type

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

typedef container_type::key_type RWTPtrHashSet< T, H, EQ, A >::key_type

A type representing the key of the container.

pointer

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

typedef container_type::pointer RWTPtrHashSet< T, H, EQ, A >::pointer

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

reference

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

typedef container_type::reference RWTPtrHashSet< T, H, EQ, A >::reference

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

size_type

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

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

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

value_type

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

typedef container_type::value_type RWTPtrHashSet< T, H, EQ, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

RWTPtrHashSet() [1/7]

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

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( size_type sz = 64, const H & h = H(), const EQ & eq = EQ() )

inline

Constructs an empty hashed set. The underlying hash table representation has sz buckets, uses h for its hashing function, and uses eq to determine equality between elements.

Note

If the value specified for sz is zero, the default bucket count is used.

RWTPtrHashSet() [2/7]

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

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( const RWTPtrHashSet< T, H, EQ, A > & rws )

inline

Copy constructor.

RWTPtrHashSet() [3/7]

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

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( RWTPtrHashSet< T, H, EQ, 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.

RWTPtrHashSet() [4/7]

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

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( 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.

RWTPtrHashSet() [5/7]

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

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( const container_type & s )

inline

Constructs a pointer-based hash set by copying all elements from s.

RWTPtrHashSet() [6/7]

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

template<typename InputIterator >

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( InputIterator first, InputIterator last, size_type sz = 64, const H & h = H(), const EQ & eq = EQ() )

inline

Constructs a set by copying elements from the range [first, last). The underlying hash table representation has sz buckets, uses h for its hashing function, and uses eq to determine equality between elements.

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

Note

If the value specified for sz is zero, the default bucket count is used.

RWTPtrHashSet() [7/7]

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

RWTPtrHashSet< T, H, EQ, A >::RWTPtrHashSet ( const H & h, size_type sz = 64 )

inline

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

Note

If the value specified for sz is zero, the default capacity is used.

Member Function Documentation

apply() [1/2]

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

void RWTPtrHashSet< T, H, EQ, A >::apply ( void(* fn )(const T &, void *), void * d ) const

inline

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

apply() [2/2]

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

void RWTPtrHashSet< T, H, EQ, A >::apply ( void(* fn )(const T *, void *), void * d ) const

inline

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

begin() [1/2]

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

iterator RWTPtrHashSet< T, H, EQ, A >::begin ( )

inline

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

If the container is empty, returns end().

begin() [2/2]

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

const_iterator RWTPtrHashSet< T, H, EQ, A >::begin ( ) const

inline

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

If the container is empty, returns end().

capacity()

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

size_type RWTPtrHashSet< T, H, EQ, A >::capacity ( ) const

inline

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

cbegin()

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

const_iterator RWTPtrHashSet< T, H, EQ, A >::cbegin ( ) const

inline

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

If the container is empty, returns end().

cend()

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

const_iterator RWTPtrHashSet< T, H, EQ, 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.

clear()

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

void RWTPtrHashSet< T, H, EQ, A >::clear ( )

inline

Clears the collection by removing all items from self.

clearAndDestroy()

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

void RWTPtrHashSet< T, H, EQ, A >::clearAndDestroy ( )

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. (If the equality operator is reflexive, the container cannot hold such multiple pointers.)

contains() [1/2]

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

bool RWTPtrHashSet< T, H, EQ, A >::contains ( bool(* fn )(const T *, void *), 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.

contains() [2/2]

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

bool RWTPtrHashSet< T, H, EQ, A >::contains ( const T * a ) const

inline

Returns true if there exists an element t in self such that the expression (*t == *a) is true, otherwise returns false.

difference()

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::difference ( const RWTPtrHashSet< 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.

end() [1/2]

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

iterator RWTPtrHashSet< T, H, EQ, 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.

end() [2/2]

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

const_iterator RWTPtrHashSet< T, H, EQ, 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.

entries()

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

size_type RWTPtrHashSet< T, H, EQ, A >::entries ( ) const

inline

Returns the number of elements in self.

erase() [1/2]

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

iterator RWTPtrHashSet< T, H, EQ, 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.

erase() [2/2]

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

iterator RWTPtrHashSet< T, H, EQ, 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.

fillRatio()

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

float RWTPtrHashSet< T, H, EQ, A >::fillRatio ( ) const

inline

Returns the ratio entries() / capacity().

find() [1/3]

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

const T * RWTPtrHashSet< T, H, EQ, A >::find ( bool(* fn )(const T *, void *), 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.

find() [2/3]

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

const T * RWTPtrHashSet< T, H, EQ, A >::find ( const T * a ) const

inline

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

find() [3/3]

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

value_type RWTPtrHashSet< T, H, EQ, A >::find ( const T * key )

inline

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

insert() [1/3]

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

template<typename InputIterator >

void RWTPtrHashSet< T, H, EQ, A >::insert ( InputIterator first, InputIterator last )

inline

Inserts the elements in the range [first, last) into self. If the element is already present in the collection, it will be ignored.

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

insert() [2/3]

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

iterator RWTPtrHashSet< T, H, EQ, A >::insert ( iterator hint, value_type val )

inline

Attempts to insert val into self. If an existing item with an equivalent key is already in the collection, val is not inserted, and an iterator to the existing item is returned. Otherwise inserts val and 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 hash object.

insert() [3/3]

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

bool RWTPtrHashSet< T, H, EQ, A >::insert ( value_type a )

inline

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

intersection()

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::intersection ( const RWTPtrHashSet< T, H, EQ, A > & s )

inline

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

isEmpty()

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

bool RWTPtrHashSet< T, H, EQ, A >::isEmpty ( ) const

inline

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

isEquivalent()

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

bool RWTPtrHashSet< T, H, EQ, A >::isEquivalent ( const RWTPtrHashSet< T, H, EQ, A > & s ) const

inline

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

isProperSubsetOf()

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

bool RWTPtrHashSet< T, H, EQ, A >::isProperSubsetOf ( const RWTPtrHashSet< T, H, EQ, A > & s ) const

inline

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

isSubsetOf()

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

bool RWTPtrHashSet< T, H, EQ, A >::isSubsetOf ( const RWTPtrHashSet< 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 false.

occurrencesOf() [1/2]

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

size_type RWTPtrHashSet< T, H, EQ, A >::occurrencesOf ( bool(* fn )(const T *, void *), 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.

occurrencesOf() [2/2]

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

size_type RWTPtrHashSet< T, H, EQ, A >::occurrencesOf ( const T * a ) const

inline

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

operator=() [1/4]

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::operator= ( const container_type & rhs )

inline

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

operator=() [2/4]

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::operator= ( const RWTPtrHashSet< T, H, EQ, A > & rhs )

inline

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

operator=() [3/4]

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, 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.

operator=() [4/4]

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::operator= ( RWTPtrHashSet< T, H, EQ, 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.

remove() [1/2]

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

value_type RWTPtrHashSet< T, H, EQ, A >::remove ( bool(* fn )(const T *, void *), 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.

remove() [2/2]

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

value_type RWTPtrHashSet< 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.

removeAll() [1/2]

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

size_type RWTPtrHashSet< T, H, EQ, A >::removeAll	(	bool(*	fn )(const T *, void *),
		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.

removeAll() [2/2]

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

size_type RWTPtrHashSet< T, H, EQ, A >::removeAll ( const T * a )

inline

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

resize()

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

void RWTPtrHashSet< T, H, EQ, A >::resize ( size_type sz )

inline

Changes the capacity of self by creating a new hashed set with a capacity of sz. This function 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.

std() [1/2]

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

container_type & RWTPtrHashSet< T, H, EQ, A >::std ( )

inline

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

std() [2/2]

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

const container_type & RWTPtrHashSet< T, H, EQ, A >::std ( ) const

inline

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

swap()

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

void RWTPtrHashSet< T, H, EQ, A >::swap ( RWTPtrHashSet< 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.

symmetricDifference()

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::symmetricDifference ( const RWTPtrHashSet< T, H, EQ, A > & s )

inline

Destructively performs a set theoretic symmetric difference operation on self and s. Self is replaced by the result. A symmetric difference can be defined as \( (A \cup B) / (A \cap B) \).

Union()

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

RWTPtrHashSet< T, H, EQ, A > & RWTPtrHashSet< T, H, EQ, A >::Union ( const RWTPtrHashSet< T, H, EQ, A > & s )

inline

Destructively performs a set theoretic union operation on self and s. Self is replaced by the result.

Note

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

Friends And Related Symbol Documentation

operator!=() [1/3]

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

bool operator!= ( const RWTPtrHashSet< T, H, EQ, A > & lhs, const RWTPtrHashSet< T, H, EQ, A > & rhs )

related

Equivalent to !(lhs == rhs).

operator!=() [2/3]

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

bool operator!= ( const RWTPtrHashSet< T, H, EQ, A > & lhs, const typename RWTPtrHashSet< T, H, EQ, A >::container_type & rhs )

related

Equivalent to !(lhs == rhs).

operator!=() [3/3]

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

bool operator!= ( const typename RWTPtrHashSet< T, H, EQ, A >::container_type & lhs, const RWTPtrHashSet< T, H, EQ, A > & rhs )

related

Equivalent to !(lhs == rhs).

operator<<() [1/2]

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

RWFile & operator<< ( RWFile & strm, const RWTPtrHashSet< T, H, EQ, A > & coll )

related

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

operator<<() [2/2]

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

RWvostream & operator<< ( RWvostream & strm, const RWTPtrHashSet< 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.

operator==() [1/3]

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

bool operator== ( const RWTPtrHashSet< T, H, EQ, A > & lhs, const RWTPtrHashSet< T, H, EQ, 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 each is a subset of the other. Elements are dereferenced before being compared.

operator==() [2/3]

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

bool operator== ( const RWTPtrHashSet< T, H, EQ, A > & lhs, const typename RWTPtrHashSet< T, H, EQ, 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 each is a subset of the other. Elements are dereferenced before being compared.

operator==() [3/3]

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

bool operator== ( const typename RWTPtrHashSet< T, H, EQ, A >::container_type & lhs, const RWTPtrHashSet< T, H, EQ, 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 each is a subset of the other. Elements are dereferenced before being compared.

operator>>() [1/4]

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

RWFile & operator>> ( RWFile & strm, RWTPtrHashSet< T, H, EQ, A > & coll )

related

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

operator>>() [2/4]

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

RWFile & operator>> ( RWFile & strm, RWTPtrHashSet< T, H, EQ, 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.

operator>>() [3/4]

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

RWvistream & operator>> ( RWvistream & strm, RWTPtrHashSet< T, H, EQ, A > & coll )

related

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

operator>>() [4/4]

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

RWvistream & operator>> ( RWvistream & strm, RWTPtrHashSet< T, H, EQ, 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.