Algebra
=======

Polynomial classes and numerics
-------------------------------

Class
^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.BinaryPoly
    amplify.BinaryIntPoly
    amplify.IsingPoly
    amplify.IsingIntPoly

Function
^^^^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.replace_all
    amplify.sum_poly
    amplify.pair_sum
    amplify.product
    amplify.intersection
    amplify.union
    amplify.symmetric_difference


Polynomial Array
----------------

Class
^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.BinaryPolyArray
    amplify.BinaryIntPolyArray
    amplify.IsingPolyArray
    amplify.IsingIntPolyArray

Function
^^^^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.einsum


Symbol Generator
----------------

Class
^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.BinarySymbolGenerator
    amplify.BinaryIntSymbolGenerator
    amplify.IsingSymbolGenerator
    amplify.IsingIntSymbolGenerator

Function
^^^^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.SymbolGenerator
    amplify.gen_symbols
    amplify.decode_solution


Matrix Representation
---------------------

Class
^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.BinaryMatrix
    amplify.BinaryIntMatrix
    amplify.IsingMatrix
    amplify.IsingIntMatrix

Function
^^^^^^^^
.. autosummary::
    :toctree: generated/
    :nosignatures:

    amplify.convert_to_matrix