nessai.reparameterisations.utils
================================

.. py:module:: nessai.reparameterisations.utils

.. autoapi-nested-parse::

   Utilities for handling the reparameterisations.

   ..
       !! processed by numpydoc !!


Exceptions
----------

.. autoapisummary::

   nessai.reparameterisations.utils.ReparameterisationError


Classes
-------

.. autoapisummary::

   nessai.reparameterisations.utils.KnownReparameterisation
   nessai.reparameterisations.utils.ReparameterisationDict


Functions
---------

.. autoapisummary::

   nessai.reparameterisations.utils.get_reparameterisation


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

.. py:exception:: ReparameterisationError

   Bases: :py:obj:`RuntimeError`


   
   Exception for reparameterisation errors
















   ..
       !! processed by numpydoc !!

.. py:class:: KnownReparameterisation

   
   Dataclass to store the reparameterisation class and keyword arguments
















   ..
       !! processed by numpydoc !!

.. py:class:: ReparameterisationDict

   Bases: :py:obj:`dict`


   
   Dictionary of reparameterisations

   This dictionary is used to store the known reparameterisations and
   provides a method to add new reparameterisations.















   ..
       !! processed by numpydoc !!

   .. py:method:: add_reparameterisation(name, class_fn, keyword_arguments=None)

      
      Add a new reparameterisation to the dictionary


      :Parameters:

          **name** : str
              Name of the reparameterisation.

          **class_fn** : Reparameterisation
              Reparameterisation class.

          **keyword_arguments** : dict, optional
              Keyword arguments for the reparameterisation.














      ..
          !! processed by numpydoc !!


.. py:function:: get_reparameterisation(reparameterisation, defaults=None)

   
   Function to get a reparameterisation class from a name


   :Parameters:

       **reparameterisation** : str,             :obj:`nessai.reparameterisations.Reparameterisation`
           Name of the reparameterisations to return or a class that inherits from
           :obj:`~nessai.reparameterisations.Reparameterisation`

       **defaults** : dict, optional
           Dictionary of known reparameterisations that overrides the defaults.



   :Returns:

       :obj:`nessai.reparameteristaions.Reparameterisation`
           Reparameterisation class.

       dict
           Keyword arguments for the specific reparameterisation.











   ..
       !! processed by numpydoc !!