SpecmatVector
#############

.. currentmodule:: pyarts.arts

.. autoclass:: SpecmatVector

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Attributes

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

  .. rubric:: Operators

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