.. _higher_order_composites:

=======================
Higher-Order Composites
=======================

The `dimod` package includes several example higher-order composed samplers.

.. currentmodule:: dimod.reference.composites

HigherOrderComposite
====================

.. autoclass:: HigherOrderComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   HigherOrderComposite.child
   HigherOrderComposite.children
   HigherOrderComposite.parameters
   HigherOrderComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   HigherOrderComposite.sample_poly
   HigherOrderComposite.sample_hising
   HigherOrderComposite.sample_hubo

PolyFixedVariableComposite
==========================

.. autoclass:: PolyFixedVariableComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   PolyFixedVariableComposite.child
   PolyFixedVariableComposite.children
   PolyFixedVariableComposite.parameters
   PolyFixedVariableComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   PolyFixedVariableComposite.sample_poly
   PolyFixedVariableComposite.sample_hising
   PolyFixedVariableComposite.sample_hubo

PolyScaleComposite
==================

.. autoclass:: PolyScaleComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   PolyScaleComposite.child
   PolyScaleComposite.children
   PolyScaleComposite.parameters
   PolyScaleComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   PolyScaleComposite.sample_poly
   PolyScaleComposite.sample_hising
   PolyScaleComposite.sample_hubo

PolyTruncateComposite
=====================

.. autoclass:: PolyTruncateComposite

Properties
~~~~~~~~~~

.. autosummary::
   :toctree: generated/

   PolyTruncateComposite.child
   PolyTruncateComposite.children
   PolyTruncateComposite.parameters
   PolyTruncateComposite.properties

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/

   PolyTruncateComposite.sample_poly
   PolyTruncateComposite.sample_hising
   PolyTruncateComposite.sample_hubo