StokvecMatrix
#############

.. currentmodule:: pyarts.arts

.. autoclass:: StokvecMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: StokvecMatrix.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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