ComplexMatrix
#############

.. currentmodule:: pyarts.arts

.. autoclass:: ComplexMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Attributes

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

  .. rubric:: Operators

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