nessai.reparameterisations.base
===============================

.. py:module:: nessai.reparameterisations.base

.. autoapi-nested-parse::

   Base reparameterisation

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   nessai.reparameterisations.base.Reparameterisation


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

.. py:class:: Reparameterisation(parameters=None, prior_bounds=None, rng=None)

   
   Base object for reparameterisations.


   :Parameters:

       **parameters** : str or list
           Name of parameters to reparameterise.

       **prior_bounds** : list, dict or None
           Prior bounds for the parameter(s).














   ..
       !! processed by numpydoc !!

   .. py:property:: name

      
      Unique name of the reparameterisations
















      ..
          !! processed by numpydoc !!


   .. py:method:: reparameterise(x, x_prime, log_j)
      :abstractmethod:


      
      Apply the reparameterisation to convert from x-space to x'-space.


      :Parameters:

          **x** : structured array
              Array of inputs

          **x_prime** : structured array
              Array to be update

          **log_j** : array_like
              Log jacobian to be updated



      :Returns:

          **x, x_prime** : structured arrays
              Update version of the x and x_prime arrays

          **log_j** : array_like
              Updated log Jacobian determinant











      ..
          !! processed by numpydoc !!


   .. py:method:: inverse_reparameterise(x, x_prime, log_j)
      :abstractmethod:


      
      Apply the reparameterisation to convert from x-space
      to x'-space


      :Parameters:

          **x** : structured array
              Array

          **x_prime** : structured array
              Array to be update

          **log_j** : array_like
              Log jacobian to be updated



      :Returns:

          **x, x_prime** : structured arrays
              Update version of the x and x_prime arrays

          **log_j** : array_like
              Updated log Jacobian determinant











      ..
          !! processed by numpydoc !!


   .. py:method:: update(x)

      
      Update the reparameterisation given some points.

      Does nothing by default.















      ..
          !! processed by numpydoc !!


   .. py:method:: reset()

      
      Reset the reparameterisation.

      Does nothing by default.















      ..
          !! processed by numpydoc !!