Reference Documentation
***********************

.. currentmodule:: dwave.samplers

Planar
======

PlanarGraphSolver
-----------------

.. autoclass:: PlanarGraphSolver

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~PlanarGraphSolver.parameters
   ~PlanarGraphSolver.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~PlanarGraphSolver.sample
   ~PlanarGraphSolver.sample_ising
   ~PlanarGraphSolver.sample_qubo


Random
=======

RandomSampler
-------------

.. autoclass:: RandomSampler

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~RandomSampler.parameters
   ~RandomSampler.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~RandomSampler.sample
   ~RandomSampler.sample_ising
   ~RandomSampler.sample_qubo


Simulated Annealing
===================

SimulatedAnnealingSampler
-------------------------

.. autoclass:: SimulatedAnnealingSampler

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SimulatedAnnealingSampler.parameters
   ~SimulatedAnnealingSampler.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SimulatedAnnealingSampler.sample
   ~SimulatedAnnealingSampler.sample_ising
   ~SimulatedAnnealingSampler.sample_qubo

Alias
~~~~~

.. autoclass:: Neal


Steepest Descent
================

SteepestDescentSolver
---------------------

.. autoclass:: SteepestDescentSolver

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SteepestDescentSolver.parameters
   ~SteepestDescentSolver.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SteepestDescentSolver.sample
   ~SteepestDescentSolver.sample_ising
   ~SteepestDescentSolver.sample_qubo

Alias
~~~~~

.. autoclass:: SteepestDescentSampler


SteepestDescentComposite
------------------------

.. autoclass:: SteepestDescentComposite

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SteepestDescentComposite.parameters
   ~SteepestDescentComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SteepestDescentComposite.sample
   ~SteepestDescentComposite.sample_ising
   ~SteepestDescentComposite.sample_qubo

Tabu
====

TabuSampler
-----------

.. autoclass:: TabuSampler

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~TabuSampler.parameters
   ~TabuSampler.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~TabuSampler.sample
   ~TabuSampler.sample_ising
   ~TabuSampler.sample_qubo

Tree Decomposition
==================

TreeDecompositionSolver
-----------------------

.. autoclass:: TreeDecompositionSolver

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~TreeDecompositionSolver.parameters
   ~TreeDecompositionSolver.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~TreeDecompositionSolver.sample
   ~TreeDecompositionSolver.sample_ising
   ~TreeDecompositionSolver.sample_qubo

TreeDecompositionSampler
------------------------

.. autoclass:: TreeDecompositionSampler

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~TreeDecompositionSampler.parameters
   ~TreeDecompositionSampler.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~TreeDecompositionSampler.sample
   ~TreeDecompositionSampler.sample_ising
   ~TreeDecompositionSampler.sample_qubo