Home Libraries Author Links

intStmMultiSetDoc.h File Reference


Detailed Description

Documentation of the abstract multiset type intStmMultiSet.

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 intStmMultiSetDoc.h.

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

Go to the source code of this file.

intStmMultiSet Representation

Objects of abstract multiset type intStmMultiSet and their iterators of type intStmMultiSetIterator are represented by pointers to their implementation structures of type intStmMultiSetImpl_ and intStmMultiSetIteratorImpl_, respectively.

#define StmMultiSetDoc_
typedef struct
intStmMultiSetImpl_ * 
intStmMultiSet
 A valid intStmMultiSet object is represented as a pointer to its implementation structure intStmMultiSetImpl_.
typedef struct
intStmMultiSetIteratorImpl_ * 
intStmMultiSetIterator
 A valid intStmMultiSetIterator object is represented as a pointer to its implementation structure intStmMultiSetIteratorImpl_.

intStmMultiSet Creation and Destruction

static intStmMultiSet intStmMultiSetCreate (void)
 Creation of a new intStmMultiSet object.
static void intStmMultiSetDestroy (intStmMultiSet ac)
 Destruction of the intStmMultiSet object ac.

intStmMultiSet Iterators

static intStmMultiSetIterator intStmMultiSetBegin (intStmMultiSet ac)
 Return an iterator to the first element of the intStmMultiSet object ac.
static intStmMultiSetIterator intStmMultiSetEnd (intStmMultiSet ac)
 Return an iterator to one past the last element of the intStmMultiSet object ac.
static intStmMultiSetIterator intStmMultiSetRBegin (intStmMultiSet ac)
 Return an iterator to the last element of the intStmMultiSet object ac.
static intStmMultiSetIterator intStmMultiSetREnd (intStmMultiSet ac)
 Return an iterator to one before the first element of the intStmMultiSet object ac.
static intStmMultiSetIterator intStmMultiSetIteratorNext (intStmMultiSetIterator iter)
 Return an iterator to the element following the one referenced by iter.
static intStmMultiSetIterator intStmMultiSetIteratorPrev (intStmMultiSetIterator iter)
 Return an iterator to the element preceding the one referenced by iter.
static StmBool intStmMultiSetIteratorDereferenceable (intStmMultiSetIterator iter)
 Return StmTrue, if iter is dereferenceable.
static StmBool intStmMultiSetIteratorDereferencable (intStmMultiSetIterator iter)
 Return StmTrue, if iter is dereferenceable.
static const int * intStmMultiSetIteratorElem (intStmMultiSetIterator iter)
 Return a pointer to the constant element referenced by iter.
static int intStmMultiSetIteratorKey (intStmMultiSetIterator iter)
 Return a copy of the element referenced by iter.

intStmMultiSet Capacity

static int intStmMultiSetSize (intStmMultiSet ac)
 Return the element count of the intStmMultiSet object ac.
static int intStmMultiSetMaxSize (intStmMultiSet ac)
 Return the maximal possible element count of the intStmMultiSet object ac.
static StmBool intStmMultiSetEmpty (intStmMultiSet ac)
 Return StmTrue, if the intStmMultiSet object ac is empty.

intStmMultiSet Modifiers

static intStmMultiSetIterator intStmMultiSetInsert (intStmMultiSet ac, const int *elem)
 Insert the element pointed to by elem into the intStmMultiSet object ac.
static int intStmMultiSetErase (intStmMultiSet ac, intStmMultiSetIterator iter)
 Erase the element referenced by iter from the intStmMultiSet object ac.
static int intStmMultiSetEraseRange (intStmMultiSet ac, intStmMultiSetIterator first, intStmMultiSetIterator last)
 Erase the elements referenced by the half open interval [first, last) from the intStmMultiSet object ac.
static int intStmMultiSetEraseElem (intStmMultiSet ac, const int *elem)
 Erase all elements equivalent to the element pointed to by elem from the intStmMultiSet object ac.
static int intStmMultiSetEraseKey (intStmMultiSet ac, int key)
 Erase all elements with value key from the intStmMultiSet object ac.
static int intStmMultiSetClear (intStmMultiSet ac)
 Erase all elements from the intStmMultiSet ac.

intStmMultiSet Operations

static intStmMultiSetIterator intStmMultiSetFind (intStmMultiSet ac, const int *elem)
 Find an element in the intStmMultiSet object ac equivalent to the element pointed to by elem.
static intStmMultiSetIterator intStmMultiSetFindKey (intStmMultiSet ac, int key)
 Find an element in the intStmMultiSet object ac with value key.
static int intStmMultiSetCount (intStmMultiSet ac, const int *elem, intStmMultiSetIterator *first, intStmMultiSetIterator *last)
 Return the number of elements in the intStmMultiSet object ac being equivalent to the element pointed to by elem and optionally determine the range of the elements found.
static int intStmMultiSetCountKey (intStmMultiSet ac, int key, intStmMultiSetIterator *first, intStmMultiSetIterator *last)
 Return the number of elements in the intStmMultiSet 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).