HashSet< T, H, A > Class Template Reference

#include <elm/data/HashSet.h>

Classes
class	Iter

Public Types
typedef HashSet< T, H, A >	self_t

Public Member Functions
	HashSet (int size=211)
	HashSet (const HashSet< T > &s)
const H &	hash () const
H &	hash ()
const A &	allocator () const
A &	allocator ()
int	count (void) const
bool	contains (const T &val) const
template<class C >
bool	containsAll (const C &coll)
bool	isEmpty (void) const
	operator bool (void) const
Iter	begin (void) const
Iter	end (void) const
bool	equals (const HashSet< T > &s) const
bool	operator== (const HashSet< T > &s) const
bool	operator!= (const HashSet< T > &s) const
void	clear (void)
void	add (const T &val)
template<class C >
void	addAll (const C &coll)
void	remove (const T &val)
template<class C >
void	removeAll (const C &c)
void	remove (const Iter &i)
void	copy (const HashSet< T > &s)
self_t	operator= (const HashSet< T > &s)
self_t	operator+= (const T &x)
self_t	operator-= (const T &x)
void	insert (const T &val)
bool	subsetOf (const HashSet< T > &s) const
bool	operator<= (const HashSet< T > &s) const
bool	operator>= (const HashSet< T > &s) const
bool	operator< (const HashSet< T > &s) const
bool	operator> (const HashSet< T > &s) const
void	join (const HashSet< T > &c)
void	diff (const HashSet< T > &c)
void	meet (const HashSet< T > &c)
self_t &	operator+= (const HashSet< T > &s)
self_t &	operator|= (const HashSet< T > &s)
self_t &	operator-= (const HashSet< T > &s)
self_t &	operator&= (const HashSet< T > &s)
self_t &	operator*= (const HashSet< T > &s)
self_t	operator+ (const HashSet< T > &s) const
self_t	operator| (const HashSet< T > &s) const
self_t	operator- (const HashSet< T > &s) const
self_t	operator& (const HashSet< T > &s) const
self_t	operator* (const HashSet< T > &s) const
Iter	items (void) const
Iter	operator* (void) const

Static Public Attributes
static const self_t	null

Detailed Description

template<class T, class H = HashKey<T>, class A = DefaultAlloc>
class elm::HashSet< T, H, A >

Set implemented using an hash table.

Implemented Concepts

• Collection
• MutableCollection
• Set

Characteristics

S is the size of the table.

• average access time: O(n / S)
• average add time: O(n / S)
• average remove time: O(n / S)
• memory space: pointer size * S + n * (data size + pointer size)

Parameters

T	Type of set elements.
M	Type of used manager (default to HashManager).

Member Typedef Documentation

self_t

typedef HashSet<T, H, A> self_t

Constructor & Destructor Documentation

HashSet() [1/2]

HashSet ( int  size = 211 )

inline

Build an hash set with the given size. Improved efficiency is obtained with prime number as sizes.

Parameters

size	Table size (default to 211).

HashSet() [2/2]

HashSet ( const HashSet< T > &  s )

inline

Member Function Documentation

add()

void add ( const T &  val )

inline

Add an item to the set.

Parameters

val	Added item.

References HashSet< T, H, A >::insert().

Referenced by HashSet< T, H, A >::addAll(), and HashSet< T, H, A >::operator+=().

addAll()

void addAll ( const C &  coll )

inline

Add the given collection of items to the set.

Parameters

coll	Added collection of items.

References HashSet< T, H, A >::add().

allocator() [1/2]

A& allocator ( )

inline

References HashTable< T, H, A >::allocator().

allocator() [2/2]

const A& allocator ( ) const

inline

References HashTable< T, H, A >::allocator().

begin()

Iter begin ( void  ) const

inline

clear()

void clear ( void  )

inline

Remove all items of the set.

References HashTable< T, H, A >::clear().

contains()

bool contains ( const T &  val ) const

inline

References HashTable< T, H, A >::hasKey().

Referenced by HashSet< T, H, A >::containsAll(), HashSet< T, H, A >::meet(), and HashSet< T, H, A >::subsetOf().

containsAll()

bool containsAll ( const C &  c )

inline

Test if all items of collection c are in the set.

Parameters

c	Collection to test.

Returns

True if all collection items are in the set, false else.

References HashSet< T, H, A >::contains().

copy()

void copy ( const HashSet< T > &  s )

inline

References HashTable< T, H, A >::copy().

Referenced by HashSet< T, H, A >::operator=().

count()

int count ( void  ) const

inline

Count the number of items in the set.

Returns

Count of items.

References HashTable< T, H, A >::count().

diff()

void diff ( const HashSet< T > &  c )

inline

References HashSet< T, H, A >::remove().

