IMP logo
IMP Reference Guide  develop.d4e9f3251e,2024/04/26
The Integrative Modeling Platform
graph_macros.h File Reference

Helper macros for handling graphs. More...

#include <IMP/kernel_config.h>
#include <boost/graph/adjacency_list.hpp>
#include "file.h"
#include "internal/base_graph_utility.h"
#include <boost/unordered_map.hpp>
#include <boost/version.hpp>
+ Include dependency graph for graph_macros.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define IMP_GRAPH(Name, directionality, VertexData, EdgeData, ShowVertex)
 Define a graph object in IMP. More...
 
#define IMP_WEIGHTED_GRAPH(Name, directionality, VertexData, ShowVertex)
 Define a graph object in IMP. More...
 

Detailed Description

Helper macros for handling graphs.

Copyright 2007-2022 IMP Inventors. All rights reserved.

Definition in file graph_macros.h.

Macro Definition Documentation

#define IMP_GRAPH (   Name,
  directionality,
  VertexData,
  EdgeData,
  ShowVertex 
)

Define a graph object in IMP.

The docs for the graph should appear before the macro invocation. Directionality should be one of

  • bidirectional
  • directed
  • undirected

ShowVertex should take the VertexData as a variable named vertex and write to a stream out.

Definition at line 29 of file graph_macros.h.

#define IMP_WEIGHTED_GRAPH (   Name,
  directionality,
  VertexData,
  ShowVertex 
)
Value:
/** See \ref graphs "Graphs" for more information.*/ \
IMP_GRAPH(Name, directionality, VertexData, double, ShowVertex)
#define IMP_GRAPH(Name, directionality, VertexData, EdgeData, ShowVertex)
Define a graph object in IMP.
Definition: graph_macros.h:29

Define a graph object in IMP.

See IMP_GRAPH() for more info. Edges have a floating point weight.

Definition at line 85 of file graph_macros.h.