LEdgeMap

Description Used to map the edges of a graph
Header file LEdgeMap.h
Author Stefano Emiliozzi, Camil Demetrescu
Created Mar 18, 2003
Last updated Sep 24, 2003

 

Contents


Introduction

The component LEdgeMap provides a series of useful functions to access the edges of a graph. The user can know in O(1) time whether an edge belongs to a graph and can also obtain it.


Interface

Constants

LEdgeMap_ID
LEdgeMap_OBJECT_NULL_POINTER
LEdgeMap_GRAPH_NULL_POINTER
LEdgeMap_NODE_NULL_POINTER

Types

LEdgeMap

Functions

LEdgeMap*     LEdgeMap_New        (LGraph* inGraph)
void          LEdgeMap_Delete     (LEdgeMap** ThisA)
Bool          LEdgeMap_EdgeExists (LEdgeMap* This, LGraph_TNode* inSrc, LGraph_TNode* inDst)
LGraph_TEdge* LEdgeMap_GetEdge    (LEdgeMap* This, LGraph_TNode* inSrc, LGraph_TNode* inDst)
ui4           LEdgeMap_GetUsedMem (LEdgeMap* This)


API Reference

Function Arguments Description Returns Throws
New LGraph* inGraph Creates an object containing an LEdgeMap associated to inGraph. Caller is responsible of dellocating the created object using LEdgeMap_Delete.

LEdgeMap*

pointer to the newly created object

GRAPH_NULL_POINTER if inGraph is NULL
Delete LEdgeMap** ThisA Releases object *ThisA. *ThisA is set to NULL. void OBJECT_NULL_POINTER if ThisA or *ThisA are NULL
LEdgeMap_EdgeExists
LEdgeMap*     This
LGraph_TNode* inSrc
LGraph_TNode* inDst
Returns TRUE if there's an edge between inSrc and inDst, FALSE otherwise. Bool OBJECT_NULL_POINTER if This is NULL
NODE_NULL_POINTER if inSrc or inDst are NULL
LEdgeMap_GetEdge
LEdgeMap*     This
LGraph_TNode* inSrc
LGraph_TNode* inDst
Returns the edge between inSrc and inDst, NULL if there's no edge. LGraph_TEdge* OBJECT_NULL_POINTER if This is NULL
NODE_NULL_POINTER if inSrc or inDst are NULL
LEdgeMap_GetUsedMem LEdgeMap* This Returns the total memory usage of object This. ui4 OBJECT_NULL_POINTER if This is NULL


Revision history