.. _preprocessing_composites:

==========
Composites
==========

The `dwave-preprocessing` package includes several composites:

.. automodule:: dwave.preprocessing.composites

....

Connected Components Composite
------------------------------

Class
~~~~~

.. autoclass:: ConnectedComponentsComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~ConnectedComponentsComposite.child
   ~ConnectedComponentsComposite.children
   ~ConnectedComponentsComposite.parameters
   ~ConnectedComponentsComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~ConnectedComponentsComposite.sample
   ~ConnectedComponentsComposite.sample_ising
   ~ConnectedComponentsComposite.sample_qubo

....

Clip Composite
--------------

Class
~~~~~

.. autoclass:: ClipComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~ClipComposite.child
   ~ClipComposite.children
   ~ClipComposite.parameters
   ~ClipComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~ClipComposite.sample
   ~ClipComposite.sample_ising
   ~ClipComposite.sample_qubo

....

Fix Variables Composite
------------------------

Class
~~~~~

.. autoclass:: FixVariablesComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~FixVariablesComposite.child
   ~FixVariablesComposite.children
   ~FixVariablesComposite.parameters
   ~FixVariablesComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~FixVariablesComposite.sample
   ~FixVariablesComposite.sample_ising
   ~FixVariablesComposite.sample_qubo

....

Scale Composite
---------------

Class
~~~~~

.. autoclass:: ScaleComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~ScaleComposite.child
   ~ScaleComposite.children
   ~ScaleComposite.parameters
   ~ScaleComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~ScaleComposite.sample
   ~ScaleComposite.sample_ising
   ~ScaleComposite.sample_qubo

....

Spin Reversal Transform Composite
---------------------------------

Class
~~~~~

.. autoclass:: SpinReversalTransformComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SpinReversalTransformComposite.child
   ~SpinReversalTransformComposite.children
   ~SpinReversalTransformComposite.parameters
   ~SpinReversalTransformComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   ~SpinReversalTransformComposite.sample
   ~SpinReversalTransformComposite.sample_ising
   ~SpinReversalTransformComposite.sample_qubo
