graph_v1.h

Go to the documentation of this file.

/* LIBDGL -- a Directed Graph Library implementation
 * SPDX-FileCopyrightText: 2002 Roberto Micarelli
 * SPDX-FileCopyrightText: GRASS Development Team
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
/*
 * best view tabstop=4
 */
 
#ifndef _DGL_dglGraph_s_V1_H_
#define _DGL_dglGraph_s_V1_H_
 
#ifdef DGL_STATS
#include <time.h>
#endif
 
/*
 * Node macros - addresses in a flat node
 */
#define DGL_IN_NODEID_v1      0
#define DGL_IN_STATUS_v1      1
#define DGL_IN_TAIL_OFFSET_v1 2
#define DGL_IN_ATTR_v1        3
#define DGL_IN_SIZE_v1        DGL_IN_ATTR_v1
 
#define DGL_NODE_SIZEOF_v1(nattr) \
    (sizeof(dglInt32_t) * DGL_IN_SIZE_v1 + (nattr))
#define DGL_NODE_WSIZE_v1(nattr) \
    (DGL_NODE_SIZEOF_v1(nattr) / sizeof(dglInt32_t))
#define DGL_NODE_ALLOC_v1(nattr)      (malloc(DGL_NODE_SIZEOF_v1(nattr)))
 
#define DGL_NODE_ID_v1(p)             ((p)[DGL_IN_NODEID_v1])
#define DGL_NODE_STATUS_v1(p)         ((p)[DGL_IN_STATUS_v1])
#define DGL_NODE_EDGESET_OFFSET_v1(p) ((p)[DGL_IN_TAIL_OFFSET_v1])
#define DGL_NODE_ATTR_PTR_v1(p)       ((p) + DGL_IN_ATTR_v1)
 
/*
 * Edgeset macros - addresses in a flat edge-area
 */
#define DGL_ILA_TOCNT_v1              0
#define DGL_ILA_SIZE_v1               1
#define DGL_ILA_TOARR_v1              DGL_ILA_SIZE_v1
 
#define DGL_EDGESET_SIZEOF_v1(C, lattr) \
    (sizeof(dglInt32_t) * (DGL_ILA_SIZE_v1) + DGL_EDGE_SIZEOF_v1(lattr) * (C))
#define DGL_EDGESET_WSIZE_v1(C, lattr) \
    (DGL_EDGESET_SIZEOF_v1(C, lattr) / sizeof(dglInt32_t))
#define DGL_EDGESET_ALLOC_v1(C, lattr) (malloc(DGL_EDGESET_SIZEOF_v1(C, lattr)))
#define DGL_EDGESET_REALLOC_v1(P, C, lattr) \
    (realloc(P, DGL_EDGESET_SIZEOF_v1(C, lattr)))
 
#define DGL_EDGESET_EDGECOUNT_v1(p)     ((p)[DGL_ILA_TOCNT_v1])
#define DGL_EDGESET_EDGEARRAY_PTR_v1(p) ((p) + DGL_ILA_TOARR_v1)
#define DGL_EDGESET_EDGE_PTR_v1(p, i, C) \
    (((p) + DGL_ILA_TOARR_v1) + (i) * DGL_EDGE_WSIZE_v1(C))
 
/*
 * Edge macros - addresses in a flat edge
 */
#define DGL_IL_HEAD_OFFSET_v1 0
#define DGL_IL_TAIL_OFFSET_v1 1
#define DGL_IL_COST_v1        2
#define DGL_IL_ID_v1          3
#define DGL_IL_ATTR_v1        4
#define DGL_IL_SIZE_v1        DGL_IL_ATTR_v1
 
#define DGL_EDGE_SIZEOF_v1(lattr) \
    (sizeof(dglInt32_t) * DGL_IL_SIZE_v1 + (lattr))
#define DGL_EDGE_WSIZE_v1(lattr) \
    (DGL_EDGE_SIZEOF_v1(lattr) / sizeof(dglInt32_t))
#define DGL_EDGE_ALLOC_v1(lattr)       (malloc(DGL_EDGE_SIZEOF_v1(lattr)))
 
