auto_uncertainties.exceptions
=============================

.. py:module:: auto_uncertainties.exceptions


Exceptions
----------

.. autoapisummary::

   auto_uncertainties.exceptions.NegativeStdDevError
   auto_uncertainties.exceptions.DowncastError
   auto_uncertainties.exceptions.DowncastWarning
   auto_uncertainties.exceptions.EqualityWarning
   auto_uncertainties.exceptions.EqualityError


Functions
---------

.. autoapisummary::

   auto_uncertainties.exceptions.set_equality_error
   auto_uncertainties.exceptions.set_downcast_error
   auto_uncertainties.exceptions.set_compare_rtol


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

.. py:exception:: NegativeStdDevError

   Bases: :py:obj:`Exception`

   .. autoapi-inheritance-diagram:: auto_uncertainties.exceptions.NegativeStdDevError
      :parts: 1
      :private-bases:


   An exception for when the standard deviation is negative.


.. py:exception:: DowncastError

   Bases: :py:obj:`RuntimeError`

   .. autoapi-inheritance-diagram:: auto_uncertainties.exceptions.DowncastError
      :parts: 1
      :private-bases:


   An exception for when an array of `~auto_uncertainties.uncertainty.uncertainty_containers.Uncertainty`
   objects is downcast to a NumPy `~numpy.ndarray`.


.. py:exception:: DowncastWarning

   Bases: :py:obj:`RuntimeWarning`

   .. autoapi-inheritance-diagram:: auto_uncertainties.exceptions.DowncastWarning
      :parts: 1
      :private-bases:


   A warning for when an array of `~auto_uncertainties.uncertainty.uncertainty_containers.Uncertainty`
   objects is downcast to a NumPy `~numpy.ndarray`.


.. py:exception:: EqualityWarning

   Bases: :py:obj:`RuntimeWarning`

   .. autoapi-inheritance-diagram:: auto_uncertainties.exceptions.EqualityWarning
      :parts: 1
      :private-bases:


   A warning that is raised when the equality check is performed on two
   `~auto_uncertainties.uncertainty.uncertainty_containers.Uncertainty` objects with identical
   central values, but different standard deviations.


.. py:exception:: EqualityError

   Bases: :py:obj:`RuntimeError`

   .. autoapi-inheritance-diagram:: auto_uncertainties.exceptions.EqualityError
      :parts: 1
      :private-bases:


   An exception that is raised when the equality check is performed on two
   `~auto_uncertainties.uncertainty.uncertainty_containers.Uncertainty` objects with identical
   central values, but different standard deviations.


.. py:function:: set_equality_error(val)

   Set whether `EqualityError` should be raised instead of a warning when performing
   an equality check between two `Uncertainty` objects with identical central values,
   but different standard deviations.


.. py:function:: set_downcast_error(val)

   Set whether `DowncastError` should be raised when uncertainty is stripped.


.. py:function:: set_compare_rtol(val)

   Set the comparison relative tolerance for error when performing equality
   operations on `Uncertainty` objects.