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

.. currentmodule:: pyarts3.arts

.. autoclass:: ComplexMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. 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

  .. attribute:: ComplexMatrix.T
     :type: object
     
     See :attr:`numpy.ndarray.T`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.dtype
     :type: object
     
     See :attr:`numpy.ndarray.dtype`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.imag
     :type: object
     
     See :attr:`numpy.ndarray.imag`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.itemsize
     :type: object
     
     See :attr:`numpy.ndarray.itemsize`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.nbytes
     :type: object
     
     See :attr:`numpy.ndarray.nbytes`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.ndim
     :type: object
     
     See :attr:`numpy.ndarray.ndim`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.real
     :type: object
     
     See :attr:`numpy.ndarray.real`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.shape
     :type: object
     
     See :attr:`numpy.ndarray.shape`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.size
     :type: object
     
     See :attr:`numpy.ndarray.size`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.strides
     :type: object
     
     See :attr:`numpy.ndarray.strides`.
     
     .. :class:`object`

  .. attribute:: ComplexMatrix.value
     :type: ~numpy.ndarray
     
     A :class:`~numpy.ndarray` of the object.
     
     .. :class:`~numpy.ndarray`


  .. 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__