Home Libraries Author Links

intStmSetDoc.h File Reference


Detailed Description

Documentation of the abstract set type intStmSet.

This C header is generated automatically by the AWK script mksettypedoc.awk, which expands the variables Ac, AcGroup, AcKind, ElemType, KeyType, MappedType and elemCmpFct. Ac stands for associative container and designates one of the container types StmSet, StmMultiSet, StmMap or StmMultiMap and AcKind one of their names set, multiset, map or multimap.

Definition in file intStmSetDoc.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

intStmSet Representation

Objects of abstract set type intStmSet and their iterators of type intStmSetIterator are represented by pointers to their implementation structures of type intStmSetImpl_ and intStmSetIteratorImpl_, respectively.

#define StmSetDoc_
typedef struct intStmSetImpl_ * intStmSet
 A valid intStmSet object is represented as a pointer to its implementation structure intStmSetImpl_.
typedef struct
intStmSetIteratorImpl_ * 
intStmSetIterator
 A valid intStmSetIterator object is represented as a pointer to its implementation structure intStmSetIteratorImpl_.

intStmSet Creation and Destruction

static intStmSet intStmSetCreate (void)
 Creation of a new intStmSet object.
static void intStmSetDestroy (intStmSet ac)
 Destruction of the intStmSet object ac.

intStmSet Iterators

static intStmSetIterator intStmSetBegin (intStmSet ac)
 Return an iterator to the first element of the intStmSet object ac.
static intStmSetIterator intStmSetEnd (intStmSet ac)
 Return an iterator to one past the last element of the intStmSet object ac.
static intStmSetIterator intStmSetRBegin (intStmSet ac)
 Return an iterator to the last element of the intStmSet object ac.
static intStmSetIterator intStmSetREnd (intStmSet ac)
 Return an iterator to one before the first element of the intStmSet object ac.
static intStmSetIterator intStmSetIteratorNext (intStmSetIterator iter)
 Return an iterator to the element following the one referenced by iter.
static intStmSetIterator intStmSetIteratorPrev (intStmSetIterator iter)
 Return an iterator to the element preceding the one referenced by iter.
static StmBool intStmSetIteratorDereferenceable (intStmSetIterator iter)
 Return StmTrue, if iter is dereferenceable.
static StmBool intStmSetIteratorDereferencable (intStmSetIterator iter)
 Return StmTrue, if iter is dereferenceable.
static const int * intStmSetIteratorElem (intStmSetIterator iter)
 Return a pointer to the constant element referenced by iter.
static int intStmSetIteratorKey (intStmSetIterator iter)
 Return a copy of the element referenced by iter.

intStmSet Capacity

static int intStmSetSize (intStmSet ac)
 Return the element count of the intStmSet object ac.
static int intStmSetMaxSize (intStmSet ac)
 Return the maximal possible element count of the intStmSet object ac.
static StmBool intStmSetEmpty (intStmSet ac)
 Return StmTrue, if the intStmSet object ac is empty.

intStmSet Modifiers

static intStmSetIterator intStmSetInsert (intStmSet ac, const int *elem, StmBool *inserted)
 Insert the element pointed to by elem into the intStmSet object ac.
static int intStmSetErase (intStmSet ac, intStmSetIterator iter)
 Erase the element referenced by iter from the intStmSet object ac.
static int intStmSetEraseRange (intStmSet ac, intStmSetIterator first, intStmSetIterator last)
 Erase the elements referenced by the half open interval [first, last) from the intStmSet object ac.
static int intStmSetEraseElem (intStmSet ac, const int *elem)
 Erase all elements equivalent to the element pointed to by elem from the intStmSet object ac.
static int intStmSetEraseKey (intStmSet ac, int key)
 Erase all elements with value key from the intStmSet object ac.
static int intStmSetClear (intStmSet ac)
 Erase all elements from the intStmSet ac.

intStmSet Operations

static intStmSetIterator intStmSetFind (intStmSet ac, const int *elem)
 Find an element in the intStmSet object ac equivalent to the element pointed to by elem.
static intStmSetIterator intStmSetFindKey (intStmSet ac, int key)
 Find an element in the intStmSet object ac with value key.
static int intStmSetCount (intStmSet ac, const int *elem, intStmSetIterator *first, intStmSetIterator *last)
 Return the number of elements in the intStmSet object ac being equivalent to the element pointed to by elem and optionally determine the range of the elements found.
static int intStmSetCountKey (intStmSet ac, int key, intStmSetIterator *first, intStmSetIterator *last)
 Return the number of elements in the intStmSet object ac having value key and optionally determine the range of the elements found.


© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).