Vector
######

.. currentmodule:: pyarts.arts

.. autoclass:: Vector

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: Vector.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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