Maintains a hash-based collection of class T pointer elements, in which there cannot be more than one occurrence of equivalent element instances and the key insertion order is preserved. More...

#include <rw/tools/tpordhset.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_orderedhashset< 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
	RWTPtrOrderedHashSet (const container_type &s)

	RWTPtrOrderedHashSet (const H &h, size_type sz=64)

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

	RWTPtrOrderedHashSet (container_type &&rws)

template<typename InputIterator >
	RWTPtrOrderedHashSet (InputIterator first, InputIterator last, size_type sz=64, const H &h=H(), const EQ &eq=EQ())

	RWTPtrOrderedHashSet (RWTPtrOrderedHashSet< T, H, EQ, A > &&rws)

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

RWTPtrOrderedHashSet< T, H, EQ, A > &	difference (const RWTPtrOrderedHashSet< 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)

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

bool	isEmpty () const

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

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

bool	isSubsetOf (const RWTPtrOrderedHashSet< T, H, EQ, A > &s) const

size_type	occurrencesOf (bool(fn)(const T , void ), void d) const

size_type	occurrencesOf (const T *a) const

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

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

RWTPtrOrderedHashSet< T, H, EQ, A > &	operator= (container_type &&rhs)

RWTPtrOrderedHashSet< T, H, EQ, A > &	operator= (RWTPtrOrderedHashSet< 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 (RWTPtrOrderedHashSet< T, H, EQ, A > &other)

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

RWTPtrOrderedHashSet< T, H, EQ, A > &	Union (const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A > &lhs, const RWTPtrOrderedHashSet< T, H, EQ, A > &rhs)

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

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

template<class T , class H , class EQ , class A >
RWFile &	operator<< (RWFile &strm, const RWTPtrOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
RWvostream &	operator<< (RWvostream &strm, const RWTPtrOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
bool	operator== (const RWTPtrOrderedHashSet< T, H, EQ, A > &lhs, const RWTPtrOrderedHashSet< T, H, EQ, A > &rhs)

template<class T , class H , class EQ , class A >
bool	operator== (const RWTPtrOrderedHashSet< T, H, EQ, A > &lhs, const typename RWTPtrOrderedHashSet< T, H, EQ, A >::container_type &rhs)

template<class T , class H , class EQ , class A >
bool	operator== (const typename RWTPtrOrderedHashSet< T, H, EQ, A >::container_type &lhs, const RWTPtrOrderedHashSet< T, H, EQ, A > &rhs)

template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
RWFile &	operator>> (RWFile &strm, RWTPtrOrderedHashSet< T, H, EQ, A > *&p)

template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrOrderedHashSet< T, H, EQ, A > &coll)

template<class T , class H , class EQ , class A >
RWvistream &	operator>> (RWvistream &strm, RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >

RWTPtrOrderedHashSet maintains a collection of class T pointer elements stored according to a hash object of type H. RWTPtrOrderedHashSet preserves the key insertion order.

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.

RWTPtrOrderedHashSet will not accept an item that is equivalent to an item already in the collection. (RWTPtrOrderedHashMultiSet 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/tools/tpordhset.h>

RWTPtrOrderedHashSet<T, H, EQ, A> s;

RWTPtrOrderedHashSet
Maintains a hash-based collection of class T pointer elements, in which there cannot be more than one...
Definition tpordhset.h:79

See also

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

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

Persistence: Isomorphic

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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::const_reference

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

◆ container_type

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

typedef rw_orderedhashset<T*, hasher, key_equal, A> RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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> RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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> RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::value_type

A type representing the container's data type.

Constructor & Destructor Documentation

◆ RWTPtrOrderedHashSet() [1/7]

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

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

inline

Constructs an empty 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.

◆ RWTPtrOrderedHashSet() [2/7]

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

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

inline

Copy constructor.

◆ RWTPtrOrderedHashSet() [3/7]

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

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

◆ RWTPtrOrderedHashSet() [4/7]

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

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

◆ RWTPtrOrderedHashSet() [5/7]

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

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

inline

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

◆ RWTPtrOrderedHashSet() [6/7]

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

template<typename InputIterator >

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

◆ RWTPtrOrderedHashSet() [7/7]

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

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

inline

Creates an empty 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< T, H, EQ, A >::difference ( const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 * RWTPtrOrderedHashSet< 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 * RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 is 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 RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< T, H, EQ, A >::intersection ( const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::isEquivalent ( const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::isProperSubsetOf ( const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::isSubsetOf ( const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< T, H, EQ, A >::operator= ( const RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< 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*>>

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

RWTPtrOrderedHashSet< T, H, EQ, A >::size_type RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::resize ( size_type sz )

inline

Changes the capacity of self by creating a new 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 & RWTPtrOrderedHashSet< 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 & RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A >::swap ( RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< T, H, EQ, A >::symmetricDifference ( const RWTPtrOrderedHashSet< 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*>>

RWTPtrOrderedHashSet< T, H, EQ, A > & RWTPtrOrderedHashSet< T, H, EQ, A >::Union ( const RWTPtrOrderedHashSet< 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 RWTPtrOrderedHashSet< T, H, EQ, A > &	lhs,
		const RWTPtrOrderedHashSet< T, H, EQ, A > &	rhs )

◆ operator!=() [2/3]

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

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

◆ operator!=() [3/3]

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

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

◆ operator<<() [1/2]

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

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

◆ operator<<() [2/2]

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

RWvostream & operator<<	(	RWvostream &	strm,
		const RWTPtrOrderedHashSet< T, H, EQ, A > &	coll )

◆ operator==() [1/3]

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

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

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 RWTPtrOrderedHashSet< T, H, EQ, A > &	lhs,
		const typename RWTPtrOrderedHashSet< T, H, EQ, A >::container_type &	rhs )

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 RWTPtrOrderedHashSet< T, H, EQ, A >::container_type &	lhs,
		const RWTPtrOrderedHashSet< T, H, EQ, A > &	rhs )

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,
		RWTPtrOrderedHashSet< T, H, EQ, A > &	coll )

◆ operator>>() [2/4]

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

RWFile & operator>>	(	RWFile &	strm,
		RWTPtrOrderedHashSet< T, H, EQ, A > *&	p )

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,
		RWTPtrOrderedHashSet< T, H, EQ, A > &	coll )

◆ operator>>() [4/4]

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

RWvistream & operator>>	(	RWvistream &	strm,
		RWTPtrOrderedHashSet< T, H, EQ, A > *&	p )

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.

SourcePro® API Reference Guide

Public Types

Public Member Functions

Related Symbols

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ container_type

◆ difference_type

◆ hasher

◆ iterator

◆ key_equal

◆ key_type

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ RWTPtrOrderedHashSet() [1/7]

◆ RWTPtrOrderedHashSet() [2/7]

◆ RWTPtrOrderedHashSet() [3/7]

◆ RWTPtrOrderedHashSet() [4/7]

◆ RWTPtrOrderedHashSet() [5/7]

◆ RWTPtrOrderedHashSet() [6/7]

◆ RWTPtrOrderedHashSet() [7/7]

Member Function Documentation

◆ apply() [1/2]

◆ apply() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity()

◆ cbegin()

◆ cend()

◆ clear()

◆ clearAndDestroy()

◆ contains() [1/2]

◆ contains() [2/2]

◆ difference()

◆ end() [1/2]

◆ end() [2/2]

◆ entries()

◆ erase() [1/2]

◆ erase() [2/2]

◆ fillRatio()

◆ find() [1/3]

◆ find() [2/3]

◆ find() [3/3]

◆ insert() [1/3]

◆ insert() [2/3]

◆ insert() [3/3]

◆ intersection()

◆ isEmpty()

◆ isEquivalent()

◆ isProperSubsetOf()

◆ isSubsetOf()

◆ occurrencesOf() [1/2]

◆ occurrencesOf() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ remove() [1/2]

◆ remove() [2/2]

◆ removeAll() [1/2]

◆ removeAll() [2/2]

◆ resize()

◆ std() [1/2]

◆ std() [2/2]

◆ swap()

◆ symmetricDifference()

◆ Union()

Friends And Related Symbol Documentation

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator<<() [1/2]

◆ operator<<() [2/2]