graph.h

Go to the documentation of this file.

/*
 *       _____
 * ANSI / ___/
 *     / /__  
 *     \___/  
 *
 * Filename: graph.h
 * Author  : Kyle Loudon/Dan Levin
 * Date    : Thu Jan 15 09:25:57 2015
 * Version : 0.51
 * ---
 * Description: A generic graph ADT - written in ANSI C. 
 * 
 * Date   Revision message
 * 150331 This code ready for version 0.51
 *
 */
#ifndef _GRAPH_H_
#define _GRAPH_H_

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <malloc.h>
#include <assert.h>

#include "slist.h"
#include "set.h"
#include "utils.h"

#ifdef __cplusplus
extern "C" {
#endif

  typedef enum VertexColor_ {white, gray, black} VertexColor;

  typedef struct Vertex_ *Vertex;
  typedef struct Graph_ *Graph;

  typedef SlistNode VertexNode;
  typedef SlistNode EdgeNode;

  /* FUNCTION DECLARATIONS/PUBLIC INTERFACE */
  /* --- Maintenance functions --- */
  Graph GRAPHinit(int (*match)(const void *key1, const void *key2),
                  void (*destroy)(void *data));

  void GRAPHdestroy(Graph graph);

  /* --- Data manipulation functions --- */
  int GRAPHinsvertex(Graph graph, const void *vtxdata);

  int GRAPHinsedge(Graph graph, const void *vtxdata, const void *adjdata);

  int GRAPHremvertex(Graph graph, void **vtxdata);

  int GRAPHremedge(Graph graph, void *vtxdata, void **edgedata);

  /* --- Getter functions --- */
  VertexNode GRAPHgetvertexhead(Graph graph);

  EdgeNode GRAPHgetedgehead(VertexNode vtxnode);

  VertexNode GRAPHgetvertexnext(VertexNode vtxnode);

  EdgeNode GRAPHgetedgenext(EdgeNode enode); 

  void *GRAPHgetvertexdata(VertexNode vtxnode);

  void *GRAPHgetedgedata(EdgeNode enode);

  int GRAPHgetedgecount(VertexNode vtxnode);

  int GRAPHvcount(Graph graph);

  int GRAPHecount(Graph graph);

  /* --- Traversal functions --- */
  void GRAPHprint(Graph graph, void (*vtxcallback)(const void *data),
                  void (*edgecallback)(const void *data));

  void GRAPHtraverse(Graph graph, void (*vtxcallback)(const void *data), void (*edgecallback)(const void *data));

  /* --- Search functions --- */
  VertexNode GRAPHfindvertex(const Graph graph, const void *vtxdata);

  EdgeNode GRAPHfindedge(const Graph graph, const void *vtxdata, const void *edgedata);

  /* --- Miscellaneous functions --- */
  int GRAPHis_adjacent(const Graph graph, const void *vtxdata, const void *edgedata); 

  int GRAPHis_isolated(const Graph graph, const void *vtxdata);

#ifdef __cplusplus
}
#endif 

#endif /* _GRAPH_H_ */