=================
API Documentation
=================

acopy package
=============

.. automodule:: acopy
    :members:
    :undoc-members:
    :show-inheritance:

acopy.ant module
----------------

.. automodule:: acopy.ant
    :members:
    :undoc-members:
    :show-inheritance:

acopy.solvers module
--------------------

.. automodule:: acopy.solvers
    :members:
    :undoc-members:
    :show-inheritance:


acopy.utils package
===================

.. automodule:: acopy.utils
    :members:
    :undoc-members:
    :show-inheritance:


acopy.utils.data module
-----------------------

.. automodule:: acopy.utils.data
    :members:
    :undoc-members:
    :show-inheritance:


acopy.utils.general module
--------------------------

.. automodule:: acopy.utils.general
    :members:
    :undoc-members:
    :show-inheritance:


acopy.utils.plot module
-----------------------

The plot utility works with the StatsRecorder plugin to generate interesting plots of solver iterations.

.. image:: images/pheromone-levels.*
    :width: 48%

.. image:: images/pheromone-stats.*
    :width: 48%

.. image:: images/uniqueness.*
    :width: 48%

.. image:: images/solutions.*
    :width: 48%


.. automodule:: acopy.utils.plot
    :members:
    :undoc-members:
    :show-inheritance:
