boost.graph._graph
index
/u/dgregor/lib/python/boost/graph/_graph.so

 
Classes
       
Boost.Python.instance(__builtin__.object)
AdjacencyIterator
Digraph
Edge
EdgeIndexMap
EdgeIterator
EdgecolorMap
EdgeedgeMap
EdgefloatMap
EdgeintegerMap
EdgeobjectMap
Edgepoint2dMap
Edgepoint3dMap
EdgestringMap
EdgevertexMap
Graph
InEdgeIterator
OutEdgeIterator
ValueIterator
Vertex
VertexIndexMap
VertexIterator
VertexcolorMap
VertexedgeMap
VertexfloatMap
VertexintegerMap
VertexobjectMap
Vertexpoint2dMap
Vertexpoint3dMap
VertexstringMap
VertexvertexMap
graph_exception
bad_parallel_edge
directed_graph_error
undirected_graph_error

 
class AdjacencyIterator(Boost.Python.instance)
    An iterator over the vertices adjacent to a given vertex.
 
 
Method resolution order:
AdjacencyIterator
Boost.Python.instance
__builtin__.object

Methods defined here:
__iter__(...)
__len__(...)
next(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516550>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Digraph(Boost.Python.instance)
    A directed graph data structure.
 
A directed graph (also called a network) is a data structure that
contains a set of vertices and relationships between pairs of
vertices, called edges. Given two vertices u and v, an edge (u, v)
indicates a relationship between them. What vertices and edges mean
depends on how the data structure is used. For instance, vertices may
be tasks and edges might mean that the source of the edge cannot be
completed until the target task has been completed. The ordering of
vertices in an edge is important For graphs where the edge direction
does not matter, use the Graph class.
 
Vertices and edges provide the structure of the graph, but most of the
interesting domain-specific information of graphs is actually stored on
the vertices and edges of the graph. For this reason, one can create
properties via the vertex_property_map and edge_property_map methods
to represent, for instance, the functionality of a vertex that represents
a task or the method of transmission for a dependency between tasks.
 
Complete C++ documentation for the adjacency list representation:
  http://www.boost.org/libs/graph/doc/adjacency_list.html
 
 
Method resolution order:
Digraph
Boost.Python.instance
__builtin__.object

Methods defined here:
__getstate__(...)
__init__(...)
__init__(self, edges = list()) -> Digraph
 
Constructs a new graph from a list of edges. The edges argument
should be a sequence of tuples, where each tuple contains the source and
target vertices of an edge. The sources and targets can be any type,
so long as that type can be ordered with < and compared with ==, e.g.,
strings, integers, or floating-point-numbers.
__reduce__ = (...)
__setstate__(...)
add_edge(...)
add_edge(self, u, v) -> Edge
 
Add an edge between two vertices.
Self-loops and parallel edges are permitted.
add_vertex(...)
add_vertex(self) -> Vertex
 
Adds a new vertex to the graph.
adjacent_vertices(...)
adjacent_vertices(self, u) -> AdjacencyIterator
 
Enumerate vertices adjacent to u.
clear_vertex(...)
clear_vertex(self, v)
 
Removes all outgoing and incoming edges from v.
convert_property_map(...)
convert_property_map(self, source_map, type) -> object
 
Converts the property map source_map into another property map
with a different element type and returns that new property map.
The old property map is unchanged. If a conversion is not supported,
this routine will return None.
 
Parameters:
  source_map  A property map for the vertices or edges of the
              given graph.
 
  type        The element type of the resulting property map.
              This may be any type supported by vertex_property_map
              or edge_property_map.
edge(...)
edge(self, u, v) -> Edge
 
Returns an edge (u, v) if one exists, otherwise None.
edge_property_map(...)
edge_property_map(self, type) -> EdgePropertyMap
 
Creates a new property map that maps from edges in the graph to
values of the given type. The type parameter may be any one of:
   integer
   float
   vertex
   edge
   string
   point2d
   point3d
   object
   color
in_degree(...)
in_degree(self, u) -> int
 
Returns the number of incoming edges to u.
in_edges(...)
in_edges(self, u) ->InEdgeIterator
 
Enumerate edges incoming to u.
is_directed(...)
is_directed(self) -> bool
 
Whether the graph is directed or not.
num_edges(...)
num_edges(self) -> int
 
Return the number of edges in the graph.
num_vertices(...)
num_vertices(self) -> int
 
Return the number of vertices in the graph.
out_degree(...)
out_degree(self, u) -> int
 
Returns the number of outgoing edges from u.
out_edges(...)
out_edges(self, u) ->OutEdgeIterator
 
Enumerate edges outgoing from u.
remove_edge(...)
remove_edge(self, e)
 
Removes edge e from the graph.
remove_vertex(...)
remove_vertex(self, v)
 
Removes a vertex from the graph.
Vertex v must have no incoming or outgoing edges. If you aren't sure,
call clear_vertex first.
source(...)
source(self, e) -> Vertex
 
Returns the source of edge e.
target(...)
target(self, e) -> Vertex
 
Returns the target of edge e.
vertex_property_map(...)
vertex_property_map(self, type) -> VertexPropertyMap
 
Creates a new property map that maps from vertices in the graph to
values of the given type. The type parameter may be any one of:
   integer
   float
   vertex
   edge
   string
   point2d
   point3d
   object
   color
write_graphviz(...)
write_graphviz(self, filename)
 
Writes the graph into the file filename (overwriting the file if it 
already exists) using the GraphViz DOT format.
 
See also:
  read_graphviz
 
The GraphViz DOT language is described here:
  http://www.graphviz.org/doc/info/lang.html
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/write-graphviz.html

Static methods defined here:
erdos_renyi_graph(...)
erdos_renyi_graph(num_vertices, probability, allow_self_loops = False,
                  random_seed = 1) -> Digraph
 
Constructs a new Erdos-Renyi random graph with num_vertices vertices and
a uniform probability of having an edge (u, v) in the graph for any
vertices u and v. Expect a graph with probability*num_vertices^2 edges.
 
Parameters:
  num_vertices      The number of vertices in the graph. 
  probability       The probability of having an edge (u, v).
  allow_self_loops  Whether self-loops (u, u) will be generated.
  random_seed       Nonzero seed value for the random number generator.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/erdos_renyi_generator.html
plod_graph(...)
plod_graph(num_vertices, alpha, beta, allow_self_loops = False, 
           random_seed = 1) -> Digraph
 
Constructs a new power law graph with num_vertices vertices. The number
of connections to a given vertex is beta*x^(-alpha), where alpha and
beta are parameters to the algorithm and x is a random variable between
0 and num_vertices - 1.
 
Parameters:
  num_vertices      The number of vertices in the graph.
  alpha             The exponential fall-off in the degree distribution.
  beta              Controls how many edges will occur in the graph.
  allow_self_loops  Whether self-loops (u, u) will be generated.
  random_seed       Nonzero seed value for the random number generator.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/plod_generator.html
read_graphviz(...)
read_graphviz(filename, node_id = 'node_id') -> Digraph
 
Loads a graph written in GraphViz DOT format from the file filename.
Parameters:
  filename  The name of the file to load.
  node_id   The name given to the property map that will store the
            identifier associated with each vertex in the DOT file.
 
Exceptions:
  directed_graph_error    Thrown if one tries to read a directed graph
                          into the Graph class.
  undirected_graph_error  Thrown if one tries to read an undirected
                          graph into the Digraph class.
 
See also:
  write_graphviz
 
The GraphViz DOT language is described here:
  http://www.graphviz.org/doc/info/lang.html
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/read_graphviz.html
small_world_graph(...)
small_world_graph(num_vertices, num_neighbors, rewire_probability,
           allow_self_loops = False, random_seed = 1) -> Digraph
 
Constructs a new small-world graph with num_vertices vertices, each
adjacent to its num_neighbors closest neighbors (assume that the 
vertcices were arranged in a circle). With probability
rewire_probability, an edge will be rewired randomly.
 
Parameters:
  num_vertices        The number of vertices in the graph.
  num_neighbors       The number of neighbors each vertex starts with.
  rewire_probability  Probability of rewiring any given edge.
  allow_self_loops    Whether self-loops (u, u) will be generated.
  random_seed         Nonzero seed for the random number generator.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/small_world_generator.html

Properties defined here:
edge_properties
A Python dictionary mapping from edge property names to
property maps. These properties are "attached" to the graph
and will be pickled or serialized along with the graph.
get = (...)
edges
edges(self) -> VertexIterator
 
Enumerate the edges in the graph.
get = (...)
vertex_properties
A Python dictionary mapping from vertex property names to
property maps. These properties are "attached" to the graph
and will be pickled or serialized along with the graph.
get = (...)
vertices
vertices(self) -> VertexIterator
 
Enumerate the vertices in the graph.
get = (...)

Data and other attributes defined here:
__instance_size__ = 68
__safe_for_unpickling__ = True

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516b90>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Edge(Boost.Python.instance)
    
Method resolution order:
Edge
Boost.Python.instance
__builtin__.object

Methods defined here:
__eq__(...)
__getstate__(...)
__init__(...)
__ne__(...)
__reduce__ = (...)
__setstate__(...)

Data and other attributes defined here:
__instance_size__ = 20
__safe_for_unpickling__ = True

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516830>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgeIndexMap(Boost.Python.instance)
    
Method resolution order:
EdgeIndexMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516530>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgeIterator(Boost.Python.instance)
    An iterator that enumerates the edges in a graph
 
 
Method resolution order:
EdgeIterator
Boost.Python.instance
__builtin__.object

Methods defined here:
__iter__(...)
__len__(...)
next(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5162d0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgecolorMap(Boost.Python.instance)
    
Method resolution order:
EdgecolorMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516390>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgeedgeMap(Boost.Python.instance)
    
Method resolution order:
EdgeedgeMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5162d0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgefloatMap(Boost.Python.instance)
    
Method resolution order:
EdgefloatMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516ad0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgeintegerMap(Boost.Python.instance)
    
Method resolution order:
EdgeintegerMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5162b0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgeobjectMap(Boost.Python.instance)
    
Method resolution order:
EdgeobjectMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516830>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Edgepoint2dMap(Boost.Python.instance)
    
Method resolution order:
Edgepoint2dMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516350>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Edgepoint3dMap(Boost.Python.instance)
    
Method resolution order:
Edgepoint3dMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516570>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgestringMap(Boost.Python.instance)
    
Method resolution order:
EdgestringMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516390>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class EdgevertexMap(Boost.Python.instance)
    
Method resolution order:
EdgevertexMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5162d0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Graph(Boost.Python.instance)
    An undirected graph data structure.
 
An undirected graph (also called a network) is a data structure that
contains a set of vertices and relationships between pairs of vertices,
called edges. Given two vertices u and v, an edge (u, v) indicates a
relationship between them. What vertices and edges mean depends on how
the data structure is used. For instance, vertices may be cities and
edges are the roads that connect them. Or, edges may represent direct
network connections between two routers or two computers. Since the
graph is undirected, the order of the vertices in the edge does not
matter: the relationship is mutual. For graphs where the edge direction
does matter, use the Digraph class.
 
Vertices and edges provide the structure of the graph, but most of the
interesting domain-specific information of graphs is actually stored on
the vertices and edges of the graph. For this reason, one can create
properties via the vertex_property_map and edge_property_map methods
to represent, for instance, the IP address of a vertex that represents
a router or the length of a road connecting two cities.
 
Complete C++ documentation for the adjacency list representation:
  http://www.boost.org/libs/graph/doc/adjacency_list.html
 
 
Method resolution order:
Graph
Boost.Python.instance
__builtin__.object

Methods defined here:
__getstate__(...)
__init__(...)
__init__(self, edges = list()) -> Graph
 
Constructs a new graph from a list of edges. The edges argument
should be a sequence of tuples, where each tuple contains the source and
target vertices of an edge. The sources and targets can be any type,
so long as that type can be ordered with < and compared with ==, e.g.,
strings, integers, or floating-point-numbers.
__reduce__ = (...)
__setstate__(...)
add_edge(...)
add_edge(self, u, v) -> Edge
 
Add an edge between two vertices.
Self-loops and parallel edges are permitted.
add_vertex(...)
add_vertex(self) -> Vertex
 
Adds a new vertex to the graph.
adjacent_vertices(...)
adjacent_vertices(self, u) -> AdjacencyIterator
 
Enumerate vertices adjacent to u.
clear_vertex(...)
clear_vertex(self, v)
 
Removes all outgoing and incoming edges from v.
convert_property_map(...)
convert_property_map(self, source_map, type) -> object
 
Converts the property map source_map into another property map
with a different element type and returns that new property map.
The old property map is unchanged. If a conversion is not supported,
this routine will return None.
 
Parameters:
  source_map  A property map for the vertices or edges of the
              given graph.
 
  type        The element type of the resulting property map.
              This may be any type supported by vertex_property_map
              or edge_property_map.
edge(...)
edge(self, u, v) -> Edge
 
Returns an edge (u, v) if one exists, otherwise None.
edge_property_map(...)
edge_property_map(self, type) -> EdgePropertyMap
 
Creates a new property map that maps from edges in the graph to
values of the given type. The type parameter may be any one of:
   integer
   float
   vertex
   edge
   string
   point2d
   point3d
   object
   color
in_degree(...)
in_degree(self, u) -> int
 
Returns the number of incoming edges to u.
in_edges(...)
in_edges(self, u) ->InEdgeIterator
 
Enumerate edges incoming to u.
is_directed(...)
is_directed(self) -> bool
 
Whether the graph is directed or not.
num_edges(...)
num_edges(self) -> int
 
Return the number of edges in the graph.
num_vertices(...)
num_vertices(self) -> int
 
Return the number of vertices in the graph.
out_degree(...)
out_degree(self, u) -> int
 
Returns the number of outgoing edges from u.
out_edges(...)
out_edges(self, u) ->OutEdgeIterator
 
Enumerate edges outgoing from u.
remove_edge(...)
remove_edge(self, e)
 
Removes edge e from the graph.
remove_vertex(...)
remove_vertex(self, v)
 
Removes a vertex from the graph.
Vertex v must have no incoming or outgoing edges. If you aren't sure,
call clear_vertex first.
source(...)
source(self, e) -> Vertex
 
Returns the source of edge e.
target(...)
target(self, e) -> Vertex
 
Returns the target of edge e.
vertex_property_map(...)
vertex_property_map(self, type) -> VertexPropertyMap
 
Creates a new property map that maps from vertices in the graph to
values of the given type. The type parameter may be any one of:
   integer
   float
   vertex
   edge
   string
   point2d
   point3d
   object
   color
write_graphviz(...)
write_graphviz(self, filename)
 
Writes the graph into the file filename (overwriting the file if it 
already exists) using the GraphViz DOT format.
 
See also:
  read_graphviz
 
The GraphViz DOT language is described here:
  http://www.graphviz.org/doc/info/lang.html
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/write-graphviz.html

Static methods defined here:
erdos_renyi_graph(...)
erdos_renyi_graph(num_vertices, probability, allow_self_loops = False,
                  random_seed = 1) -> Graph
 
Constructs a new Erdos-Renyi random graph with num_vertices vertices and
a uniform probability of having an edge (u, v) in the graph for any
vertices u and v. Expect a graph with probability*num_vertices^2 edges.
 
Parameters:
  num_vertices      The number of vertices in the graph. 
  probability       The probability of having an edge (u, v).
  allow_self_loops  Whether self-loops (u, u) will be generated.
  random_seed       Nonzero seed value for the random number generator.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/erdos_renyi_generator.html
plod_graph(...)
plod_graph(num_vertices, alpha, beta, allow_self_loops = False, 
           random_seed = 1) -> Graph
 
Constructs a new power law graph with num_vertices vertices. The number
of connections to a given vertex is beta*x^(-alpha), where alpha and
beta are parameters to the algorithm and x is a random variable between
0 and num_vertices - 1.
 
Parameters:
  num_vertices      The number of vertices in the graph.
  alpha             The exponential fall-off in the degree distribution.
  beta              Controls how many edges will occur in the graph.
  allow_self_loops  Whether self-loops (u, u) will be generated.
  random_seed       Nonzero seed value for the random number generator.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/plod_generator.html
read_graphviz(...)
read_graphviz(filename, node_id = 'node_id') -> Graph
 
Loads a graph written in GraphViz DOT format from the file filename.
Parameters:
  filename  The name of the file to load.
  node_id   The name given to the property map that will store the
            identifier associated with each vertex in the DOT file.
 
Exceptions:
  directed_graph_error    Thrown if one tries to read a directed graph
                          into the Graph class.
  undirected_graph_error  Thrown if one tries to read an undirected
                          graph into the Digraph class.
 
See also:
  write_graphviz
 
The GraphViz DOT language is described here:
  http://www.graphviz.org/doc/info/lang.html
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/read_graphviz.html
small_world_graph(...)
small_world_graph(num_vertices, num_neighbors, rewire_probability,
           allow_self_loops = False, random_seed = 1) -> Graph
 
Constructs a new small-world graph with num_vertices vertices, each
adjacent to its num_neighbors closest neighbors (assume that the 
vertcices were arranged in a circle). With probability
rewire_probability, an edge will be rewired randomly.
 
Parameters:
  num_vertices        The number of vertices in the graph.
  num_neighbors       The number of neighbors each vertex starts with.
  rewire_probability  Probability of rewiring any given edge.
  allow_self_loops    Whether self-loops (u, u) will be generated.
  random_seed         Nonzero seed for the random number generator.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/small_world_generator.html

Properties defined here:
edge_properties
A Python dictionary mapping from edge property names to
property maps. These properties are "attached" to the graph
and will be pickled or serialized along with the graph.
get = (...)
edges
edges(self) -> VertexIterator
 
Enumerate the edges in the graph.
get = (...)
vertex_properties
A Python dictionary mapping from vertex property names to
property maps. These properties are "attached" to the graph
and will be pickled or serialized along with the graph.
get = (...)
vertices
vertices(self) -> VertexIterator
 
Enumerate the vertices in the graph.
get = (...)

Data and other attributes defined here:
__instance_size__ = 68
__safe_for_unpickling__ = True

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516db0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class InEdgeIterator(Boost.Python.instance)
    An iterator that enumerates edges incoming to a vertex.
 
 
Method resolution order:
InEdgeIterator
Boost.Python.instance
__builtin__.object

Methods defined here:
__iter__(...)
__len__(...)
next(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516690>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class OutEdgeIterator(Boost.Python.instance)
    An iterator that enumerates edges outgoing from a vertex.
 
 
Method resolution order:
OutEdgeIterator
Boost.Python.instance
__builtin__.object

Methods defined here:
__iter__(...)
__len__(...)
next(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5169f0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class ValueIterator(Boost.Python.instance)
    
Method resolution order:
ValueIterator
Boost.Python.instance
__builtin__.object

Methods defined here:
__iter__(...)
__len__(...)
next(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5164d0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Vertex(Boost.Python.instance)
    
Method resolution order:
Vertex
Boost.Python.instance
__builtin__.object

Methods defined here:
__eq__(...)
__getstate__(...)
__init__(...)
__ne__(...)
__reduce__ = (...)
__setstate__(...)

Data and other attributes defined here:
__instance_size__ = 12
__safe_for_unpickling__ = True

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516c10>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexIndexMap(Boost.Python.instance)
    
Method resolution order:
VertexIndexMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5169b0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexIterator(Boost.Python.instance)
    An iterator that enumerates the vertices in a graph
 
 
Method resolution order:
VertexIterator
Boost.Python.instance
__builtin__.object

Methods defined here:
__iter__(...)
__len__(...)
next(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516830>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexcolorMap(Boost.Python.instance)
    
Method resolution order:
VertexcolorMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516ad0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexedgeMap(Boost.Python.instance)
    
Method resolution order:
VertexedgeMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516830>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexfloatMap(Boost.Python.instance)
    
Method resolution order:
VertexfloatMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516470>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexintegerMap(Boost.Python.instance)
    
Method resolution order:
VertexintegerMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516390>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexobjectMap(Boost.Python.instance)
    
Method resolution order:
VertexobjectMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516c10>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Vertexpoint2dMap(Boost.Python.instance)
    
Method resolution order:
Vertexpoint2dMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516370>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class Vertexpoint3dMap(Boost.Python.instance)
    
Method resolution order:
Vertexpoint3dMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5163f0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexstringMap(Boost.Python.instance)
    
Method resolution order:
VertexstringMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516ad0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class VertexvertexMap(Boost.Python.instance)
    
Method resolution order:
VertexvertexMap
Boost.Python.instance
__builtin__.object

Methods defined here:
__getitem__(...)
__iter__(...)
__len__(...)
__setitem__(...)

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516830>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class bad_parallel_edge(graph_exception)
    
Method resolution order:
bad_parallel_edge
graph_exception
Boost.Python.instance
__builtin__.object

Methods defined here:
__init__(...)

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516390>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class directed_graph_error(graph_exception)
    
Method resolution order:
directed_graph_error
graph_exception
Boost.Python.instance
__builtin__.object

Methods defined here:
__init__(...)

Data and other attributes defined here:
__instance_size__ = 12

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x516390>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class graph_exception(Boost.Python.instance)
    
Method resolution order:
graph_exception
Boost.Python.instance
__builtin__.object

Data and other attributes defined here:
__init__ = <built-in function __init__>
Raises an exception
This class cannot be instantiated from Python

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5164d0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
class undirected_graph_error(graph_exception)
    
Method resolution order:
undirected_graph_error
graph_exception
Boost.Python.instance
__builtin__.object

Methods defined here:
__init__(...)

Data and other attributes defined here:
__instance_size__ = 12

Data and other attributes inherited from Boost.Python.instance:
__dict__ = <dictproxy object at 0x5164d0>
__new__ = <built-in method __new__ of Boost.Python.class object at 0x5f818c>
T.__new__(S, ...) -> a new object with type S, a subtype of T
__weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects>

 
Functions
       
astar_search(...)
astar_search(graph, root_vertex, heuristic, visitor = None, 
             predecessor_map = None, cost_map = None, 
             distance_map = None, weight_map = None, color_map = None)
 
Searches a weight, directed or undirected graph using an heuristic
function as guidance.
 
Parameters:
  graph            the graph to search. It may be either a directed or
                   undirected graph.
 
  root_vertex      the starting vertex for the search.
 
  heuristic        an heuristic function that maps a vertex to a
                   floating-point value that estimates the distance from
                   the source to that vertex.
 
  visitor          a visitor that will receive events as the search
                   progresses. Typically this visitor should be derived
                   from boost.graph.astar_visitor.
 
  predecessor_map  a vertex -> vertex map that stores the predecessor of
                   each vertex in the search tree. From a given vertex,
                   one can follow the predecessor_map back to the
                   root_vertex to reconstruct the path taken.
 
  cost_map         a vertex -> float map that stores the distance from
                   the root_vertex to each vertex in the tree plus the
                   estimated cost to reach the goal.
 
  distance_map     a vertex -> float map that stores the distance from
                   the root_vertex to each vertex in the tree.
 
  weight_map       an edge -> float map that stores the weight of each
                   edge in the graph. Negative edge weights are not
                   permitted. If no weight map is provided, each edge
                   will be assumed to have a weight of 1.0.
 
  color_map        a vertex property map that stores the "color" of each
                   vertex, which indicates whether is has not been seen
                   (white), has been seen but not visited (grey), or has
                   been visited (black).
 
See also:
  astar_visitor
  bellman_ford_shortest_paths
  dag_shortest_paths
  dijkstra_shortest_paths
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/astar_search.html
bellman_ford_shortest_paths(...)
bellman_ford_shortest_paths(graph, root_vertex, predecessor_map = None, 
                            distance_map = None, weight_map = None, 
                            visitor = None) -> bool
 
Computes the shortest paths from the root vertex to every other vertex
in the graph. Edge weights may be either positive or negative, but if a
negative weight cycle is found the algorithm will return False to
indicate failure. Otherwise, the algorithm returns True on success.
 
Parameters:
  graph            the graph on which to compute shortest paths will
                   run. It may be either a directed or undirected graph.
 
  root_vertex      the starting vertex for the shortest-path search.
 
  predecessor_map  a vertex -> vertex map that stores the predecessor of
                   each vertex in the shortest paths tree. From a given
                   vertex, one can follow the predecessor_map back to
                   the root_vertex to reconstruct the shortest path.
 
  distance_map     a vertex -> float map that stores the distance from
                   the root_vertex to each vertex in the tree. A
                   distance of infinity in this property map indicates
                   that the vertex is unreachable from the root_vertex.
 
  weight_map       an edge -> float map that stores the weight of each
                   edge in the graph. Negative edge weights are
                   permitted. If no weight map is provided, each edge
                   will be assumed to have a weight of 1.0.
 
  visitor          a visitor that will receive events as the
                   shortest-paths computation progresses. Typically this
                   visitor should be derived from
                   boost.graph.bellman_ford_visitor.
 
See also:
  bellman_ford_visitor
  dag_shortest_paths
  dijkstra_shortest_paths
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/bellman_ford_shortest.html
betweenness_centrality_clustering(...)
betweenness_centrality_clustering(graph, done, 
                                  edge_centrality_map = None)
 
Clusters the graph by repeatedly removing the edge with the largest
betweenness centrality until a certain stopping criteria is reached.
This is a rather inefficient clustering algorithm and should only be
used for small graphs.
 
Parameters:
  graph                the graph that will be clustered.
 
  done                 A Python function (or callable object) that
                       determines when betweenness centrality clustering
                       should terminate. It receives three parameters
                       during each iteration: the maximum centrality,
                       the edge descriptor that has that centrality, and
                       the graph itself, and should return True when
                       clustering is complete.
 
  edge_centrality_map  an edge -> float map that stores the centrality
                       of each edge in the graph.
 
See also:
  brandes_betweenness_centrality
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/bc_clustering.html
biconnected_components(...)
biconnected_components(graph, component_map = None) -> list
 
Computes the biconnected components and articulation points in an
undirected graph, assigning component numbers in the range [0, n) (where
n is the number of biconnected components) to the edges in the graph.
The set of articulation points, i.e., those vertices that separate
biconnected components, will be returned.
 
Parameters:
  graph          the graph on which to compute biconnected components.
                 The graph must be undirected.
 
  component_map  an edge -> int map that stores the component number for
                 each edge in the graph. Edges with the same component
                 number are in the same biconnected component.
 
See also:
  connected_components
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/biconnected_components.html
brandes_betweenness_centrality(...)
brandes_betweenness_centrality(graph, vertex_centrality_map = None, 
                               edge_centrality_map = None, 
                               weight_map = None)
 
Computes the betweenness centrality of the vertices and/or edges in the
graph. The betweenness centrality of a vertex or edge is the ratio of
shortest paths in the graph that pass through the vertex or edge.
 
Parameters:
  graph                  the graph on which centrality should be
                         computed.
 
  vertex_centrality_map  a vertex -> float map that stores the
                         centrality of each vertex in the graph.
 
  edge_centrality_map    an edge -> float map that stores the centrality
                         of each edge in the graph.
 
  weight_map             an edge -> float map that stores the weight of
                         each edge in the graph. If no weight map is
                         provided, each edge will be assumed to have a
                         weight of 1.0.
 
See also:
  betweenness_centrality_clustering
  central_point_dominance
  relative_betweenness_centrality
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/betweenness_centrality.html
breadth_first_search(...)
breadth_first_search(graph, root_vertex, buffer = None, visitor = None, 
                     color_map = None)
 
Performs a breadth-first search on the given graph starting at a
particular vertex.
 
Parameters:
  graph        the graph on which the breadth-first search will run. It
               may be either a directed or undirected graph.
 
  root_vertex  the vertex where the breadth-first search will originate.
 
  buffer       the queue used by the breadth-first search. If not
               supplied, a simple FIFO queue will be used.
 
  visitor      a visitor that will receive events as the breadth-first
               search progresses. Typically this visitor should be
               derived from boost.graph.bfs_visitor.
 
  color_map    a vertex property map that stores the "color" of each
               vertex, which indicates whether is has not been seen
               (white), has been seen but not visited (grey), or has
               been visited (black).
 
See also:
  bfs_visitor
  breadth_first_visit
  depth_first_search
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/breadth_first_search.html
central_point_dominance(...)
central_point_dominance(graph, vertex_centrality_map = None) -> float
 
Computes the central point dominance of a graph based on the relative
betweeness centrality of the vertices. Returns a value between 0 and 1,
where larger numbers indicate more star-like graphs with a single
central node and 0 indicates a very decentralized graph.
 
Parameters:
  graph                  the graph on which the relative vertex
                         centrality has been computed.
 
  vertex_centrality_map  a vertex -> float map that stores the relative
                         centrality of each vertex in the graph.
 
See also:
  betweenness_centrality_clustering
  brandes_betweenness_centrality
  relative_betweenness_centrality
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/betweenness_centrality.html
circle_graph_layout(...)
circle_graph_layout(graph, position_map, radius = 0.5)
 
Lays out the vertices of the graph along a circle of given radius.
 
Parameters:
  graph         the graph on which to perform the layout.
 
  position_map  a vertex -> Point2D map that stores the position of each
                vertex.
 
  radius        the radius of the circle.
 
See also:
  fruchterman_reingold_force_directed_layout
  kamada_kawai_spring_layout
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/circle_graph_layout.html
connected_components(...)
connected_components(graph, component_map = None) -> int
 
Computes the connected components in an undirected graph, assigning
component numbers in the range [0, n) (where n is the number of
connected components) to the vertices in the graph. Returns the number
of connected components.
 
Parameters:
  graph          the graph on which to compute connected components. The
                 graph must be undirected.
 
  component_map  a vertex -> int map that stores the component number
                 for each vertex in the graph. Vertices with the same
                 component number are in the same connected component.
 
See also:
  biconnected_components
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/connected_components.html
cuthill_mckee_ordering(...)
cuthill_mckee_ordering(graph, comp = None) -> list
 
Computes a new ordering for the vertices in the graph that reduces the
bandwidth in a sparse matrix.
 
Parameters:
  graph  the graph to be ordered.
 
  comp   the comparison function that determines the order the neighbors
         are visited.
 
See also:
  king_ordering
  minimum_degree_ordering
  sloan_ordering
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/cuthill_mckee_ordering.html
dag_shortest_paths(...)
dag_shortest_paths(graph, root_vertex, predecessor_map = None, 
                   distance_map = None, weight_map = None, 
                   visitor = None)
 
Computes the shortest paths from the root vertex to every other vertex
in a directed acyclic graph.
 
Parameters:
  graph            the graph on which to compute shortest paths will
                   run. It may be either a directed or undirected graph.
 
  root_vertex      the starting vertex for the shortest-path search.
 
  predecessor_map  a vertex -> vertex map that stores the predecessor of
                   each vertex in the shortest paths tree. From a given
                   vertex, one can follow the predecessor_map back to
                   the root_vertex to reconstruct the shortest path.
 
  distance_map     a vertex -> float map that stores the distance from
                   the root_vertex to each vertex in the tree. A
                   distance of infinity in this property map indicates
                   that the vertex is unreachable from the root_vertex.
 
  weight_map       an edge -> float map that stores the weight of each
                   edge in the graph. Negative edge weights are
                   permitted. If no weight map is provided, each edge
                   will be assumed to have a weight of 1.0.
 
  visitor          a visitor that will receive events as the
                   shortest-paths computation progresses. Typically this
                   visitor should be derived from
                   boost.graph.dijkstra_visitor.
 
See also:
  bellman_ford_shortest_paths
  dijkstra_visitor
  dijkstra_shortest_paths
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/dag_shortest_paths.html
depth_first_search(...)
depth_first_search(graph, root_vertex = None, visitor = None, 
                   color_map = None)
 
Performs a depth-first search on the given graph, optionally starting at
a particular vertex.
 
Parameters:
  graph        the graph on which the depth-first search will run. It
               may be either a directed or undirected graph.
 
  root_vertex  the vertex where the depth-first search will originate.
               If none is provided, the depth-first search will cover
               all vertices in the graph
 
  visitor      a visitor that will receive events as the depth-first
               search progresses. Typically this visitor should be
               derived from boost.graph.dfs_visitor.
 
  color_map    a vertex property map that stores the "color" of each
               vertex, which indicates whether is has not been seen
               (white), has been seen but not visited (grey), or has
               been visited (black).
 
See also:
  breadth_first_search
  dfs_visitor
  depth_first_visit
  undirected_dfs
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/depth_first_search.html
depth_first_visit(...)
depth_first_visit(graph, root_vertex, visitor = None, color_map = None)
 
Performs a depth-first search on the given graph starting at a
particular vertex. Unless depth_first_search, the root_vertex parameter
is mandatory and the color_map, if provided, will NOT be reinitialized.
 
Parameters:
  graph        the graph on which the depth-first search will run. It
               may be either a directed or undirected graph.
 
  root_vertex  the vertex where the depth-first search will originate.
 
  visitor      a visitor that will receive events as the depth-first
               search progresses. Typically this visitor should be
               derived from boost.graph.dfs_visitor.
 
  color_map    a vertex property map that stores the "color" of each
               vertex, which indicates whether is has not been seen
               (white), has been seen but not visited (grey), or has
               been visited (black).
 
See also:
  breadth_first_search
  dfs_visitor
  depth_first_search
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/depth_first_visit.html
dijkstra_shortest_paths(...)
dijkstra_shortest_paths(graph, root_vertex, predecessor_map = None, 
                        distance_map = None, weight_map = None, 
                        visitor = None)
 
Computes the shortest paths from the root vertex to every other vertex
in a graph.
 
Parameters:
  graph            the graph on which to compute shortest paths will
                   run. It may be either a directed or undirected graph.
 
  root_vertex      the starting vertex for the shortest-path search.
 
  predecessor_map  a vertex -> vertex map that stores the predecessor of
                   each vertex in the shortest paths tree. From a given
                   vertex, one can follow the predecessor_map back to
                   the root_vertex to reconstruct the shortest path.
 
  distance_map     a vertex -> float map that stores the distance from
                   the root_vertex to each vertex in the tree. A
                   distance of infinity in this property map indicates
                   that the vertex is unreachable from the root_vertex.
 
  weight_map       an edge -> float map that stores the weight of each
                   edge in the graph. Negative edge weights are not
                   permitted. If no weight map is provided, each edge
                   will be assumed to have a weight of 1.0.
 
  visitor          a visitor that will receive events as the
                   shortest-paths computation progresses. Typically this
                   visitor should be derived from
                   boost.graph.dijkstra_visitor.
 
See also:
  bellman_ford_shortest_paths
  dag_shortest_paths
  dijkstra_visitor
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/dijkstra_shortest_paths.html
fruchterman_reingold_force_directed_layout(...)
fruchterman_reingold_force_directed_layout(graph, position, 
                                           origin = Point2D()/Point3D(), 
                                           extent = Point2D(500, 500)/Point3D(500, 500, 500), 
                                           attractive_force = None, 
                                           repulsive_force = None, 
                                           force_pairs = None, 
                                           cooling = None, 
                                           progressive = False)
 
Performs Fruchterman-Reingold force-directed layout in either two or
three dimensions. This is a good general-purpose graph layout routine
that handles both directed and undirected, connected and disconnected
graphs.
 
Parameters:
  graph             the graph on which to perform the layout.
 
  position          a vertex -> Point2D map or vertex -> Point3D that
                    stores the position of each vertex.
 
  origin            the origin of the bounding box in which layout will
                    occur
 
  extent            the extent (size) of the bounding box in which
                    layout will occur
 
  attractive_force  A Python function (or callable object) that computes
                    the attractive force along an edge. The function
                    should accept four parameters: the edge descriptor,
                    the parameter k = sqrt(bounding box
                    volume/graph.num_vertices()), the distance between
                    the two endpoints of the edge, and the graph g. If
                    no attractive force is provided, the default of
                    dist*dist/k will be used.
 
  repulsive_force   A Python function (or callable object) that computes
                    the repulsive force between two vertices. The
                    function should accept five parameters: the two
                    vertex descriptors, followed by the parameter k =
                    sqrt(bounding box volume/graph.num_vertices()), the
                    distance between the two endpoints of the edge, and
                    the graph g. If no repulsive force is provided, the
                    default of k*k/dist will be used.
 
  force_pairs       A Python function (or callable object) that
                    enumerates the pairs of vertices that should repulse
                    each other. This function must accept two arguments:
                    the graph and the apply_force function. It will
                    traverse the graph and, for each pair of vertices
                    (u, v) that should repulse each other, execute
                    apply_force(u, v). If no force_pairs function is
                    provided, the algorithm will use a 2k x 2k grid to
                    provide a reasonably performance and accuracy
                    tradeoff.
 
  cooling           A Python function (or callable object) that provides
                    the maximm displacement (i.e., the "temperature")
                    for any vertex in each iteration, and terminates the
                    algorithm by returning a temperature of 0.
 
  progressive       when False, vertex positions are randomized before
                    the algorithm is executed. Otherwise, the positions
                    stored in the position property map are used as the
                    starting positions.
 
See also:
  circle_graph_layout
  kamada_kawai_spring_layout
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/fruchterman_reingold.html
isomorphism(...)
isomorphism(graph1, graph2, isomorphism_map = None, 
            vertex_invariant = None) -> bool
 
Determines if the two input graphs are isomorphic. If so, returns True
and fills in the isomorphism_map (if provided). Otherwise, it returns
false.
 
Parameters:
  graph1            the first graph
 
  graph2            the second graph
 
  isomorphism_map   a vertex -> vertex map that will store the mapping
                    from vertices in graph1 to vertices in graph2, if
                    the graphs are indeed isomorphic.
 
  vertex_invariant  A Python function (or callable object) that produces
                    a hash value given a vertex and its owning graph.
                    This function must work for both vertices in graph1
                    and graph2, such that isomorphic vertices have the
                    same hash value. If no vertex_invariant is provided,
                    the degree of vertices will be used to aid matching.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/isomorphism.html
kamada_kawai_spring_layout(...)
kamada_kawai_spring_layout(graph, position, weight = None, 
                           side_length = 500.0, done = None, 
                           spring_constant = 1.0, progressive = False)
 
Performs Kamada-Kawai spring embedding layout in two dimensions on an
undirected, connected, possibly weighted graph. While this algorithm is
considerably more expensive and limited than Fruchterman-Reingold, it
tends to produce much better layouts.
 
Parameters:
  graph            the graph on which to perform the layout, which must
                   be undirected.
 
  position         a vertex -> Point2D map that stores the position of
                   each vertex.
 
  weight           an edge -> float map that stores the weight of each
                   edge in the graph. If no weight map is provided, each
                   edge will be assumed to have a weight of 1.0.
 
  side_length      the length of a side in the 2D bounding box in which
                   layout will occur
 
  done             A Python function (or callable object) that
                   determines when the local and global phases of the
                   algorithm will terminate. The function must take four
                   arguments: delta_p, a measure of how far the point
                   "p" has moved; "p" the vertex that has been moved
                   most recently; the graph; and a boolean value that
                   indicates whether the movement is local (True) or
                   global (False). If omitted, the algorithm will
                   terminate will it reaches a local minimum.
 
  spring_constant  A constant multiplied by each spring's strength.
                   Larger values create more pleasing layouts (but take
                   longer), smaller values produce layouts more rapidly
                   (but they may not look as good).
 
  progressive      when False, vertex positions are randomized before
                   the algorithm is executed. Otherwise, the positions
                   stored in the position property map are used as the
                   starting positions.
 
See also:
  circle_graph_layout
  fruchterman_reingold_force_directed_layout
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/kamada_kawai_spring_layout.html
king_ordering(...)
king_ordering(graph) -> list
 
Computes a new ordering for the vertices in the graph that reduces the
bandwidth of a sparse matrix.
 
Parameters:
  graph  the graph to be ordered.
 
See also:
  cuthill_mckee_ordering
  minimum_degree_ordering
  sloan_ordering
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/king_ordering.html
kruskal_minimum_spanning_tree(...)
kruskal_minimum_spanning_tree(graph, weight_map) -> list
 
Computes a minimum spanning forest for the given undirected graph. The
edges in the spanning forest will be returned as a list.
 
Parameters:
  graph       the graph whose spanning tree will be computed.
 
  weight_map  an edge -> float map that stores the weight of each edge
              in the graph.
 
See also:
  prim_minimum_spanning_tree
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/kruskal_min_spanning_tree.html
minimum_degree_ordering(...)
minimum_degree_ordering(graph, supernode_size = None, delta = 0) -> list
 
Computes a new ordering for the vertices in the graph that reduces the
fill-in of sparse matrices.
 
Parameters:
  graph           the graph to be ordered.
 
  supernode_size  a vertex -> int that provides the supernode size of
                  each vertex. If omitted, the supernode size of each
                  vertex will be initialized to 1.
 
  delta           the minimum difference between the minimum degree and
                  the degree of vertices that will be eliminated by
                  multiple elimination
 
See also:
  cuthill_mckee_ordering
  king_ordering
  sloan_ordering
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/minimum_degree_ordering.html
page_rank(...)
page_rank(graph, rank_map, done_or_iterations = 20)
 
Computes the PageRank of each vertex in a directed graph. For optimal
results, the graph should be strongly connected.
 
Parameters:
  graph               the directed graph whose vertices will be ranked.
 
  rank_map            a vertex -> float that will contain the ranks of
                      each vertex in the graph
 
  done_or_iterations  this can either be an integer number of iterations
                      to run or a Python function (or callable object)
                      that accepts the rank map and the graph as
                      arguments and returns True when the algorithm
                      should terminate
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/page_rank.html
prim_minimum_spanning_tree(...)
prim_minimum_spanning_tree(graph, predecessor_map = None, 
                           distance_map = None, weight_map = None, 
                           visitor = None, root_vertex = None, 
                           color_map = None)
 
Computes the minimum spanning tree from the root vertex, if provided;
otherwise, computes a minimum spanning forest.
 
Parameters:
  graph            the graph for which the minimum spanning tree will be
                   computed.
 
  predecessor_map  a vertex -> vertex map that stores the predecessor of
                   each vertex in the minimum spanning tree. From a
                   given vertex, one can follow the predecessor_map back
                   to the root_vertex to reconstruct the shortest path.
 
  distance_map     a vertex -> float map that stores the distance from
                   the root_vertex to each vertex in the tree. A
                   distance of infinity in this property map indicates
                   that the vertex is unreachable from the root_vertex.
 
  weight_map       an edge -> float map that stores the weight of each
                   edge in the graph. Negative edge weights are not
                   permitted. If no weight map is provided, each edge
                   will be assumed to have a weight of 1.0.
 
  visitor          a visitor that will receive events as the
                   shortest-paths computation progresses. Typically this
                   visitor should be derived from
                   boost.graph.dijkstra_visitor.
 
  root_vertex      the starting vertex for the minimum spanning tree. If
                   omitted a minimum spanning forest will be computed.
 
  color_map        a vertex property map that stores the "color" of each
                   vertex, which indicates whether is has not been seen
                   (white), has been seen but not visited (grey), or has
                   been visited (black).
 
See also:
  dfs_visitor
  kruskal_minimum_spanning_tree
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/prim_minimum_spanning_tree.html
relative_betweenness_centrality(...)
relative_betweenness_centrality(graph, vertex_centrality_map = None)
 
Transforms the raw vertex betweenness centrality produced by
brandes_betweenness_centrality into a relative betweenness centrality
that can be used by central_point_dominance or for comparison with other
graphs.
 
Parameters:
  graph                  the graph on which the vertex centrality has
                         been computed.
 
  vertex_centrality_map  a vertex -> float map that stores the relative
                         centrality of each vertex in the graph.
 
See also:
  betweenness_centrality_clustering
  brandes_betweenness_centrality
  central_point_dominance
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/betweenness_centrality.html
sequential_vertex_coloring(...)
sequential_vertex_coloring(graph, color_map = None) -> int
 
Colors the vertices of the graph using a simple but relatively efficient
algorithm. Returns the number "n" of colors used, and the color_map will
contain colors for each vertex in the range [0, n).
 
Parameters:
  graph      the graph whose vertices will be colored
 
  color_map  a vertex -> int map that will contain the color of each
             vertex
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/sequential_vertex_coloring.html
sloan_ordering(...)
sloan_ordering(graph, start, end, color_map = None, 
               priority_map = None, weight1 = 1.0, 
               weight2 = 2.0) -> list
sloan_ordering(graph, color_map = None, priority_map = None, 
               weight1 = 1.0, weight2 = 2.0) -> list
 
Computes a new ordering for the vertices in the graph that reduces the
profile and wavefront of sparse matrices. The start and end vertices are
optional, but providing them can have a large (positive or negative)
effect on the resulting ordering.
 
Parameters:
  graph         the graph to be ordered.
 
  start         the vertex from which ordering should start
 
  end           the vertex at which ordering should end
 
  color_map     a vertex property map that stores the "color" of each
                vertex, which indicates whether is has not been seen
                (white), has been seen but not visited (grey), or has
                been visited (black).
 
  priority_map  a vertex -> float map used internally that tracks the
                priority of each vertex.
 
  weight1       Relative weight applied to the global "degree".
 
  weight2       Relative weight applied to the global "degree".
 
See also:
  cuthill_mckee_ordering
  king_ordering
  minimum_degree_ordering
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/sloan_ordering.html
strong_components(...)
strong_components(graph, component_map = None) -> int
 
Computes the strongly connected components in a directed graph,
assigning component numbers in the range [0, n) (where n is the number
of strongly connected components) to the vertices in the graph. Returns
the number of strongly connected components.
 
Parameters:
  graph          the graph on which to compute strongly connected
                 components. The graph must be directed.
 
  component_map  a vertex -> int map that stores the component number
                 for each vertex in the graph. Vertices with the same
                 component number are in the same strongly connected
                 component.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/strong_components.html
topological_sort(...)
topological_sort(graph, color_map = None) -> list
 
Computes a reverse topological ordering of the vertices in the graph.
Returns the list of vertices in their new order.
 
Parameters:
  graph      the graph to be ordered.
 
  color_map  a vertex property map that stores the "color" of each
             vertex, which indicates whether is has not been seen
             (white), has been seen but not visited (grey), or has been
             visited (black).
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/topological_sort.html
transitive_closure(...)
transitive_closure(graph, orig_to_copy = None) -> Digraph
 
Computes the transitive closure of a directed graph and returns the
resulting graph. The input graph is not modified.
 
Parameters:
  graph         the directed graph from which the transition closure
                will be computed.
 
  orig_to_copy  a vertex -> vertex map that maps from the vertices of
                the input graph to the vertices of the resulting graph.
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/transitive_closure.html
undirected_dfs(...)
undirected_dfs(graph, visitor = None, color_map = None, 
               edge_color_map = None)
 
Performs an undirected depth-first search on the given graph.
 
Parameters:
  graph           the undirected graph on which the depth-first search
                  will run.
 
  visitor         a visitor that will receive events as the depth-first
                  search progresses. Typically this visitor should be
                  derived from boost.graph.dfs_visitor.
 
  color_map       a vertex property map that stores the "color" of each
                  vertex, which indicates whether is has not been seen
                  (white), has been seen but not visited (grey), or has
                  been visited (black).
 
  edge_color_map  an edge property map that stores the "color" of each
                  edge, allowing the algorithm to distinguish between
                  tree and back edges in an undirected graph
 
See also:
  dfs_visitor
  depth_first_search
  depth_first_visit
 
Complete C++ documentation is available at:
  http://www.boost.org/libs/graph/doc/undirected_dfs.html