PropmatMatrix
#############

.. currentmodule:: pyarts.arts

.. autoclass:: PropmatMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: PropmatMatrix.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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