Documentation
=============

The following methods are available in the ``gcol`` graph coloring library. All methods containing the word ``color`` in their name can also be invoked using the alternative spelling ``colour``.

Edge Coloring
-------------
.. automodule:: gcol.edge_coloring
   :members:
   :exclude-members: edge_colouring, edge_k_colouring, edge_precolouring, equitable_edge_k_colouring, edge_list_colouring

Face Coloring
-------------
.. automodule:: gcol.face_coloring
   :members:
   :exclude-members: face_colouring, face_k_colouring, face_precolouring, equitable_face_k_colouring, face_list_colouring

Node Coloring
-------------
.. automodule:: gcol.node_coloring
   :members:
   :exclude-members: equitable_node_k_colouring, min_cost_k_colouring, node_colouring, node_k_colouring, node_precolouring, node_list_colouring

Output
------
.. automodule:: gcol.output
   :members:
   :exclude-members: colouring_layout, get_edge_colours, get_node_colours, get_set_colours, draw_face_colouring