### Graphviz Style Attributes Examples

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Provides examples of valid attributes for controlling graph layout and appearance. These attributes can be passed to the style(), node_style(), and edge_style() methods.

```text
rankdir = 'LR'   (draws the graph horizontally, left to right)
ranksep = number (rank separation in inches)

style = 'filled' | 'invisible' | 'diagonals' | 'rounded'
shape = 'box' | 'ellipse' | 'circle' | 'point' | 'triangle'

style     = 'dashed' | 'dotted' | 'solid' | 'invis' | 'bold'
arrowhead = 'box' | 'crow' | 'diamond' | 'dot' | 'inv' | 'none' | 'tee' | 'vee'
weight    = number (the larger the number the closer the nodes will be)

```

--------------------------------

### Example Usage

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Demonstrates a typical workflow for creating a graph, generating its dot representation, and then displaying or saving it.

```APIDOC
## Example Usage

### Description
This example demonstrates a typical workflow for creating a graph using `altgraph.Graph`, generating its dot representation using `altgraph.Dot`, and then displaying or saving it.

### Code
```python
from altgraph import Graph, Dot

# create a graph
edges = [ (1,2), (1,3), (3,4), (3,5), (4,5), (5,4) ]
graph = Graph.Graph(edges)

# create a dot representation of the graph
dot = Dot.Dot(graph)

# display the graph (requires graphviz to be installed and in PATH)
dot.display()

# save the dot representation into the mydot.dot file
dot.save_dot(file_name='mydot.dot')

# save dot file as gif image into the graph.gif file (requires graphviz)
dot.save_img(file_name='graph', file_type='gif')
```
```

--------------------------------

### Basic Graph Creation and Dot File Generation

Source: https://altgraph.readthedocs.io/en/latest/dot.html

This snippet demonstrates the fundamental usage of the Dot module for creating a graph, generating its dot representation, and saving it to a file or image. Ensure graphviz is installed and accessible.

```python
from altgraph import Graph, Dot

# create a graph
edges = [ (1,2), (1,3), (3,4), (3,5), (4,5), (5,4) ]
graph = Graph.Graph(edges)

# create a dot representation of the graph
dot = Dot.Dot(graph)

# display the graph
dot.display()

# save the dot representation into the mydot.dot file
dot.save_dot(file_name='mydot.dot')

# save dot file as gif image into the graph.gif file
dot.save_img(file_name='graph', file_type='gif')

```

--------------------------------

### Get Incoming Neighbors

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of all nodes connected by incoming edges to a specified node.

```python
Graph.inc_nbrs(_node_)
```

--------------------------------

### Forward Breadth-First Search Subgraph

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a subgraph containing nodes reachable via a breadth-first search from a start node, following outgoing edges.

```python
Graph.forw_bfs_subgraph(_start_id_)
```

--------------------------------

### Graph.back_bfs(_start_[, _end_])

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes starting at _start_ in some bread first search order (following incoming edges). When _end_ is specified iteration stops at that node.

```APIDOC
## Graph.back_bfs(_start_[, _end_])

### Description
Returns a list of nodes starting at _start_ in some bread first search order (following incoming edges). When _end_ is specified iteration stops at that node.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_** (type unspecified) - Required - The starting node for the BFS.
- **_end_** (type unspecified) - Optional - The node at which to stop the BFS.
```

--------------------------------

### shortest_path

Source: https://altgraph.readthedocs.io/en/latest/graphalgo.html

Finds a single shortest path between a specified start node and end node. The input conventions are the same as the `dijkstra()` function, and the output is a list of nodes representing the shortest path.

```APIDOC
## shortest_path

### Description
Find a single shortest path from the given start node to the given end node. The input has the same conventions as `dijkstra()`.

### Method
`shortest_path(_graph_, _start_, _end_)

### Parameters
* `_graph_`: The graph object.
* `_start_`: The starting node.
* `_end_`: The end node.

### Returns
A list of the nodes in order along the shortest path.
```

--------------------------------

### Graph.forw_bfs(_start_[, _end_])

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes starting at _start_ in some bread first search order (following outgoing edges). When _end_ is specified iteration stops at that node.

```APIDOC
## Graph.forw_bfs(_start_[, _end_])

### Description
Returns a list of nodes starting at _start_ in some bread first search order (following outgoing edges). When _end_ is specified iteration stops at that node.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_** (type unspecified) - Required - The starting node for the BFS.
- **_end_** (type unspecified) - Optional - The node at which to stop the BFS.
```

--------------------------------

### Forward Breadth-First Search

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes found through a breadth-first search starting from a specified node, following outgoing edges. The search can stop at an end node.

```python
Graph.forw_bfs(_start_[, _end_])
```

--------------------------------

### Get All Neighbors

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes connected by either incoming or outgoing edges to a specified node.

```python
Graph.all_nbrs(_node_)
```

--------------------------------

### Backward Breadth-First Search

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes found through a breadth-first search starting from a specified node, following incoming edges. The search can stop at an end node.

```python
Graph.back_bfs(_start_[, _end_])
```

--------------------------------

### Backward Breadth-First Search Subgraph

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a subgraph containing nodes reachable via a breadth-first search from a start node, following incoming edges.

```python
Graph.back_bfs_subgraph(_start_id_)
```

--------------------------------

### dijkstra

Source: https://altgraph.readthedocs.io/en/latest/graphalgo.html

Computes shortest paths from a start node to all nodes nearer than or equal to an optional end node using Dijkstra's algorithm. Assumes edge data represents edge length and handles positive and some negative edge lengths.

```APIDOC
## dijkstra

