auto_uncertainties.util
=======================

.. py:module:: auto_uncertainties.util


Attributes
----------

.. autoapisummary::

   auto_uncertainties.util.T


Functions
---------

.. autoapisummary::

   auto_uncertainties.util.ignore_runtime_warnings
   auto_uncertainties.util.ignore_numpy_downcast_warnings
   auto_uncertainties.util.deprecated
   auto_uncertainties.util.is_iterable
   auto_uncertainties.util.has_length
   auto_uncertainties.util.ndarray_to_scalar
   auto_uncertainties.util.strip_device_array


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

.. py:data:: T

.. py:function:: ignore_runtime_warnings(f)

   A decorator to ignore runtime warnings.

   :param f: The function to wrap

   :return: The wrapped function


.. py:function:: ignore_numpy_downcast_warnings(f)

   A decorator to ignore `DowncastWarning`.

   :param f: The function to wrap

   :return: The wrapped function


.. py:function:: deprecated(reason='', category=DeprecationWarning)

   Raise a deprecation warning for a decorated function.

   :param reason: Why the deprecation is being issued (Default = `''`)
   :param category: The type of warning to issue (Default = `DeprecationWarning`)


.. py:function:: is_iterable(y)

.. py:function:: has_length(y)

.. py:function:: ndarray_to_scalar(value)

.. py:function:: strip_device_array(value)