.. automodule:: graph_tool

   .. autoclass:: Graph

       .. automethod:: copy

       .. container:: sec_title

           Iterating over vertices and edges

       See :ref:`sec_iteration` for more documentation and examples.

       .. automethod:: vertices
       .. automethod:: edges

       .. container:: sec_title

           Obtaining vertex and edge descriptors

       .. automethod:: vertex
       .. automethod:: edge

       .. container:: sec_title

           Number of vertices and edges

       .. automethod:: num_vertices
       .. automethod:: num_edges

       .. container:: sec_title

           Modifying vertices and edges

       The following functions allow for addition and removal of
       vertices in the graph.

       .. automethod:: add_vertex
       .. automethod:: remove_vertex

       The following functions allow for addition and removal of
       edges in the graph.

       .. automethod:: add_edge
       .. automethod:: remove_edge

       The following functions allow for easy removal of vertices of
       edges from the graph.

       .. automethod:: clear
       .. automethod:: clear_vertex
       .. automethod:: clear_edges


       .. container:: sec_title

           Directedness and reversal of edges

       .. note::

           These functions do not actually modify the graph, and are fully
           reversible. They are also very cheap, and have an :math:`O(1)`
           complexity.

       .. automethod:: set_directed
       .. automethod:: is_directed

       .. automethod:: set_reversed
       .. automethod:: is_reversed


       .. container:: sec_title

           Creation of new property maps

       .. automethod:: new_property
       .. automethod:: new_vertex_property
       .. automethod:: new_edge_property
       .. automethod:: new_graph_property

       New property maps can be created by copying already existing
       ones.

       .. automethod:: copy_property

       .. automethod:: degree_property_map

       .. container:: sec_title

           Index property maps

       .. autoattribute:: vertex_index
       .. autoattribute:: edge_index
       .. autoattribute:: max_edge_index
       .. automethod:: reindex_edges

       .. container:: sec_title

           Internal property maps

       Internal property maps are just like regular property maps, with
       the only exception that they are saved and loaded to/from files
       together with the graph itself. See :ref:`internal property maps <sec_internal_props>`
       for more details.

       .. note::

           All dictionaries below are mutable. However, any dictionary
           returned below is only an one-way proxy to the internally-kept
           properties. If you modify this object, the change will be
           propagated to the internal dictionary, but not
           vice-versa. Keep this in mind if you intend to keep a copy of
           the returned object.

       .. autoattribute:: properties
       .. autoattribute:: vertex_properties
       .. autoattribute:: vp
       .. autoattribute:: edge_properties
       .. autoattribute:: ep
       .. autoattribute:: graph_properties
       .. autoattribute:: gp
       .. automethod:: list_properties


       .. container:: sec_title

           Filtering of vertices and edges.

       See :ref:`sec_graph_filtering` for more details.

       .. note::

           These functions do not actually modify the graph, and are fully
           reversible. They are also very cheap, and have an :math:`O(1)`
           complexity.

       .. automethod:: set_vertex_filter
       .. automethod:: get_vertex_filter
       .. automethod:: set_edge_filter
       .. automethod:: get_edge_filter

       .. warning::

          The purge functions below irreversibly remove the filtered
          vertices or edges from the graph, and return it to an
          unfiltered state. Note that, contrary to the functions above,
          these are :math:`O(V)` and :math:`O(E)` operations,
          respectively.

       .. automethod:: purge_vertices
       .. automethod:: purge_edges

       .. container:: sec_title

           Stashing and popping the filter state

       .. automethod:: stash_filter
       .. automethod:: pop_filter

       .. automethod:: get_filter_state
       .. automethod:: set_filter_state

       .. container:: sec_title

           I/O operations

       See :ref:`sec_graph_io` for more details.

       .. automethod:: load
       .. automethod:: save



   .. autoclass:: GraphView
       :show-inheritance:
       :members:
   .. autoclass:: Vertex
       :members:
   .. autoclass:: Edge
       :members:
   .. autoclass:: PropertyMap
       :members:
   .. autoclass:: PropertyArray
       :show-inheritance:
       :members: prop_map
   .. autofunction:: load_graph
   .. autofunction:: group_vector_property
   .. autofunction:: ungroup_vector_property
   .. autofunction:: infect_vertex_property
   .. autofunction:: edge_difference
   .. autofunction:: value_types
   .. autofunction:: show_config


Available subpackages
=====================

.. toctree::
   :maxdepth: 1

   centrality
   clustering
   collection
   community
   correlations
   draw
   flow
   generation
   run_action
   search_module
   spectral
   stats
   topology
   util