basis::set< contents > Class Template Reference

Emulates a mathematical set, providing several standard set operations. More...

#include <set.h>

Inheritance diagram for basis::set< contents >:

Inheritance graph
[legend]
Collaboration diagram for basis::set< contents >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 set (int num=0, const contents *init=NIL, u_short flags=array< contents >::EXPONE)
 Constructs a set with "num" elements, copying them from "init".
 ~set ()
 Destroys any storage held for the set.
int elements () const
 Returns the number of elements in this set.
bool empty () const
 Returns true if the set has no elements.
bool non_empty () const
 Returns true if the set has some elements.
void clear ()
 Empties out this set.
bool member (const contents &to_test) const
 Returns true if the item "to_test" is a member of this set.
bool add (const contents &to_add)
 Adds a new element "to_add" to the set.
setoperator+= (const contents &to_add)
 An algebraic operator synonym for add() that operates on the contents.
setoperator+= (const set &to_add)
 An algebraic operator synonym for add() that operates on a set.
bool remove (const contents &to_remove)
 Removes the item "to_remove" from the set.
setoperator-= (const contents &to_zap)
 An algebraic operator synonym for remove that operates on the contents.
setoperator-= (const set &to_zap)
 An algebraic operator synonym for remove that operates on a set.
set set_union (const set &union_with) const
 Implements the set union of "this" with "union_with".
void unionize (const set &union_with)
 Makes "this" set a union of "this" and "union_with".
set operator+ (const set &uw) const
 A synonym for set_union.
set intersection (const set &intersect_with) const
 Returns the intersection of "this" with the set in "intersect_with".
set operator* (const set &iw) const
 A synonym for intersection.
set difference (const set &differ_with) const
 Returns the difference of this with "differ_with".
void differentiate (const set &differ_with)
 Makes "this" set equal to the difference of "this" and "differ_with".
set operator- (const set &dw) const
 A synonym for difference.
int find (const contents &to_find) const
 Returns the integer index of the item "to_find" in this set.
bool remove_index (int index)
 Zaps the entry at the specified "index".


Detailed Description

template<class contents>
class basis::set< contents >

Emulates a mathematical set, providing several standard set operations.

Definition at line 28 of file set.h.


Constructor & Destructor Documentation

template<class contents>
basis::set< contents >::set ( int  num = 0,
const contents *  init = NIL,
u_short  flags = array<contents>::EXPONE 
) [inline]

Constructs a set with "num" elements, copying them from "init".

Be very careful to ensure that the array "init" has sufficient length for "num" elements to be copied from it.

Definition at line 34 of file set.h.

template<class contents>
basis::set< contents >::~set (  )  [inline]

Destroys any storage held for the set.

Definition at line 38 of file set.h.


Member Function Documentation

template<class contents>
int basis::set< contents >::elements (  )  const [inline]

template<class contents>
bool basis::set< contents >::empty (  )  const [inline]

Returns true if the set has no elements.

Definition at line 43 of file set.h.

template<class contents>
bool basis::set< contents >::non_empty (  )  const [inline]

Returns true if the set has some elements.

Definition at line 45 of file set.h.

template<class contents>
void basis::set< contents >::clear (  )  [inline]

template<class contents>
bool basis::set< contents >::member ( const contents &  to_test  )  const [inline]

template<class contents>
bool basis::set< contents >::add ( const contents &  to_add  )  [inline]

Adds a new element "to_add" to the set.

This always succeeds, but will return true if the item was not already present.

Definition at line 232 of file set.h.

References array< contents >::concatenate(), and basis::set< contents >::member().

Referenced by pointer_hash< contents >::add(), int_hash< contents >::add(), log_base::add_filter(), process_control::find_process_in_list(), list_parsing::get_ids_from_string(), basis::set< contents >::set_union(), and basis::unpack().

template<class contents>
set& basis::set< contents >::operator+= ( const contents &  to_add  )  [inline]

