nessai.utils.sorting
====================

.. py:module:: nessai.utils.sorting

.. autoapi-nested-parse::

   Utilities for sorting.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   nessai.utils.sorting.sort_reparameterisations


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

.. py:function:: sort_reparameterisations(reparameterisations: List[nessai.reparameterisations.Reparameterisation], existing_parameters: Optional[List[str]] = None, known_parameters: Optional[List[str]] = None, initial_sort: bool = True) -> List[nessai.reparameterisations.Reparameterisation]

   
   Sort reparameterisations based on their parameters and requirements.


   :Parameters:

       **reparameterisations** : List[Reparameterisation]
           List of reparameterisations.

       **existing_parameters** : Optional[List[str]]
           List of parameters that are all included.

       **known_parameters** : Optional[List[str]]
           List of all known parameters. If not specified it is inferred from the
           list of reparameterisations.

       **initial_sort** : bool
           Toggle initial sorting by the number of requirements.



   :Returns:

       List[Reparameterisation]
           Sorted list of reparameterisations.




   :Raises:

       ValueError
           If a required parameter is missing from the known parameters.







   ..
       !! processed by numpydoc !!