leaspy.exceptions
=================

.. py:module:: leaspy.exceptions

.. autoapi-nested-parse::

   Define custom Leaspy exceptions for better downstream handling.

   Exceptions classes are nested so to handle in the most convenient way for users::

                       Exception
                           |
                           |
                     LeaspyException        RuntimeError
                           |         \            |
                           |           LeaspyConvergenceError
                          / \
            TypeError    /   \     ValueError
                |       /     \        |
         LeaspyTypeError      LeaspyInputError
                             /    |    |      \
                            /     |    |  LeaspyIndividualParamsInputError
                           /      |    |
       LeaspyDataInputError       |  LeaspyAlgoInputError
                                  |
                       LeaspyModelInputError

   For I/O operations, non-Leaspy specific errors may be raised, in particular:
       * :class:`FileNotFoundError`
       * :class:`NotADirectoryError`

   ..
       !! processed by numpydoc !!


Exceptions
----------

.. autoapisummary::

   leaspy.exceptions.LeaspyException
   leaspy.exceptions.LeaspyConvergenceError
   leaspy.exceptions.LeaspyTypeError
   leaspy.exceptions.LeaspyInputError
   leaspy.exceptions.LeaspyDataInputError
   leaspy.exceptions.LeaspyModelInputError
   leaspy.exceptions.LeaspyAlgoInputError
   leaspy.exceptions.LeaspyIndividualParamsInputError


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

.. py:exception:: LeaspyException

   Bases: :py:obj:`Exception`


   
   Base of all Leaspy exceptions.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyConvergenceError

   Bases: :py:obj:`LeaspyException`, :py:obj:`RuntimeError`


   
   Leaspy Exception for errors relative to convergence.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyTypeError

   Bases: :py:obj:`LeaspyException`, :py:obj:`TypeError`


   
   Leaspy Exception, deriving from `TypeError`.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyInputError

   Bases: :py:obj:`LeaspyException`, :py:obj:`ValueError`


   
   Leaspy Exception, deriving from `ValueError`.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyDataInputError

   Bases: :py:obj:`LeaspyInputError`


   
   Leaspy Input Error for data related issues.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyModelInputError

   Bases: :py:obj:`LeaspyInputError`


   
   Leaspy Input Error for model related issues.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyAlgoInputError

   Bases: :py:obj:`LeaspyInputError`


   
   Leaspy Input Error for algorithm related issues.
















   ..
       !! processed by numpydoc !!

.. py:exception:: LeaspyIndividualParamsInputError

   Bases: :py:obj:`LeaspyInputError`


   
   Leaspy Input Error for individual parameters related issues.
















   ..
       !! processed by numpydoc !!