Matrix
######

.. currentmodule:: pyarts.arts

.. autoclass:: Matrix

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: Matrix.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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