Referenced by HashSet< T, H, A >::operator-(), and HashSet< T, H, A >::operator-=().

end()

Iter end ( void  ) const

inline

equals()

bool equals ( const HashSet< T > &  s ) const

inline

References HashTable< T, H, A >::equals().

Referenced by HashSet< T, H, A >::operator!=(), and HashSet< T, H, A >::operator==().

hash() [1/2]

H& hash ( )

inline

References HashTable< T, H, A >::hash().

hash() [2/2]

const H& hash ( ) const

inline

References HashTable< T, H, A >::hash().

insert()

void insert ( const T &  val )

inline

Same add add().

References HashTable< T, H, A >::put().

Referenced by HashSet< T, H, A >::add(), and HashSet< T, H, A >::join().

isEmpty()

bool isEmpty ( void  ) const

inline

Test if the set is empty.

Returns

True if the set is empty, false else.

References HashTable< T, H, A >::isEmpty().

Referenced by HashSet< T, H, A >::operator bool().

items()

Iter items ( void  ) const

inline

Get an iterator on the items of the set.

Returns

Iterator on the set.

Referenced by HashSet< T, H, A >::operator*().

join()

void join ( const HashSet< T > &  c )

inline

References HashSet< T, H, A >::insert().

Referenced by HashSet< T, H, A >::operator+(), HashSet< T, H, A >::operator+=(), HashSet< T, H, A >::operator|(), and HashSet< T, H, A >::operator|=().

meet()

void meet ( const HashSet< T > &  c )

inline

References List< T, E, A >::add(), HashSet< T, H, A >::contains(), and HashSet< T, H, A >::remove().

Referenced by HashSet< T, H, A >::operator&(), HashSet< T, H, A >::operator&=(), HashSet< T, H, A >::operator*(), and HashSet< T, H, A >::operator*=().

operator bool()

operator bool ( void  ) const

inline

References HashSet< T, H, A >::isEmpty().

operator!=()

bool operator!= ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::equals().

operator&()

self_t operator& ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::meet().

operator&=()

self_t& operator&= ( const HashSet< T > &  s )

inline

References HashSet< T, H, A >::meet().

operator*() [1/2]

self_t operator* ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::meet().

operator*() [2/2]

Iter operator* ( void  ) const

inline

References HashSet< T, H, A >::items().

operator*=()

self_t& operator*= ( const HashSet< T > &  s )

inline

References HashSet< T, H, A >::meet().

operator+()

self_t operator+ ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::join().

operator+=() [1/2]

self_t& operator+= ( const HashSet< T > &  s )

inline

References HashSet< T, H, A >::join().

operator+=() [2/2]

self_t operator+= ( const T &  x )

inline

References HashSet< T, H, A >::add().

operator-()

self_t operator- ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::diff().

operator-=() [1/2]

self_t& operator-= ( const HashSet< T > &  s )

inline

References HashSet< T, H, A >::diff().

operator-=() [2/2]

self_t operator-= ( const T &  x )

inline

References HashSet< T, H, A >::remove().

operator<()

bool operator< ( const HashSet< T > &  s ) const

inline

operator<=()

bool operator<= ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::subsetOf().

operator=()

self_t operator= ( const HashSet< T > &  s )

inline

References HashSet< T, H, A >::copy().

operator==()

bool operator== ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::equals().

operator>()

bool operator> ( const HashSet< T > &  s ) const

inline

operator>=()

bool operator>= ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::subsetOf().

operator|()

self_t operator| ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::join().

operator|=()

self_t& operator|= ( const HashSet< T > &  s )

inline

References HashSet< T, H, A >::join().

remove() [1/2]

void remove ( const Iter &  i )

inline

Remove the item matching the iterator.

Warning

The iterator is pushed to the next item.

Parameters

i	Iterator on the item to remove.

References HashTable< T, H, A >::remove().

remove() [2/2]

void remove ( const T &  val )

inline

Remove the given item from the set.

Parameters

val	Removed item.

References HashTable< T, H, A >::remove().

Referenced by HashSet< T, H, A >::diff(), HashSet< T, H, A >::meet(), HashSet< T, H, A >::operator-=(), and HashSet< T, H, A >::removeAll().

removeAll()

void removeAll ( const C &  coll )

inline

Remove a collection of items from the set.

Parameters

coll	Collection of items to remove.

References HashSet< T, H, A >::remove().

subsetOf()

bool subsetOf ( const HashSet< T > &  s ) const

inline

References HashSet< T, H, A >::contains().

Referenced by HashSet< T, H, A >::operator<=(), and HashSet< T, H, A >::operator>=().

Member Data Documentation

null

const HashSet< T, H, A > null

static

---

The documentation for this class was generated from the following files:

• include/elm/data/HashSet.h
• src/data_HashTable.cpp