### Description
Find shortest paths from the start node to all nodes nearer than or equal to the _end_ node. The edge data is assumed to be the edge length. Dijkstra’s algorithm is only guaranteed to work correctly when all edge lengths are positive. This code does not verify this property for all edges (only the edges examined until the end vertex is reached), but will correctly compute shortest paths even for some graphs with negative edges, and will raise an exception if it discovers that a negative edge has caused it to make a mistake.

### Method
`dijkstra(_graph_, _start_[, _end_])`

### Parameters
* `_graph_`: The graph object.
* `_start_`: The starting node.
* `_end_`: Optional. The end node. If provided, the search stops when this node is reached.
```

--------------------------------

### Get Outgoing Neighbors

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of all nodes connected by outgoing edges from a specified node.

```python
Graph.out_nbrs(_node_)
```

--------------------------------

### Iterative Depth-First Search

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Yields nodes in a depth-first traversal starting from a specified node. Traversal can stop at an end node and can be forward or backward.

```python
Graph.iterdfs(_start_[, _end_[, _forward_]])
```

--------------------------------

### Iterative Depth-First Search with Data

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Yields associated data for nodes in a depth-first traversal, starting from a specified node. It skips nodes without data or those failing a condition.

```python
Graph.iterdata(_start_[, _end_[, _forward_[, _condition_]]])
```

--------------------------------

### Graph.iterdata(_start_[, _end_[, _forward_[, _condition_]]])

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Yield the associated data for nodes in a depth first traversal starting at the _start_ node. This method will not yield values for nodes without associated data. If _end_ is specified traversal stops when reaching that node. If _condition_ is specified and the condition callable returns False for the associated data this method will not yield the associated data and will not follow the edges for the node. If forward is True (the default) edges are traversed in forward direction, otherwise they are traversed in reverse direction.

```APIDOC
## Graph.iterdata(_start_[, _end_[, _forward_[, _condition_]]])

### Description
Yield the associated data for nodes in a depth first traversal starting at the _start_ node. This method will not yield values for nodes without associated data. If _end_ is specified traversal stops when reaching that node. If _condition_ is specified and the condition callable returns False for the associated data this method will not yield the associated data and will not follow the edges for the node. If forward is True (the default) edges are traversed in forward direction, otherwise they are traversed in reverse direction.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_** (type unspecified) - Required - The starting node for the DFS.
- **_end_** (type unspecified) - Optional - The node at which to stop the traversal.
- **_forward_** (boolean) - Optional - If True (default), traverse edges in the forward direction. If False, traverse in reverse.
- **_condition_** (callable) - Optional - A callable that takes associated data and returns False to stop yielding data and following edges for that node.
```

--------------------------------

### Graph.iterdfs(_start_[, _end_[, _forward_]])

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Yield nodes in a depth first traversal starting at the _start_ node. If _end_ is specified traversal stops when reaching that node. If forward is True (the default) edges are traversed in forward direction, otherwise they are traversed in reverse direction.

```APIDOC
## Graph.iterdfs(_start_[, _end_[, _forward_]])

### Description
Yield nodes in a depth first traversal starting at the _start_ node. If _end_ is specified traversal stops when reaching that node. If forward is True (the default) edges are traversed in forward direction, otherwise they are traversed in reverse direction.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_** (type unspecified) - Required - The starting node for the DFS.
- **_end_** (type unspecified) - Optional - The node at which to stop the traversal.
- **_forward_** (boolean) - Optional - If True (default), traverse edges in the forward direction. If False, traverse in reverse.
```

--------------------------------

### Customizing Output

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Illustrates how to customize the appearance of the overall graph, nodes, and edges using style methods.

```APIDOC
## Customizing the Output

### Description
The graph drawing process can be customized by passing valid **dot** parameters for the nodes and edges. This section provides examples of customizing the overall graph, individual nodes, and specific edges.

### Examples
```python
# customizing the way the overall graph is drawn
dot.style(size='10,10', rankdir='RL', page='5, 5' , ranksep=0.75)

# customizing node drawing
dot.node_style(1, label='BASE_NODE',shape='box', color='blue' )
dot.node_style(2, style='filled', fillcolor='red')

# customizing edge drawing
dot.edge_style(1, 2, style='dotted')
dot.edge_style(3, 5, arrowhead='dot', label='binds', labelangle='90')
dot.edge_style(4, 5, arrowsize=2, style='bold')
```