#define DGL_EDGE_HEADNODE_OFFSET_v1(p) ((p)[DGL_IL_HEAD_OFFSET_v1])
#define DGL_EDGE_TAILNODE_OFFSET_v1(p) ((p)[DGL_IL_TAIL_OFFSET_v1])
#define DGL_EDGE_COST_v1(p)            ((p)[DGL_IL_COST_v1])
#define DGL_EDGE_ID_v1(p)              ((p)[DGL_IL_ID_v1])
#define DGL_EDGE_ATTR_PTR_v1(p)        ((p) + DGL_IL_ATTR_v1)
#define DGL_EDGE_HEADNODE_ID_v1(pgrp, pl)                                      \
    ((pgrp->Flags & 1)                                                         \
         ? DGL_NODE_ID_v1(pgrp->pNodeBuffer + DGL_EDGE_HEADNODE_OFFSET_v1(pl)) \
         : DGL_EDGE_HEADNODE_OFFSET_v1(pl))
#define DGL_EDGE_TAILNODE_ID_v1(pgrp, pl)                                      \
    ((pgrp->Flags & 1)                                                         \
         ? DGL_NODE_ID_v1(pgrp->pNodeBuffer + DGL_EDGE_TAILNODE_OFFSET_v1(pl)) \
         : DGL_EDGE_TAILNODE_OFFSET_v1(pl))
 
/*
 * Scan a node buffer
 */
#define DGL_FOREACH_NODE_v1(pgrp, pn)                                      \
    for ((pn) = (dglInt32_t *)(pgrp)->pNodeBuffer;                         \
         (pgrp)->pNodeBuffer &&                                            \
         (pn) < (dglInt32_t *)((pgrp)->pNodeBuffer + (pgrp)->iNodeBuffer); \
         (pn) += DGL_NODE_WSIZE_v1((pgrp)->NodeAttrSize))
/*
 * Scan a edgeset
 */
#define DGL_FOREACH_EDGE_v1(pgrp, pla, pl)                        \
    for ((pl) = DGL_EDGESET_EDGEARRAY_PTR_v1(pla);                \
         (pl) < (pla) + DGL_EDGE_WSIZE_v1((pgrp)->EdgeAttrSize) * \
                            DGL_EDGESET_EDGECOUNT_v1(pla);        \
         (pl) += DGL_EDGE_WSIZE_v1((pgrp)->EdgeAttrSize))
/*
 * Node Buffer Utilities
 */
#define DGL_NODEBUFFER_SHIFT_v1(pgrp, o) \
    ((dglInt32_t *)((pgrp)->pNodeBuffer + (o)))
#define DGL_NODEBUFFER_OFFSET_v1(pgrp, p) \
    ((dglInt32_t)((dglByte_t *)p - (dglByte_t *)(pgrp)->pNodeBuffer))
 
/*
 * Edge Buffer Utilities
 */
#define DGL_EDGEBUFFER_SHIFT_v1(pgrp, o) \
    ((dglInt32_t *)((pgrp)->pEdgeBuffer + (o)))
#define DGL_EDGEBUFFER_OFFSET_v1(pgrp, pl) \
    ((dglInt32_t)((dglByte_t *)pl - (dglByte_t *)(pgrp)->pEdgeBuffer))
 
int dgl_add_edge_V1(dglGraph_s *pgraph, dglInt32_t nHead, dglInt32_t nTail,
                    dglInt32_t nCost, dglInt32_t nEdge, void *pvHeadAttr,
                    void *pvTailAttr, void *pvEdgeAttr, dglInt32_t nFlags);
 
int dgl_unflatten_V1(dglGraph_s *pgraph);
int dgl_flatten_V1(dglGraph_s *pgraph);
int dgl_initialize_V1(dglGraph_s *pgraph);
int dgl_release_V1(dglGraph_s *pgraph);
int dgl_write_V1(dglGraph_s *pgraph, int fd);
int dgl_read_V1(dglGraph_s *pgraph, int fd);
 
int dgl_sp_cache_initialize_V1(dglGraph_s *pgraph, dglSPCache_s *pCache,
                               dglInt32_t nStart);
void dgl_sp_cache_release_V1(dglGraph_s *pgraph, dglSPCache_s *pCache);
 
int dgl_dijkstra_V1_TREE(dglGraph_s *pgraph, dglSPReport_s **ppReport,
                         dglInt32_t *pDistance, dglInt32_t nStart,
                         dglInt32_t nDestination, dglSPClip_fn fnClip,
                         void *pvClipArg, dglSPCache_s *pCache);
