bases
===============

.. py:module:: jaxns.samplers.bases

.. rubric:: :code:`jaxns.samplers.bases`


.. rubric:: Module Contents

.. py:class:: SeedPoint

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: U0
      :type:  jaxns.internals.types.FloatArray


   .. py:attribute:: log_L0
      :type:  jaxns.internals.types.FloatArray


.. py:data:: T

.. py:class:: BaseAbstractRejectionSampler

   Bases: :py:obj:`jaxns.samplers.abc.AbstractSampler`\ [\ :py:obj:`T`\ ], :py:obj:`Generic`\ [\ :py:obj:`T`\ ]


   Helper class that provides a standard way to create an ABC using
   inheritance.


.. py:class:: BaseAbstractMarkovSampler

   Bases: :py:obj:`jaxns.samplers.abc.AbstractSampler`\ [\ :py:obj:`T`\ ], :py:obj:`Generic`\ [\ :py:obj:`T`\ ]


   A sampler that conditions off a known satisfying point, e.g. a seed point.


   .. py:method:: get_sample_from_seed(key, seed_point, log_L_constraint, sampler_state)
      :abstractmethod:


      Produce a single i.i.d. sample from the model within the log_L_constraint.

      :param key: PRNGkey
      :param seed_point: function that gets the next sample from a seed point
      :param log_L_constraint: the constraint to sample within
      :param sampler_state: the data pytree needed and produced by the sampler

      :returns: an i.i.d. sample, and batched phantom samples



   .. py:method:: get_seed_point(key, sampler_state, log_L_constraint)
      :abstractmethod:


      Samples a seed point from the live points.

      :param key: PRNGKey
      :param sampler_state: the current sampler state
      :param log_L_constraint: a log-L constraint to sample within. Must always be at least one sample in front above
                               this to avoid infinite loop.

      :returns: a seed point