.. note::

   `dotty` (invoked via :py:func:`~altgraph.Dot.display`) may not be able to
   display all graphics styles. To verify the output save it to an image
   file and look at it that way.
```

--------------------------------

### Customizing Graph, Node, and Edge Styles

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Shows how to apply custom styles to the overall graph, individual nodes, and specific edges using the style(), node_style(), and edge_style() methods. Refer to graphviz documentation for available attributes.

```python
# customizing the way the overall graph is drawn
dot.style(size='10,10', rankdir='RL', page='5, 5' , ranksep=0.75)

# customizing node drawing
dot.node_style(1, label='BASE_NODE',shape='box', color='blue' )
dot.node_style(2, style='filled', fillcolor='red')

# customizing edge drawing
dot.edge_style(1, 2, style='dotted')
dot.edge_style(3, 5, arrowhead='dot', label='binds', labelangle='90')
dot.edge_style(4, 5, arrowsize=2, style='bold')

```

--------------------------------

### Directed and Non-directed Graphs

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Shows how to create both directed and non-directed graphs using the `graphtype` parameter.

```APIDOC
## Directed and Non-directed Graphs

### Description
The `Dot` class can be used for both directed and non-directed graphs by passing the `graphtype` parameter during initialization.

### Example
```python
# create directed graph (default)
dot_directed = Dot.Dot(graph, graphtype="digraph")

# create non-directed graph
dot_non_directed = Dot.Dot(graph, graphtype="graph")
```
```

--------------------------------

### ObjectGraph.msgin()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Prints an incoming debug message if debug output is enabled.

```APIDOC
## ObjectGraph.msgin()

### Description
Prints an incoming debug message if debug output is enabled.

### Method
`msgin(message)`

### Parameters
#### Path Parameters
- **message** (str) - Required - The incoming message to print.
```

--------------------------------

### Creating Directed and Non-Directed Graphs

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Illustrates how to specify whether the graph should be directed or non-directed using the 'graphtype' parameter during Dot object initialization. The default is 'digraph' (directed).

```python
# create directed graph(default)
dot = Dot.Dot(graph, graphtype="digraph")

# create non-directed graph
dot = Dot.Dot(graph, graphtype="graph")

```

--------------------------------

### Graph Constructor

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Constructs a new empty Graph object. Optionally, it can be initialized with a list of edges.

```APIDOC
## Graph Constructor

### Description
Constructs a new empty `Graph` object. If the optional _edges_ parameter is supplied, updates the graph by adding the specified edges. All of the elements in _edges_ should be tuples with two or three elements. The first two elements of the tuple are the source and destination node of the edge, the optional third element is the edge data. The source and destination nodes are added to the graph when they aren’t already present.

### Method
__init__

### Parameters
* **_edges_** (list of tuples) - Optional - A list of tuples, where each tuple represents an edge. Tuples can have two elements (source, destination) or three elements (source, destination, edge_data).
```

--------------------------------

### Dot.display

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Displays the current graph via dotty. Optionally processes the dot file with the 'neato' command before displaying. This method blocks until the dotty command exits.

```APIDOC
## Dot.display

### Description
Displays the current graph via dotty. If the _mode_ is "neato", the dot file is processed with the neato command before displaying. This method will not return until the dotty command exits.