An algebraic operator synonym for add() that operates on the contents.

Reimplemented from array< contents >.

Definition at line 58 of file set.h.

template<class contents>
set& basis::set< contents >::operator+= ( const set< contents > &  to_add  )  [inline]

An algebraic operator synonym for add() that operates on a set.

Definition at line 61 of file set.h.

template<class contents>
bool basis::set< contents >::remove ( const contents &  to_remove  )  [inline]

template<class contents>
set& basis::set< contents >::operator-= ( const contents &  to_zap  )  [inline]

An algebraic operator synonym for remove that operates on the contents.

Definition at line 69 of file set.h.

template<class contents>
set& basis::set< contents >::operator-= ( const set< contents > &  to_zap  )  [inline]

An algebraic operator synonym for remove that operates on a set.

Definition at line 72 of file set.h.

template<class contents>
set< contents > basis::set< contents >::set_union ( const set< contents > &  union_with  )  const [inline]

Implements the set union of "this" with "union_with".

This returns the set formed from the union of "this" set with the set specified in "union_with". (unfortunately, the name "set_union" must be used to distinguish from the C keyword "union".)

Definition at line 277 of file set.h.

References basis::set< contents >::add().

Referenced by basis::set< istring >::operator+().

template<class contents>
void basis::set< contents >::unionize ( const set< contents > &  union_with  )  [inline]

Makes "this" set a union of "this" and "union_with".

Definition at line 286 of file set.h.

Referenced by basis::set< istring >::operator+=().

template<class contents>
set basis::set< contents >::operator+ ( const set< contents > &  uw  )  const [inline]

A synonym for set_union.

Definition at line 85 of file set.h.

template<class contents>
set< contents > basis::set< contents >::intersection ( const set< contents > &  intersect_with  )  const [inline]

Returns the intersection of "this" with the set in "intersect_with".

Definition at line 260 of file set.h.

References array< contents >::concatenate(), basis::set< contents >::elements(), array< contents >::flags(), and NIL.

Referenced by config_watcher::changed_items(), config_watcher::changed_sections(), and basis::set< istring >::operator*().

template<class contents>
set basis::set< contents >::operator* ( const set< contents > &  iw  )  const [inline]

A synonym for intersection.

Definition at line 91 of file set.h.

template<class contents>
set< contents > basis::set< contents >::difference ( const set< contents > &  differ_with  )  const [inline]

Returns the difference of this with "differ_with".

Difference is defined as the subset of elements in "this" that are not also in "differ_with".

Definition at line 293 of file set.h.

References basis::set< contents >::member(), and basis::set< contents >::remove().

Referenced by basis::set< istring >::operator-().

template<class contents>
void basis::set< contents >::differentiate ( const set< contents > &  differ_with  )  [inline]

Makes "this" set equal to the difference of "this" and "differ_with".

That is, after the call, "this" will only contain elements that were not also in "differ_with".

Definition at line 304 of file set.h.

References basis::set< contents >::member().

Referenced by basis::set< istring >::operator-=().

template<class contents>
set basis::set< contents >::operator- ( const set< contents > &  dw  )  const [inline]

A synonym for difference.

Definition at line 104 of file set.h.

template<class contents>
int basis::set< contents >::find ( const contents &  to_find  )  const [inline]

Returns the integer index of the item "to_find" in this set.

This returns a negative number if the index cannot be found. Note that this only makes sense within our particular implementation of set as an array.

Definition at line 240 of file set.h.

References basis::set< contents >::elements().

template<class contents>
bool basis::set< contents >::remove_index ( int  index  )  [inline]

Zaps the entry at the specified "index".

This also treats the set like an array. The index must be within the bounds of the existing members.

Definition at line 116 of file set.h.


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

Generated on Mon Jul 26 04:23:28 2010 for HOOPLE Libraries by  doxygen 1.5.6