Commit f98dd1e7 by Eric Coissac

doc

parent f13f701f
.. automodule:: obitools.graph.algorithms.component
Functions
^^^^^^^^^
Connected component iterator
............................
.. autofunction:: componentIterator
Counting connected component in a graph
.......................................
.. autofunction:: componentCount
Algorithms applicable to graphs
===============================
the module :py:mod:`obitools.graph.algoriths` provides a set of algorithms
applicable to :py:class:`obitools.graph.Graph` instances.
.. toctree::
:maxdepth: 2
clique
component
compact
Graph representation
====================
.. toctree::
:maxdepth: 2
dag
unrooted
algorithms/index
layout/index
.. automodule:: obitools.graph
Classes
^^^^^^^
Basic graph
...........
.. autoclass:: Graph
:members:
Directed graph
..............
.. autoclass:: DiGraph
:members:
Undirected graph
................
.. autoclass:: UndirectedGraph
:members:
The nodes or vertice of a graph
...............................
.. autoclass:: Node
:members:
The edges of a graph
....................
.. autoclass:: Edge
:members:
The Indexer utility class
.........................
.. autoclass:: Indexer
:members:
.. automethod:: __getitem__
.. automethod:: __equal__
......@@ -5,4 +5,5 @@ obitools module programming interface
:maxdepth: 2
sequences/index
graph/index
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment