User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
HSetC::HSetC(void)
HSetC::HSetC(istream &)
HSetC::HSetC(const HSetC &)
HSetC::Copy(void) const
HSetC::IsMember(const T &) const
HSetC::Insert(const T &)
HSetC::Remove(const T &)
HSetC::Empty(void)
HSetC::Size(void) const
HSetC::operator+=(const T &)
HSetC::operator-=(const T &)
HSetC::operator+=(const HSetC &)
HSetC::operator-=(const HSetC &)
HSetC::Random(void) const
HSetC::First(void) const
HSetC::IsEmpty(void) const
HSetC::Union(const HSetC &) const
HSetC::UnionIP(const HSetC &)
HSetC::Intersect(const HSetC &) const
HSetC::IntersectIP(const HSetC &)
HSetC::Disjunction(const HSetC &) const
HSetC::DisjunctionIP(const HSetC &)
HSetC::IsSubset(const HSetC &) const
HSetC::operator==(const HSetC &) const
HSetC::operator!=(const HSetC &) const
HSetC<class T>
 
Set of objects.
 
include "amma/HSet.hh"
User Level:Default
Library:Hash1d
Example:WordFreq.cc
Section:Containers.Sets
In Scope:std

Comments:
This is based on the templated hash tables. Object must provide the Hash function needed by HashC. see "amma/Hash.hh"

BIG OBJECT

Derived Classes: Variables:
Methods:
HSetC()
Default constructor.

HSetC(istream & in)
stream constructor.

HSetC(const HSetC<T> & Oth)
Copy constructor.

HSetC<T> Copy() const
Make a Shallow copy of the set.

BooleanT IsMember(const T & It) const
Is It a member of the set ?

BooleanT Insert(const T & It)
Insert an element into the set.
Ret = False, member already present. True, new member added.

BooleanT Remove(const T & It)
Remove an item from the set.
Ret = True, item removed. False, item not in set.

void Empty()
Remove everthing from the set.

UIntT Size() const
Number of elements in set.

HSetC<T> & operator+=(const T & dat)
Add a member to the set.

HSetC<T> & operator-=(const T & dat)
Remove a member from the set.

HSetC<T> & operator+=(const HSetC<T> & dat)
Add a set to this set.

HSetC<T> & operator-=(const HSetC<T> & dat)
Remove a set from this one.

const T & Random() const
Select a random member of the set.
NOTE: It is the user's responsibility to ensure the set it not empty when this function is called.

const T & First() const
Return the first member of the set.
The exact member this returns is undefined, but it is not random.

NOTE: It is the user's responsibility to ensure the set it not empty when this function is called.


BooleanT IsEmpty() const
Test if the set is empty.

HSetC<T> Union(const HSetC<T> & Oth) const
Get Union of another set with this one.

BooleanT UnionIP(const HSetC<T> & Oth)
Get Union of another set with this one.
Returns true when resulting set in non-empty.

HSetC<T> Intersect(const HSetC<T> & Oth) const
Get intersection of another set with this one.

BooleanT IntersectIP(const HSetC<T> & Oth)
Intersect this set with another (In Place)
Returns true when resulting set in non-empty.

HSetC<T> Disjunction(const HSetC<T> & Oth) const
Return the items in either set but not in both.

BooleanT DisjunctionIP(const HSetC<T> & Oth)
Return the items in either set but not in both. (In Place).
Returns true when resulting set in non-empty.

BooleanT IsSubset(const HSetC<T> & oth) const
is oth a subset of this ?

BooleanT operator==(const HSetC<T> & oth) const
Is equal, ie contains all the same members ?

BooleanT operator!=(const HSetC<T> & oth) const
Is not equal, ie contains different members ?
More comming soon.... (Or on request. )


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001