StokvecVector
#############

.. currentmodule:: pyarts.arts

.. autoclass:: StokvecVector

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: StokvecVector.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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