indexSet Class Template Reference
[Index sets]

Interface class for index set objects. More...

#include <indexSet.h>

Inheritance diagram for indexSet:

managedObject goblinRootObject fullIndex indexSetComplement indexSetCut indexSetDifference indexSetMinus indexSetUnion singletonIndex staticQueue staticStack voidIndex

Public Member Functions

 indexSet (TItem _maxIndex, goblinController &_context=goblinDefaultContext) throw ()
virtual ~indexSet () throw ()
virtual unsigned long Size () const =0 throw ()
char * Display () const throw ()
virtual bool IsMember (TItem i) const =0 throw (ERRange)
virtual TItem First () const throw ()
virtual TItem Successor (const TItem i) const throw (ERRange)

Data Fields

TItem maxIndex

Detailed Description

template<class TItem>
class indexSet< TItem >

Interface class for index set objects.


Constructor & Destructor Documentation

indexSet TItem  _maxIndex,
goblinController _context = goblinDefaultContext
throw ()
 

~indexSet  )  throw () [virtual]
 


Member Function Documentation

char * Display  )  const throw () [virtual]
 

Unconditional display of data objects.

Reimplemented from managedObject.

Reimplemented in staticQueue, staticStack, staticQueue< TNode >, staticQueue< TArc >, and staticStack< TNode >.

TItem First  )  const throw () [virtual]
 

Query the smallest index in an index set.

Returns:
The smallest index contained by this set

Reimplemented in leftHandNodes, rightHandNodes, singletonIndex, fullIndex, voidIndex, staticQueue, staticStack, staticQueue< TNode >, staticQueue< TArc >, and staticStack< TNode >.

virtual bool IsMember TItem  i  )  const throw (ERRange) [pure virtual]
 

Test for indet set membership.

Parameters:
i An index to test for indet set membership
Return values:
true The indexed element is contained by this set

Implemented in leftHandNodes, rightHandNodes, supersaturatedNodes, deficientNodes, residualArcs, demandNodes, colouredNodes, kempeNodes, colouredArcs, nonBlockingArcs, subgraphArcs, inducedArcs, singletonIndex, fullIndex, voidIndex, indexSetUnion, indexSetCut, indexSetMinus, indexSetDifference, indexSetComplement, staticQueue, staticStack, staticQueue< TNode >, staticQueue< TArc >, and staticStack< TNode >.

virtual unsigned long Size  )  const throw () [pure virtual]
 

Implements goblinRootObject.

Implemented in leftHandNodes, rightHandNodes, supersaturatedNodes, deficientNodes, residualArcs, demandNodes, colouredNodes, kempeNodes, colouredArcs, nonBlockingArcs, subgraphArcs, inducedArcs, singletonIndex, fullIndex, voidIndex, indexSetUnion, indexSetCut, indexSetMinus, indexSetDifference, indexSetComplement, staticQueue, staticStack, staticQueue< TNode >, staticQueue< TArc >, and staticStack< TNode >.

TItem Successor const TItem  i  )  const throw (ERRange) [virtual]
 

Enumeration of the indices contained in a set.

Returns:
The least upper bound index contained by this set

Reimplemented in leftHandNodes, rightHandNodes, singletonIndex, fullIndex, voidIndex, staticQueue, staticStack, staticQueue< TNode >, staticQueue< TArc >, and staticStack< TNode >.


Field Documentation

TItem maxIndex