API reference
=============

Public API
----------

.. autofunction:: gasm.match

.. autoclass:: gasm.Matching
   :members:
   :special-members: __len__, __iter__

.. autoclass:: gasm.Attribute
   :members:

.. autofunction:: gasm.accuracy

.. autofunction:: gasm.structural_quality

Graphs
------

.. automodule:: gasm.graph
   :members:

Attributes
----------

.. automodule:: gasm.attributes
   :members:
   :exclude-members: Attribute

Metrics
-------

.. automodule:: gasm.metrics
   :members:

Convergence
-----------

.. automodule:: gasm.convergence
   :members:

Linear assignment solvers
-------------------------

.. automodule:: gasm.lap
   :members:

.. automodule:: gasm.lap.jv
   :members:

.. automodule:: gasm.lap.auction
   :members:

CPU back-end
------------

.. automodule:: gasm.cpu.core
   :members:

GPU back-end
------------

.. automodule:: gasm.gpu.core
   :members:

Warnings
--------

.. automodule:: gasm.utils
   :members: