Home Libraries Author Links

MultiNrStmMultiMapDoc.h File Reference


Detailed Description

Documentation of the abstract multimap type MultiNrStmMultiMap.

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

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

Go to the source code of this file.

Data Structures

struct  MultiNr
 Element type of the abstract multimap type MultiNrStmMultiMap. More...
struct  MultiNrStmMultiMapValueType
 Value type structure of an MultiNrStmMultiMap object. More...

MultiNrStmMultiMap Representation

Objects of abstract multimap type MultiNrStmMultiMap and their iterators of type MultiNrStmMultiMapIterator are represented by pointers to their implementation structures of type MultiNrStmMultiMapImpl_ and MultiNrStmMultiMapIteratorImpl_, respectively.

#define StmMultiMapDoc_
typedef struct
MultiNrStmMultiMapImpl_ * 
MultiNrStmMultiMap
 A valid MultiNrStmMultiMap object is represented as a pointer to its implementation structure MultiNrStmMultiMapImpl_.
typedef struct
MultiNrStmMultiMapIteratorImpl_ * 
MultiNrStmMultiMapIterator
 A valid MultiNrStmMultiMapIterator object is represented as a pointer to its implementation structure MultiNrStmMultiMapIteratorImpl_.
typedef struct MultiNr MultiNr
 Type name of the element type of the abstract multimap type MultiNrStmMultiMap.
typedef struct
MultiNrStmMultiMapValueType 
MultiNrStmMultiMapValueType
 Type name of the value type of the abstract multimap type MultiNrStmMultiMap.

MultiNrStmMultiMap Creation and Destruction

static MultiNrStmMultiMap MultiNrStmMultiMapCreate (void)
 Creation of a new MultiNrStmMultiMap object.
static void MultiNrStmMultiMapDestroy (MultiNrStmMultiMap ac)
 Destruction of the MultiNrStmMultiMap object ac.

MultiNrStmMultiMap Iterators

static MultiNrStmMultiMapIterator MultiNrStmMultiMapBegin (MultiNrStmMultiMap ac)
 Return an iterator to the first element of the MultiNrStmMultiMap object ac.
static MultiNrStmMultiMapIterator MultiNrStmMultiMapEnd (MultiNrStmMultiMap ac)
 Return an iterator to one past the last element of the MultiNrStmMultiMap object ac.
static MultiNrStmMultiMapIterator MultiNrStmMultiMapRBegin (MultiNrStmMultiMap ac)
 Return an iterator to the last element of the MultiNrStmMultiMap object ac.
static MultiNrStmMultiMapIterator MultiNrStmMultiMapREnd (MultiNrStmMultiMap ac)
 Return an iterator to one before the first element of the MultiNrStmMultiMap object ac.
static MultiNrStmMultiMapIterator MultiNrStmMultiMapIteratorNext (MultiNrStmMultiMapIterator iter)
 Return an iterator to the element following the one referenced by iter.
static MultiNrStmMultiMapIterator MultiNrStmMultiMapIteratorPrev (MultiNrStmMultiMapIterator iter)
 Return an iterator to the element preceding the one referenced by iter.
static StmBool MultiNrStmMultiMapIteratorDereferenceable (MultiNrStmMultiMapIterator iter)
 Return StmTrue, if iter is dereferenceable.
static StmBool MultiNrStmMultiMapIteratorDereferencable (MultiNrStmMultiMapIterator iter)
 Return StmTrue, if iter is dereferenceable.
static
MultiNrStmMultiMapValueType
MultiNrStmMultiMapIteratorElem (MultiNrStmMultiMapIterator iter)
 Return a pointer to the MultiNrStmMultiMapValueType object accessing the element referenced by iter.
static int MultiNrStmMultiMapIteratorKey (MultiNrStmMultiMapIterator iter)
 Return the key of the element referenced by iter.
static int * MultiNrStmMultiMapIteratorVal (MultiNrStmMultiMapIterator iter)
 Return a pointer to the value mapped to by the element referenced by iter.

MultiNrStmMultiMap Capacity

static int MultiNrStmMultiMapSize (MultiNrStmMultiMap ac)
 Return the element count of the MultiNrStmMultiMap object ac.
static int MultiNrStmMultiMapMaxSize (MultiNrStmMultiMap ac)
 Return the maximal possible element count of the MultiNrStmMultiMap object ac.
static StmBool MultiNrStmMultiMapEmpty (MultiNrStmMultiMap ac)
 Return StmTrue, if the MultiNrStmMultiMap object ac is empty.

MultiNrStmMultiMap Modifiers

static MultiNrStmMultiMapIterator MultiNrStmMultiMapInsert (MultiNrStmMultiMap ac, const MultiNr *elem)
 Insert the element pointed to by elem into the MultiNrStmMultiMap object ac.
static int MultiNrStmMultiMapErase (MultiNrStmMultiMap ac, MultiNrStmMultiMapIterator iter)
 Erase the element referenced by iter from the MultiNrStmMultiMap object ac.
static int MultiNrStmMultiMapEraseRange (MultiNrStmMultiMap ac, MultiNrStmMultiMapIterator first, MultiNrStmMultiMapIterator last)
 Erase the elements referenced by the half open interval [first, last) from the MultiNrStmMultiMap object ac.
static int MultiNrStmMultiMapEraseElem (MultiNrStmMultiMap ac, const MultiNr *elem)
 Erase all elements equivalent to the element pointed to by elem from the MultiNrStmMultiMap object ac.
static int MultiNrStmMultiMapEraseKey (MultiNrStmMultiMap ac, int key)
 Erase all elements designated by key from the MultiNrStmMultiMap object ac.
static int MultiNrStmMultiMapClear (MultiNrStmMultiMap ac)
 Erase all elements from the MultiNrStmMultiMap ac.

MultiNrStmMultiMap Operations

static MultiNrStmMultiMapIterator MultiNrStmMultiMapFind (MultiNrStmMultiMap ac, const MultiNr *elem)
 Find an element in the MultiNrStmMultiMap object ac equivalent to the element pointed to by elem.
static MultiNrStmMultiMapIterator MultiNrStmMultiMapFindKey (MultiNrStmMultiMap ac, int key)
 Find an element in the MultiNrStmMultiMap object ac designated by key.
static int MultiNrStmMultiMapCount (MultiNrStmMultiMap ac, const MultiNr *elem, MultiNrStmMultiMapIterator *first, MultiNrStmMultiMapIterator *last)
 Return the number of elements in the MultiNrStmMultiMap object ac being equivalent to the element pointed to by elem and optionally determine the range of the elements found.
static int MultiNrStmMultiMapCountKey (MultiNrStmMultiMap ac, int key, MultiNrStmMultiMapIterator *first, MultiNrStmMultiMapIterator *last)
 Return the number of elements in the MultiNrStmMultiMap object ac designated by 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).