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

The ``montecarlo`` package exposes three top-level classes.

BitString
---------

.. autoclass:: montecarlo.BitString
   :members:
   :undoc-members:
   :show-inheritance:

IsingHamiltonian
----------------

.. autoclass:: montecarlo.IsingHamiltonian
   :members:
   :undoc-members:
   :show-inheritance:

MonteCarlo
----------

.. autoclass:: montecarlo.MonteCarlo
   :members:
   :undoc-members:
   :show-inheritance: