Numeric
#######

.. currentmodule:: pyarts.arts

.. autoclass:: Numeric

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts.arts.Numeric.conj`
      - Wrapper for :attr:`numpy.ndarray.conj` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.conjugate`
      - Wrapper for :attr:`numpy.ndarray.conjugate` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.copy`
      - Wrapper for :attr:`numpy.ndarray.copy` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.cumprod`
      - Wrapper for :attr:`numpy.ndarray.cumprod` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.cumsum`
      - Wrapper for :attr:`numpy.ndarray.cumsum` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.diagonal`
      - Wrapper for :attr:`numpy.ndarray.diagonal` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.fill`
      - Wrapper for :attr:`numpy.ndarray.fill` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.flatten`
      - Wrapper for :attr:`numpy.ndarray.flatten` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.max`
      - Wrapper for :attr:`numpy.ndarray.max` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.mean`
      - Wrapper for :attr:`numpy.ndarray.mean` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.min`
      - Wrapper for :attr:`numpy.ndarray.min` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.nonzero`
      - Wrapper for :attr:`numpy.ndarray.nonzero` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.prod`
      - Wrapper for :attr:`numpy.ndarray.prod` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.ravel`
      - Wrapper for :attr:`numpy.ndarray.ravel` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts.arts.Numeric.repeat`
      - Wrapper for :attr:`numpy.ndarray.repeat` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.reshape`
      - Wrapper for :attr:`numpy.ndarray.reshape` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.round`
      - Wrapper for :attr:`numpy.ndarray.round` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.savexml`
      - Saves variable to file
    * - Method
      - :func:`~pyarts.arts.Numeric.squeeze`
      - Wrapper for :attr:`numpy.ndarray.squeeze` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.std`
      - Wrapper for :attr:`numpy.ndarray.std` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.sum`
      - Wrapper for :attr:`numpy.ndarray.sum` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.tolist`
      - Wrapper for :attr:`numpy.ndarray.tolist` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.trace`
      - Wrapper for :attr:`numpy.ndarray.trace` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.transpose`
      - Wrapper for :attr:`numpy.ndarray.transpose` using ARTS types.
    * - Method
      - :func:`~pyarts.arts.Numeric.var`
      - Wrapper for :attr:`numpy.ndarray.var` using ARTS types.
    * - Static Method
      - :func:`~pyarts.arts.Numeric.fromxml`
      - Create variable from file
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.T`
      - Wrapper for :attr:`numpy.ndarray.T` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.dtype`
      - Wrapper for :attr:`numpy.ndarray.dtype` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.imag`
      - Wrapper for :attr:`numpy.ndarray.imag` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.itemsize`
      - Wrapper for :attr:`numpy.ndarray.itemsize` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.nbytes`
      - Wrapper for :attr:`numpy.ndarray.nbytes` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.ndim`
      - Wrapper for :attr:`numpy.ndarray.ndim` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.real`
      - Wrapper for :attr:`numpy.ndarray.real` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.shape`
      - Wrapper for :attr:`numpy.ndarray.shape` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.size`
      - Wrapper for :attr:`numpy.ndarray.size` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.strides`
      - Wrapper for :attr:`numpy.ndarray.strides` using ARTS types.
    * - Attribute
      - :attr:`~pyarts.arts.Numeric.value`
      - A :class:`~numpy.ndarray` of the object.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__abs__`
      - Allows `abs(self)`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__add__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__and__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__array__`
      - __array__(self, dtype: object | None = None, copy: object | None = None) -> object
    * - Operator
      - :func:`~pyarts.arts.Numeric.__contains__`
      - Allows `key in self`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__divmod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__eq__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__floordiv__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts.arts.Numeric.__ge__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__getitem__`
      - Allows `self[key]`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__getstate__`
      - __getstate__(self) -> tuple[float]
    * - Operator
      - :func:`~pyarts.arts.Numeric.__gt__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__hash__`
      - Allows hashing
    * - Operator
      - :func:`~pyarts.arts.Numeric.__iadd__`
      - Allows `self += value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__iand__`
      - Allows `self &= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__ifloordiv__`
      - Allows `self //= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__imatmul__`
      - Allows `self @= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__imod__`
      - Allows `self %= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__imul__`
      - Allows `self *= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__init__`
      - __init__(self, arg: pyarts.arts.Numeric) -> None
    * - Operator
      - :func:`~pyarts.arts.Numeric.__ior__`
      - Allows `self |= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__ipow__`
      - Allows `self **= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__isub__`
      - Allows `self -= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__iter__`
      - Allows `iter(self)`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__itruediv__`
      - Allows `self /= value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__le__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__len__`
      - Allows `len(self)`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__lt__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__matmul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__mod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__mul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__ne__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__or__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__pow__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__radd__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rand__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rdivmod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rfloordiv__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rmatmul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rmod__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rmul__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__ror__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rpow__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rsub__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__rtruediv__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Numeric.__setitem__`
      - Allows `self[key] = value`
    * - Operator
      - :func:`~pyarts.arts.Numeric.__setstate__`
      - __setstate__(self, arg: tuple[float], /) -> None
    * - Operator
      - :func:`~pyarts.arts.Numeric.__str__`
      - __str__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.Numeric.__truediv__`
      - Overloaded function.

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: Numeric.conj
  .. automethod:: Numeric.conjugate
  .. automethod:: Numeric.copy
  .. automethod:: Numeric.cumprod
  .. automethod:: Numeric.cumsum
  .. automethod:: Numeric.diagonal
  .. automethod:: Numeric.fill
  .. automethod:: Numeric.flatten
  .. automethod:: Numeric.max
  .. automethod:: Numeric.mean
  .. automethod:: Numeric.min
  .. automethod:: Numeric.nonzero
  .. automethod:: Numeric.prod
  .. automethod:: Numeric.ravel
  .. automethod:: Numeric.readxml
  .. automethod:: Numeric.repeat
  .. automethod:: Numeric.reshape
  .. automethod:: Numeric.round
  .. automethod:: Numeric.savexml
  .. automethod:: Numeric.squeeze
  .. automethod:: Numeric.std
  .. automethod:: Numeric.sum
  .. automethod:: Numeric.tolist
  .. automethod:: Numeric.trace
  .. automethod:: Numeric.transpose
  .. automethod:: Numeric.var

  .. rubric:: Static Methods

  .. automethod:: Numeric.fromxml

  .. rubric:: Attributes

  .. autoattribute:: Numeric.T
  .. autoattribute:: Numeric.dtype
  .. autoattribute:: Numeric.imag
  .. autoattribute:: Numeric.itemsize
  .. autoattribute:: Numeric.nbytes
  .. autoattribute:: Numeric.ndim
  .. autoattribute:: Numeric.real
  .. autoattribute:: Numeric.shape
  .. autoattribute:: Numeric.size
  .. autoattribute:: Numeric.strides
  .. autoattribute:: Numeric.value

  .. rubric:: Operators

  .. automethod:: Numeric.__abs__
  .. automethod:: Numeric.__add__
  .. automethod:: Numeric.__and__
  .. automethod:: Numeric.__array__
  .. automethod:: Numeric.__contains__
  .. automethod:: Numeric.__divmod__
  .. automethod:: Numeric.__eq__
  .. automethod:: Numeric.__floordiv__
  .. automethod:: Numeric.__format__
  .. automethod:: Numeric.__ge__
  .. automethod:: Numeric.__getitem__
  .. automethod:: Numeric.__getstate__
  .. automethod:: Numeric.__gt__
  .. automethod:: Numeric.__hash__
  .. automethod:: Numeric.__iadd__
  .. automethod:: Numeric.__iand__
  .. automethod:: Numeric.__ifloordiv__
  .. automethod:: Numeric.__imatmul__
  .. automethod:: Numeric.__imod__
  .. automethod:: Numeric.__imul__
  .. automethod:: Numeric.__init__
  .. automethod:: Numeric.__ior__
  .. automethod:: Numeric.__ipow__
  .. automethod:: Numeric.__isub__
  .. automethod:: Numeric.__iter__
  .. automethod:: Numeric.__itruediv__
  .. automethod:: Numeric.__le__
  .. automethod:: Numeric.__len__
  .. automethod:: Numeric.__lt__
  .. automethod:: Numeric.__matmul__
  .. automethod:: Numeric.__mod__
  .. automethod:: Numeric.__mul__
  .. automethod:: Numeric.__ne__
  .. automethod:: Numeric.__or__
  .. automethod:: Numeric.__pow__
  .. automethod:: Numeric.__radd__
  .. automethod:: Numeric.__rand__
  .. automethod:: Numeric.__rdivmod__
  .. automethod:: Numeric.__repr__
  .. automethod:: Numeric.__rfloordiv__
  .. automethod:: Numeric.__rmatmul__
  .. automethod:: Numeric.__rmod__
  .. automethod:: Numeric.__rmul__
  .. automethod:: Numeric.__ror__
  .. automethod:: Numeric.__rpow__
  .. automethod:: Numeric.__rsub__
  .. automethod:: Numeric.__rtruediv__
  .. automethod:: Numeric.__setitem__
  .. automethod:: Numeric.__setstate__
  .. automethod:: Numeric.__str__
  .. automethod:: Numeric.__truediv__