int dgl_dijkstra_V1_FLAT(dglGraph_s *pgraph, dglSPReport_s **ppReport,
                         dglInt32_t *pDistance, dglInt32_t nStart,
                         dglInt32_t nDestination, dglSPClip_fn fnClip,
                         void *pvClipArg, dglSPCache_s *pCache);
int dgl_dijkstra_V1(dglGraph_s *pgraph, dglSPReport_s **ppReport,
                    dglInt32_t *pDistance, dglInt32_t nStart,
                    dglInt32_t nDestination, dglSPClip_fn fnClip,
                    void *pvClipArg, dglSPCache_s *pCache);
 
int dgl_span_depthfirst_spanning_V1_TREE(dglGraph_s *pgraphIn,
                                         dglGraph_s *pgraphOut,
                                         dglInt32_t nVertex, void *pvVisited,
                                         dglSpanClip_fn fnClip,
                                         void *pvClipArg);
int dgl_span_depthfirst_spanning_V1_FLAT(dglGraph_s *pgraphIn,
                                         dglGraph_s *pgraphOut,
                                         dglInt32_t nVertex, void *pvVisited,
                                         dglSpanClip_fn fnClip,
                                         void *pvClipArg);
int dgl_depthfirst_spanning_V1(dglGraph_s *pgraphIn, dglGraph_s *pgraphOut,
                               dglInt32_t nVertex, void *pvVisited,
                               dglSpanClip_fn fnClip, void *pvClipArg);
 
int dgl_span_minimum_spanning_V1_TREE(dglGraph_s *pgraphIn,
                                      dglGraph_s *pgraphOut, dglInt32_t nVertex,
                                      dglSpanClip_fn fnClip, void *pvClipArg);
int dgl_span_minimum_spanning_V1_FLAT(dglGraph_s *pgraphIn,
                                      dglGraph_s *pgraphOut, dglInt32_t nVertex,
                                      dglSpanClip_fn fnClip, void *pvClipArg);
int dgl_minimum_spanning_V1(dglGraph_s *pgraphIn, dglGraph_s *pgraphOut,
                            dglInt32_t nVertex, dglSpanClip_fn fnClip,
                            void *pvClipArg);
 
int dgl_add_node_V1(dglGraph_s *pgraph, dglInt32_t nId, void *pvNodeAttr,
                    dglInt32_t nFlags);
int dgl_del_node_V1(dglGraph_s *pgraph, dglInt32_t nId);
dglInt32_t *dgl_get_node_V1(dglGraph_s *pgraph, dglInt32_t nId);
 
dglInt32_t *dgl_get_edge_V1(dglGraph_s *pgraph, dglInt32_t nId);
int dgl_del_edge_V1(dglGraph_s *pgraph, dglInt32_t nId);
 
dglInt32_t *dgl_getnode_outedgeset_V1(dglGraph_s *pgraph, dglInt32_t *pnode);
 
/*
 * Node Traversing
 */
int dgl_node_t_initialize_V1(dglGraph_s *pGraph, dglNodeTraverser_s *pT);
void dgl_node_t_release_V1(dglNodeTraverser_s *pT);
dglInt32_t *dgl_node_t_first_V1(dglNodeTraverser_s *pT);
dglInt32_t *dgl_node_t_next_V1(dglNodeTraverser_s *pT);
dglInt32_t *dgl_node_t_find_V1(dglNodeTraverser_s *pT, dglInt32_t nId);
 
/*
 * Edgeset Traversing
 */
int dgl_edgeset_t_initialize_V1(dglGraph_s *pGraph,
                                dglEdgesetTraverser_s *pTraverser,
                                dglInt32_t *pnEdgeset);
void dgl_edgeset_t_release_V1(dglEdgesetTraverser_s *pTraverser);
dglInt32_t *dgl_edgeset_t_first_V1(dglEdgesetTraverser_s *pTraverser);
dglInt32_t *dgl_edgeset_t_next_V1(dglEdgesetTraverser_s *pTraverser);
 
int dgl_edge_t_initialize_V1(dglGraph_s *pGraph, dglEdgeTraverser_s *pTraverser,
                             dglEdgePrioritizer_s *pEP);
void dgl_edge_t_release_V1(dglEdgeTraverser_s *pTraverser);
dglInt32_t *dgl_edge_t_first_V1(dglEdgeTraverser_s *pT);
dglInt32_t *dgl_edge_t_next_V1(dglEdgeTraverser_s *pT);
 
#endif