### Method
(Not specified, likely a method call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
dot_instance.display(mode="neato")
```

### Response
#### Success Response (200)
(No specific response details provided, implies execution completion)

#### Response Example
(No example provided)
```

--------------------------------

### Graph.get_hops(_start_[, _end_[, _forward_]])

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Computes the hop distance to all nodes centered around a specified node. First order neighbours are at hop 1, their neigbours are at hop 2 etc. Uses `forw_bfs()` or `back_bfs()` depending on the value of the forward parameter. If the distance between all neighbouring nodes is 1 the hop number corresponds to the shortest distance between the nodes.

```APIDOC
## Graph.get_hops(_start_[, _end_[, _forward_]])

### Description
Computes the hop distance to all nodes centered around a specified node. First order neighbours are at hop 1, their neigbours are at hop 2 etc. Uses `forw_bfs()` or `back_bfs()` depending on the value of the forward parameter. If the distance between all neighbouring nodes is 1 the hop number corresponds to the shortest distance between the nodes.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_** (type unspecified) - Required - The node to center the hop computation around.
- **_end_** (type unspecified) - Optional - If specified, computation stops at this node.
- **_forward_** (boolean) - Optional - If True, use `forw_bfs()`. If False, use `back_bfs()`.
```

--------------------------------

### altgraph.GraphUtil.generate_random_graph

Source: https://altgraph.readthedocs.io/en/latest/graphutil.html

Generates a Graph instance with a specified number of nodes and edges, with options for self-loops and multi-edges.

```APIDOC
## altgraph.GraphUtil.generate_random_graph

### Description
Generates and returns a `Graph` instance with _node_num_ nodes randomly connected by _edge_num_ edges. When _self_loops_ is present and True, there can be edges that point from a node to itself. When _multi_edge_ is present and True, there can be duplicate edges. This method raises `GraphError <altgraph.GraphError` when a graph with the requested configuration cannot be created.

### Parameters
#### Path Parameters
- **_node_num** (int) - Required - The number of nodes in the graph.
- **edge_num** (int) - Required - The number of edges in the graph.
#### Query Parameters
- **self_loops** (bool) - Optional - If True, allows edges that point from a node to itself.
- **multi_edges** (bool) - Optional - If True, allows duplicate edges.
```

--------------------------------

### Forward Topological Sort

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes in a forward topological order, where successors appear after their predecessors based on outgoing edges.

```python
Graph.forw_topo_sort()
```

--------------------------------

### altgraph.GraphUtil.generate_scale_free_graph

Source: https://altgraph.readthedocs.io/en/latest/graphutil.html

Generates a Graph instance with scale-free (powerlaw) connectivity.

```APIDOC
## altgraph.GraphUtil.generate_scale_free_graph

### Description
Generates and returns a `Graph` instance that will have _steps*growth_num_ nodes and a scale free (powerlaw) connectivity. Starting with a fully connected graph with _growth_num_ nodes, at every step _growth_num_ nodes are added to the graph and are connected to existing nodes with a probability proportional to the degree of these existing nodes. The current implementation is basically untested.

### Parameters
#### Path Parameters
- **_steps_** (int) - Required - The number of steps for growth.
- **_growth_num_** (int) - Required - The number of nodes to add at each step.
#### Query Parameters
- **_self_loops_** (bool) - Optional - If True, allows self-loops.
- **_multi_edges_** (bool) - Optional - If True, allows multiple edges.
```

--------------------------------

### ObjectGraph.msgout()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Prints an outgoing debug message if debug output is enabled.

```APIDOC
## ObjectGraph.msgout()

### Description
Prints an outgoing debug message if debug output is enabled.

### Method
`msgout(message)`

### Parameters
#### Path Parameters
- **message** (str) - Required - The outgoing message to print.
```

--------------------------------

### Node Management

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Methods for adding, hiding, restoring, and querying nodes in the graph.

```APIDOC
## Node Management Methods

### Graph.add_node

Adds a new node to the graph if it is not already present. Arbitrary data can be attached to the node.

### Parameters
* **_node_** (hashable object) - Required - The node to add.
* **_node_data_** (any) - Optional - Arbitrary data to associate with the node.
```

```APIDOC
### Graph.hide_node

Hides a node from the graph, along with its incoming and outgoing edges.

### Parameters
* **_node_** (hashable object) - Required - The node to hide.
```

```APIDOC
### Graph.restore_node

Restores a previously hidden node and its associated edges.

### Parameters
* **_node_** (hashable object) - Required - The node to restore.
```

```APIDOC
### Graph.restore_all_nodes

Restores all nodes that were previously hidden.
```

```APIDOC
### Graph.number_of_nodes

Returns the count of visible nodes in the graph.
```

```APIDOC
### Graph.number_of_hidden_nodes

Returns the count of hidden nodes in the graph.
```

```APIDOC
### Graph.node_list

Returns a list of all visible nodes in the graph.
```

```APIDOC
### Graph.hidden_node_list

Returns a list of all hidden nodes in the graph.
```

```APIDOC
### altgraph.Graph.node_data

Returns the data associated with a given node.

### Parameters
* **_node_** (hashable object) - Required - The node whose data is to be retrieved.
```

```APIDOC
### Graph.describe_node

Returns the node, its associated data, and lists of its incoming and outgoing edges.

### Parameters
* **_node_** (hashable object) - Required - The node to describe.
```

```APIDOC
### Graph.__contains__

Checks if a node exists in the graph. Accessed via the `in` operator.

### Parameters
* **_node_** (hashable object) - Required - The node to check for.
```

```APIDOC
### Graph.__iter__

Iterates over all nodes in the graph.
```

```APIDOC
### Graph.out_edges

Returns a list of outgoing edges for a given node.

### Parameters
* **_node_** (hashable object) - Required - The node whose outgoing edges are to be listed.
```

```APIDOC
### Graph.inc_edges

Returns a list of incoming edges for a given node.

### Parameters
* **_node_** (hashable object) - Required - The node whose incoming edges are to be listed.
```

```APIDOC
### Graph.all_edges

Returns a list of all edges (incoming and outgoing) for a given node.

### Parameters
* **_node_** (hashable object) - Required - The node whose edges are to be listed.
```

```APIDOC
### Graph.out_degree

Returns the number of outgoing edges for a given node.

### Parameters
* **_node_** (hashable object) - Required - The node for which to count outgoing edges.
```

```APIDOC
### Graph.inc_degree

Returns the number of incoming edges for a given node.

### Parameters
* **_node_** (hashable object) - Required - The node for which to count incoming edges.
```

```APIDOC
### Graph.all_degree

Returns the total number of edges (incoming or outgoing) for a given node.

### Parameters
* **_node_** (hashable object) - Required - The node for which to count total edges.
```

--------------------------------

### ObjectGraph Class

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Represents a graph of objects that have a 'graphident' attribute. The 'graphident' attribute serves as the key for each object within the graph. The class provides methods for manipulating the graph structure, including adding and removing nodes and references, creating new nodes, and retrieving graph information.

```APIDOC
## Class: altgraph.ObjectGraph.ObjectGraph

### Description
A graph of objects that have a "graphident" attribute. The value of this attribute is the key for the object in the graph. The optional _graph_ is a previously constructed `Graph`. The optional _debug_ level controls the amount of debug output.

### Methods

#### `__init__([_graph_[, _debug_]])`
Initializes an ObjectGraph.

#### `graph`
An `Graph` object that contains the graph data.

#### `addNode(_node_)`
Adds a _node_ to the graph. Re-adding a node that was previously removed using `removeNode()` will reinstate the previously removed node.

#### `createNode(_self_ , _cls_ , _name_ , _\*args_ , _\**kwds_)`
Creates a new node using `cls(*args, **kwds)` and adds that node using `addNode()`. Returns the newly created node.

#### `removeNode(_node_)`
Removes a _node_ from the graph when it exists. The _node_ argument is either a node object, or the graphident of a node.

#### `createReferences(_fromnode_ , _tonode_[, _edge_data_])`
Creates a reference from _fromnode_ to _tonode_. The optional _edge_data_ is associated with the edge. _Fromnode_ and _tonode_ can either be node objects or the graphident values for nodes. When _fromnode_ is `None`, _tonode_ is a root for the graph.

#### `removeReference(_fromnode_ , _tonode_)`
Removes the reference from _fromnode_ to _tonode_ if it exists.

#### `getRawIdent(_node_)`
Returns the _graphident_ attribute of _node_, or the graph itself when _node_ is `None`.

#### `getIdent(_node_)`
Same as `getRawIdent()`, but only if the node is part of the graph. _Node_ can either be an actual node object or the graphident of a node.

#### `findNode(_node_)`
Returns a given node in the graph, or `Node` when it cannot be found. _Node_ is either an object with a _graphident_ attribute or the _graphident_ attribute itself.

#### `__contains__(_node_)`
Returns True if _node_ is a member of the graph. _Node_ is either an object with a _graphident_ attribute or the _graphident_ attribute itself.

#### `flatten([_condition_[, _start_]])`
Yield all nodes that are entirely reachable by _condition_ starting from the given _start_ node or the graph root. Objects are only reachable from the graph root when there is a reference from the root to the node (either directly or through another node).

#### `nodes()`
Yield all nodes in the graph.

#### `get_edges(_node_)`
Returns two iterators that yield the nodes reaching by outgoing and incoming edges for _node_. Note that the iterator for incoming edges can yield `None` when the _node_ is a root of the graph. Use `None` for _node_ to fetch the roots of the graph.

#### `filterStack(_filters_)`
Filter the ObjectGraph in-place by removing all edges to nodes that do not match every filter in the given filter list. Returns a tuple containing the number of: (_nodes_visited_, _nodes_removed_, _nodes_orphaned_).

#### `edgeData(fromNode, toNode)`
Return the edge data associated with the edge from *fromNode* to *toNode*. Raises :exc:`KeyError` when no such edge exists.

#### `updateEdgeData(_fromNode_ , _toNode_ , _edgeData_)`
Replace the data associated with the edge from _fromNode_ to _toNode_ by _edgeData_. Raises `KeyError` when the edge does not exist.

### Debug Output

#### `debug`
The current debug level.

#### `msg(_level_ , _text_ , _\*args_)`
Print a debug message at the current indentation level when the current debug level is _level_ or less.

#### `msgin(_level_ , _text_ , _\*args_)`
Print a debug message when the current debug level is _level_ or less, and increase the indentation level.

#### `msgout(_level_ , _text_ , _\*args_)`
Decrease the indentation level and print a debug message when the current debug level is _level_ or less.
```

--------------------------------

### iterdot

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Yields all lines of a graphviz input file, including line endings.

```APIDOC
## iterdot

### Description
Yields all lines of a graphviz input file (including line endings).

### Method
(Not specified, likely a method call)

### Parameters
None

### Request Example
```python
for line in dot_instance.iterdot():
    print(line)
```

### Response
#### Success Response (200)
Yields lines from the graphviz input file.

#### Response Example
(No example provided)
```

--------------------------------

### Backward Topological Sort

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes in a backward topological order, where predecessors appear after their successors based on incoming edges.

```python
Graph.back_topo_sort()
```

--------------------------------

### Graph.back_bfs_subgraph(_start_id_)

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Return a subgraph consisting of the breadth first reachable nodes from _start_id_ based on their incoming edges.

```APIDOC
## Graph.back_bfs_subgraph(_start_id_)

### Description
Return a subgraph consisting of the breadth first reachable nodes from _start_id_ based on their incoming edges.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_id_** (type unspecified) - Required - The starting node ID for the BFS.
```

--------------------------------

### ObjectGraph.createReferences()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Creates references between nodes in the object graph. If a reference already exists, it is not created again.

```APIDOC
## ObjectGraph.createReferences()

### Description
Creates references between nodes in the object graph. If a reference already exists, it is not created again.

### Method
`createReferences(source, targets, **data)`

### Parameters
#### Path Parameters
- **source** (any) - Required - The source node for the references.
- **targets** (list) - Required - A list of target nodes for the references.
- **data** (dict) - Optional - Additional data to associate with the references.
```

--------------------------------

### save_image

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Saves the current graph representation as an image file. The file type defaults to 'gif'. The 'neato' mode can be used to process the dot file before saving. Deprecated behavior exists for calling without arguments.

```APIDOC
## save_image

### Description
Saves the current graph representation as an image file. The output is written into a file whose basename is _file_name_ and whose suffix is _file_type_. The _file_type_ specifies the type of file to write; the default is "gif". If the _mode_ is "neato", the dot file is processed with the neato command before displaying. For backward compatibility reasons, this method can also be called without an argument; it will then write the graph with a fixed basename ("out"). This feature is deprecated and should not be used.

### Method
(Not specified, likely a method call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
dot_instance.save_image("my_graph_image", file_type="png", mode="neato")
```

### Response
#### Success Response (200)
(No specific response details provided, implies file saved successfully)

#### Response Example
(No example provided)
```

--------------------------------

### Graph.forw_bfs_subgraph(_start_id_)

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Return a subgraph consisting of the breadth first reachable nodes from _start_id_ based on their outgoing edges.

```APIDOC
## Graph.forw_bfs_subgraph(_start_id_)

### Description
Return a subgraph consisting of the breadth first reachable nodes from _start_id_ based on their outgoing edges.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_start_id_** (type unspecified) - Required - The starting node ID for the BFS.
```

--------------------------------

### Graph.forw_topo_sort()

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Return a list of nodes where the successors (based on outgoing edges) of any given node appear in the sequence after that node.

```APIDOC
## Graph.forw_topo_sort()

### Description
Return a list of nodes where the successors (based on outgoing edges) of any given node appear in the sequence after that node.

### Method
Not specified (assumed to be a method call on a Graph object)
```

--------------------------------

### ObjectGraph.createNode()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Creates a new node in the object graph and returns its identifier. If a node with the same identifier already exists, it returns the existing node's identifier.

```APIDOC
## ObjectGraph.createNode()

### Description
Creates a new node in the object graph and returns its identifier. If a node with the same identifier already exists, it returns the existing node's identifier.

### Method
`createNode(ident)`

### Parameters
#### Path Parameters
- **ident** (any) - Required - The identifier for the new node.
```

--------------------------------

### ObjectGraph.msg()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Prints a debug message if debug output is enabled.

```APIDOC
## ObjectGraph.msg()

### Description
Prints a debug message if debug output is enabled.

### Method
`msg(message)`

### Parameters
#### Path Parameters
- **message** (str) - Required - The message to print.
```

--------------------------------

### Graph.back_topo_sort()

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Return a list of nodes where the successors (based on incoming edges) of any given node appear in the sequence after that node.

```APIDOC
## Graph.back_topo_sort()

### Description
Return a list of nodes where the successors (based on incoming edges) of any given node appear in the sequence after that node.

### Method
Not specified (assumed to be a method call on a Graph object)
```

--------------------------------

### altgraph.GraphUtil.filter_stack

Source: https://altgraph.readthedocs.io/en/latest/graphutil.html

Performs a depth-first walk of the graph and applies filter functions to node data.

```APIDOC
## altgraph.GraphUtil.filter_stack

### Description
Perform a depth-first oder walk of the graph starting at _head_ and apply all filter functions in _filters_ on the node data of the nodes found. Returns (_visited_ , _removes_ , _orphans_).

### Parameters
#### Path Parameters
- **_graph_** (Graph) - Required - The graph to traverse.
- **_head_** (Node) - Required - The starting node for the traversal.
- **_filters_** (list) - Required - A list of filter functions to apply to node data.

### Response
#### Success Response (200)
- **_visited_** (set) - The set of visited nodes.
- **_removes_** (list) - The list of nodes where the node data doesn’t match all _filters_.
- **_orphans_** (list) - List of tuples (_last_good_ , _node_), where node is not in _removes_ and one of the nodes that is connected by an incoming edge is in _removes_. _Last_good_ is the closest upstream node that is not in _removes_.
```

--------------------------------

### Graph.all_nbrs(_node_)

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns a list of nodes connected by an incoming or outgoing edge.

```APIDOC
## Graph.all_nbrs(_node_)

### Description
Returns a list of nodes connected by an incoming or outgoing edge.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_node_** (type unspecified) - Required - The node to find all connected neighbors for.
```

--------------------------------

### Edge Management

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Methods for adding, hiding, restoring, and querying edges in the graph.

```APIDOC
## Edge Management Methods

### Graph.add_edge

Adds a directed edge between two nodes. Nodes are created if they do not exist, unless `create_nodes` is set to `False`.

### Parameters
* **_head_id_** (hashable object) - Required - The source node of the edge.
* **_tail_id_** (hashable object) - Required - The destination node of the edge.
* **_edge_data_** (any) - Optional - Arbitrary data to associate with the edge.
* **_create_nodes_** (boolean) - Optional, defaults to True - Whether to create nodes if they don't exist.
```

```APIDOC
### Graph.hide_edge

Hides an edge from the graph.

### Parameters
* **_edge_** (edge identifier) - Required - The edge to hide.
```

```APIDOC
### Graph.restore_edge

Restores a previously hidden edge.

### Parameters
* **_edge_** (edge identifier) - Required - The edge to restore.
```

```APIDOC
### Graph.restore_all_edges

Restores all edges that were hidden, excluding those connected to hidden nodes.
```

```APIDOC
### Graph.edge_by_node

Returns the edge ID for an edge between two specified nodes, or `None` if no such edge exists.

### Parameters
* **_head_** (hashable object) - Required - The source node.
* **_tail_** (hashable object) - Required - The destination node.
```

```APIDOC
### Graph.edge_by_id

Returns the head and tail nodes of a given edge ID.

### Parameters
* **_edge_** (edge identifier) - Required - The edge ID.
```

```APIDOC
### Graph.edge_data

Returns the data associated with a given edge.

### Parameters
* **_edge_** (edge identifier) - Required - The edge whose data is to be retrieved.
```

```APIDOC
### Graph.update_edge_data

Replaces the data associated with an edge.

### Parameters
* **_edge_** (edge identifier) - Required - The edge to update.
* **_data_** (any) - Required - The new data for the edge.
```

```APIDOC
### Graph.head

Returns the head (source) node of an edge.

### Parameters
* **_edge_** (edge identifier) - Required - The edge.
```

```APIDOC
### Graph.tail

Returns the tail (destination) node of an edge.

### Parameters
* **_edge_** (edge identifier) - Required - The edge.
```

```APIDOC
### Graph.describe_edge

Returns the edge, its associated data, and its head and tail nodes.

### Parameters
* **_edge_** (edge identifier) - Required - The edge to describe.
```

```APIDOC
### Graph.number_of_edges

Returns the count of visible edges in the graph.
```

```APIDOC
### Graph.number_of_hidden_edges

Returns the count of hidden edges in the graph.
```

```APIDOC
### Graph.edge_list

Returns a list of all visible edges in the graph.
```

```APIDOC
### Graph.hidden_edge_list

Returns a list of all hidden edges in the graph.
```

--------------------------------

### ObjectGraph.nodes()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Returns a list of all nodes in the object graph.

```APIDOC
## ObjectGraph.nodes()

### Description
Returns a list of all nodes in the object graph.

### Method
`nodes()`
```

--------------------------------

### Check Graph Connectivity

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns True if every node in the graph can be reached from every other node, indicating a strongly connected graph.

```python
Graph.connected()
```

--------------------------------

### ObjectGraph.debug

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Enables or disables debug output for the ObjectGraph.

```APIDOC
## ObjectGraph.debug

### Description
Enables or disables debug output for the ObjectGraph.

### Property
`debug` (bool) - Set to `True` to enable debug output, `False` to disable.
```

--------------------------------

### altgraph.Dot.Dot Class

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Creates a new Dot generator based on the specified Graph. It allows for customization of graph attributes, node styles, and edge styles.

```APIDOC
## Class: altgraph.Dot.Dot

### Description
Creates a new Dot generator based on the specified `Graph`. The Dot generator won’t reference the _graph_ once it is constructed. It allows for customization of graph attributes, node styles, and edge styles.

### Parameters
* `_graph_`: The graph object to generate dot representation from.
* `_nodes_` (optional): A list of nodes to include in the graph.
* `_edgefn_` (optional): A function that yields nodes connected to another node.
* `_nodevisitor_` (optional): A function that returns the default style for a given node.
* `_edgevisitor_` (optional): A function that returns the default style for a given edge.
* `_name_` (optional): The name of the graph in the resulting dot file. Defaults to "G".
* `_dot_` (optional): Path to the dot command.
* `_dotty_` (optional): Path to the dotty command.
* `_neato_` (optional): Path to the neato command.
* `_graphtype_` (optional): Type of graph, either "digraph" (directed) or "graph" (non-directed). Defaults to "digraph".
```

--------------------------------

### Graph.inc_nbrs(_node_)

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Return a list of all nodes connected by incoming edges.

```APIDOC
## Graph.inc_nbrs(_node_)

### Description
Return a list of all nodes connected by incoming edges.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_node_** (type unspecified) - Required - The node to find incoming neighbors for.
```

--------------------------------

### __iter__

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Alias for the iterdot() method, yielding all lines of a graphviz input file.

```APIDOC
## __iter__

### Description
Alias for the `iterdot()` method. Yields all lines of a graphviz input file (including line endings).

### Method
(Not specified, likely a method call)

### Parameters
None

### Request Example
```python
for line in dot_instance:
    print(line)
```

### Response
#### Success Response (200)
Yields lines from the graphviz input file.

#### Response Example
(No example provided)
```

--------------------------------

### ObjectGraph.flatten()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Flattens the object graph into a list of nodes.

```APIDOC
## ObjectGraph.flatten()

### Description
Flattens the object graph into a list of nodes.

### Method
`flatten()`
```

--------------------------------

### ObjectGraph.get_edges()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Returns a list of all edges in the object graph.

```APIDOC
## ObjectGraph.get_edges()

### Description
Returns a list of all edges in the object graph.

### Method
`get_edges()`
```

--------------------------------

### Graph.connected()

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns True iff every node in the graph can be reached from every other node.

```APIDOC
## Graph.connected()

### Description
Returns True iff every node in the graph can be reached from every other node.

### Method
Not specified (assumed to be a method call on a Graph object)
```

--------------------------------

### Dot.style

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Sets the overall style (graph attributes) for the dot graph. This method allows customization of various graph-level attributes.

```APIDOC
## Method: Dot.style

### Description
Sets the overall style (graph attributes) to the given attributes. This method allows customization of various graph-level attributes like size, rank direction, and page settings.

### Parameters
* `_\**attr_`: Arbitrary keyword arguments representing graph attributes. See Valid Attributes for more information.

### Valid Attributes
* `size` (string): Specifies the size of the graph, e.g., '10,10'.
* `rankdir` (string): Determines the direction of the graph layout, e.g., 'LR' (left to right) or 'RL' (right to left).
* `page` (string): Sets the page size for the graph, e.g., '5,5'.
* `ranksep` (number): Defines the separation between ranks (levels) in the graph, e.g., 0.75.
```

--------------------------------

### Dot.all_node_style

Source: https://altgraph.readthedocs.io/en/latest/dot.html

Replaces the current style for all nodes in the dot graph with the specified attributes. This is useful for applying a uniform style across all nodes.

```APIDOC
## Method: Dot.all_node_style

### Description
Replaces the current style for all nodes with the given attributes. This method is useful for applying a uniform style across all nodes in the graph.

### Parameters
* `_\**attr_`: Arbitrary keyword arguments representing node attributes to be applied to all nodes. See Valid Attributes for more information.
```

--------------------------------

### Calculate Local Clustering Coefficient

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Returns the local clustering coefficient for a specified node. This measures the proportion of actual edges between a node's neighbors compared to the maximum possible edges.

```python
Graph.clust_coef(_node_)
```

--------------------------------

### Graph.out_nbrs(_node_)

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Return a list of all nodes connected by outgoing edges.

```APIDOC
## Graph.out_nbrs(_node_)

### Description
Return a list of all nodes connected by outgoing edges.

### Method
Not specified (assumed to be a method call on a Graph object)

### Parameters
#### Path Parameters
- **_node_** (type unspecified) - Required - The node to find outgoing neighbors for.
```

--------------------------------

### Compute Hop Distances

Source: https://altgraph.readthedocs.io/en/latest/graph.html

Computes the hop distance from a specified node to all other reachable nodes using BFS. The hop number corresponds to the shortest distance if all edge distances are 1.

```python
Graph.get_hops(_start_[, _end_[, _forward_]])
```

```python
>>> print graph.get_hops(1, 8)
>>> [(1, 0), (2, 1), (3, 1), (4, 2), (5, 3), (7, 4), (8, 5)]
```

--------------------------------

### ObjectGraph.filterStack()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Filters the stack of nodes based on certain criteria.

```APIDOC
## ObjectGraph.filterStack()

### Description
Filters the stack of nodes based on certain criteria.

### Method
`filterStack(stack)`

### Parameters
#### Path Parameters
- **stack** (list) - Required - The stack of nodes to filter.
```

--------------------------------

### ObjectGraph.getRawIdent()

Source: https://altgraph.readthedocs.io/en/latest/objectgraph.html

Retrieves the raw identifier associated with a node.

```APIDOC
## ObjectGraph.getRawIdent()

### Description
Retrieves the raw identifier associated with a node.

### Method
`getRawIdent(node)`

### Parameters
#### Path Parameters
- **node** (any) - Required - The node for which to retrieve the identifier.
```