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
           &n