.. _f-graphdistance:

module ``graph.graph_distance``
===============================





.. inheritance-diagram:: mlstatpy.graph.graph_distance


Short summary
+++++++++++++

module ``mlstatpy.graph.graph_distance``

First approach for a edit distance between two graphs.

See :ref:`l-graph_distance`.


:githublink:`%|py|8`




Classes
+++++++

+----------------------------------------------------------------------+-----------------------------------------------------------+
| class                                                                | truncated documentation                                   |
+======================================================================+===========================================================+
| :class:`_Edge <mlstatpy.graph.graph_distance._Edge>`                 |                                                           |
+----------------------------------------------------------------------+-----------------------------------------------------------+
| :class:`_Vertex <mlstatpy.graph.graph_distance._Vertex>`             |                                                           |
+----------------------------------------------------------------------+-----------------------------------------------------------+
| :class:`Edge <mlstatpy.graph.graph_distance.Edge>`                   | Defines an edge of a graph.                               |
+----------------------------------------------------------------------+-----------------------------------------------------------+
| :class:`GraphDistance <mlstatpy.graph.graph_distance.GraphDistance>` | Defines a graph to compute a distance between two graphs. |
+----------------------------------------------------------------------+-----------------------------------------------------------+
| :class:`Vertex <mlstatpy.graph.graph_distance.Vertex>`               | Defines a vertex of a graph.                              |
+----------------------------------------------------------------------+-----------------------------------------------------------+






Properties
++++++++++

+------------------------------------------------------------+-------------------------+
| property                                                   | truncated documentation |
+============================================================+=========================+
| :meth:`Label <mlstatpy.graph.graph_distance.Edge.Label>`   | returns the label       |
+------------------------------------------------------------+-------------------------+
| :meth:`Label <mlstatpy.graph.graph_distance.Vertex.Label>` | returns the label       |
+------------------------------------------------------------+-------------------------+




Static Methods
++++++++++++++

+-------------------------------------------------------------------------------------------------+---------------------------+
| staticmethod                                                                                    | truncated documentation   |
+=================================================================================================+===========================+
| :meth:`get_list_of_vertices <mlstatpy.graph.graph_distance.GraphDistance.get_list_of_vertices>` |                           |
+-------------------------------------------------------------------------------------------------+---------------------------+
| :meth:`load_from_file <mlstatpy.graph.graph_distance.GraphDistance.load_from_file>`             | loads a graph from a file |
+-------------------------------------------------------------------------------------------------+---------------------------+




Methods
+++++++

+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| method                                                                                                               | truncated documentation                                                 |
+======================================================================================================================+=========================================================================+
| :py:meth:`__getitem__ <mlstatpy.graph.graph_distance.GraphDistance.__getitem__>`                                     | returns a vertex or an edge if no vertex with the given index was found |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.graph.graph_distance.Edge.__init__>`                                                    |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.graph.graph_distance.GraphDistance.__init__>`                                           | constructor                                                             |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.graph.graph_distance.Vertex.__init__>`                                                  | constructor                                                             |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.graph.graph_distance._Edge.__init__>`                                                   |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__init__ <mlstatpy.graph.graph_distance._Vertex.__init__>`                                                 |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__repr__ <mlstatpy.graph.graph_distance.Edge.__repr__>`                                                    | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__repr__ <mlstatpy.graph.graph_distance.GraphDistance.__repr__>`                                           | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__repr__ <mlstatpy.graph.graph_distance.Vertex.__repr__>`                                                  | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__str__ <mlstatpy.graph.graph_distance.Edge.__str__>`                                                      | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__str__ <mlstatpy.graph.graph_distance.GraphDistance.__str__>`                                             | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`__str__ <mlstatpy.graph.graph_distance.Vertex.__str__>`                                                    | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`_private__init__ <mlstatpy.graph.graph_distance.GraphDistance._private__init__>`                           |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :py:meth:`_private_string_path_matching <mlstatpy.graph.graph_distance.GraphDistance._private_string_path_matching>` |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`clean_dead_ends <mlstatpy.graph.graph_distance.GraphDistance.clean_dead_ends>`                                |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`common_paths <mlstatpy.graph.graph_distance.GraphDistance.common_paths>`                                      |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`compute_predecessor <mlstatpy.graph.graph_distance.GraphDistance.compute_predecessor>`                        | usual                                                                   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`compute_successor <mlstatpy.graph.graph_distance.GraphDistance.compute_successor>`                            |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`connect_root_and_leave <mlstatpy.graph.graph_distance.GraphDistance.connect_root_and_leave>`                  |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`distance_matching_graphs_paths <mlstatpy.graph.graph_distance.GraphDistance.distance_matching_graphs_paths>`  | Computes an alignment between two graphs.                               |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`draw_vertices_edges <mlstatpy.graph.graph_distance.GraphDistance.draw_vertices_edges>`                        |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`edit_distance_path <mlstatpy.graph.graph_distance.GraphDistance.edit_distance_path>`                          | Tries to align two paths from two graphs.                               |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`enumerate_all_paths <mlstatpy.graph.graph_distance.GraphDistance.enumerate_all_paths>`                        |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`get_matching_functions <mlstatpy.graph.graph_distance.GraphDistance.get_matching_functions>`                  | returns default matching functions between two vertices and two edges   |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`get_order_vertices <mlstatpy.graph.graph_distance.GraphDistance.get_order_vertices>`                          |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`is_edge <mlstatpy.graph.graph_distance.Edge.is_edge>`                                                         | returns True                                                            |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`is_edge <mlstatpy.graph.graph_distance.Vertex.is_edge>`                                                       | returns False                                                           |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`is_vertex <mlstatpy.graph.graph_distance.Edge.is_vertex>`                                                     | returns False                                                           |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`is_vertex <mlstatpy.graph.graph_distance.Vertex.is_vertex>`                                                   | returns True                                                            |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`private_count_left_right <mlstatpy.graph.graph_distance.GraphDistance.private_count_left_right>`              |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`private_kruskal_matrix <mlstatpy.graph.graph_distance.GraphDistance.private_kruskal_matrix>`                  |                                                                         |
+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mlstatpy.graph.graph_distance
    :members:
    :special-members: __init__
    :show-inheritance: