jexplore.steps.step
===================

.. py:module:: jexplore.steps.step

.. autoapi-nested-parse::

   This module define the :py:attr:`jexplore.steps.step.Step` class
   which is the base class for all steps.



Classes
-------

.. autoapisummary::

   jexplore.steps.step.Step


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

.. py:class:: Step[Tepoch: jexplore.sampling.Epoch, Tstate: jexplore.sampling.State, Tsampling: jexplore.sampling.Sampling]

   This is the base step definition class. It provides a generic epoch initialization
   method `builder`, some general methods and a placeholder for the step method.


   .. py:attribute:: epoch
      :type:  Tepoch

      current epoch


   .. py:attribute:: sampling
      :type:  Tsampling

      sampling parameters


   .. py:method:: step(key, state)
      :abstractmethod:


      Step sampling method. This is just a prototype.

      :param key: PRNG key
      :param state: current state

      :return: new state and the boolean mask of the chains modified by the step.



   .. py:method:: build(epoch)

      Epoch initialisation method.

      :param epoch: current epoch.



   .. py:method:: builder(epoch)

      This method updates the step object state according to
      the current epoch, calling the `build` method, and
      returning the pointer to the `step` method.
      In principle this base implementation is general and
      does not need to be overridden or extended (rather extend the
      `build` method).

      :param epoch: epoch.

      :return: pointer to this class `step` method.



   .. py:method:: get_accepted(key, logacc)
      :staticmethod:


      Given a set of log acceptance values, draws a correspondng set of
      log uniform values and returns the acceptance mask.

      :param key: PRNG key
      :param logacc: set of log acceptance values

      :return: new PNRG key and acceptance mask.