qemcmc.sampler.proposal
=======================

.. py:module:: qemcmc.sampler.proposal


Classes
-------

.. autoapisummary::

   qemcmc.sampler.proposal.Proposal


Module Contents
---------------

.. py:class:: Proposal(model: qemcmc.model.EnergyModel)

   Bases: :py:obj:`abc.ABC`


   Abstract base class for producing proposals for Markov Chain Monte Carlo algorithms.

   Subclasses implement the proposal mechanism by defining an
   ``update(state)`` method that generates a candidate state from the current one
   (e.g. single-spin flips, block updates, or quantum proposals).

   :param model: Energy model defining the target distribution over spin configurations.
   :type model: EnergyModel


   .. py:attribute:: model


   .. py:attribute:: n_spins


   .. py:method:: update(state: qemcmc.utils.MCMCState) -> qemcmc.utils.MCMCState
      :abstractmethod:


      Generate a candidate state from the current state using the proposal mechanism.

      This method should be implemented by subclasses to define the specific proposal strategy
      (e.g., single-spin flips, block updates, or quantum proposals).

      :param state: The current state of the Markov chain.
      :type state: MCMCState

      :returns: A new candidate state.
      :rtype: MCMCState