jexplore.sampling.base
======================

.. py:module:: jexplore.sampling.base

.. autoapi-nested-parse::

   This module provides the definitions of the base
   :py:attr:`jexplore.sampling.state.Sampling` class.



Classes
-------

.. autoapisummary::

   jexplore.sampling.base.Sampling


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

.. py:class:: Sampling[Tspace: jexplore.sampling.space.Space](nchain, dim = None, space = None)

   Markov sampling defining parameters.

   In this base class version the parameter are the dimension of the
   target space and the number of chains. Child classes may specialize
   to specific type of markov sampling (e.g.
   :py:attr:`jexplore.sampling.mh.SamplingMH`)

   :param dim: dimension of the target space.
   :param nchains: number of chains.
   :param space: :py:attr:`jexplore.sampling.space` object
                 describing the target space.

   the state will then be defined by a (nchain, dim) point


   .. py:attribute:: dim
      :type:  int

      Dimension of the target space


   .. py:attribute:: nchain
      :type:  int

      Number of chains


   .. py:attribute:: space
      :type:  Tspace | jexplore.sampling.space.Box

      Target space.


   .. py:method:: to_backend()

      Save the attributes of the object in
      backend format.