ArrayOfIndex
############

.. currentmodule:: pyarts3.arts

.. autoclass:: ArrayOfIndex

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.append`
      - Append `arg` to the end of the list.
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.clear`
      - Remove all items from list.
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.conj`
      - See :attr:`numpy.ndarray.conj`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.conjugate`
      - See :attr:`numpy.ndarray.conjugate`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.copy`
      - See :attr:`numpy.ndarray.copy`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.count`
      - Return number of occurrences of `arg`.
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.cumprod`
      - See :attr:`numpy.ndarray.cumprod`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.cumsum`
      - See :attr:`numpy.ndarray.cumsum`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.diagonal`
      - See :attr:`numpy.ndarray.diagonal`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.extend`
      - Extend `self` by appending elements from `arg`.
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.fill`
      - See :attr:`numpy.ndarray.fill`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.flatten`
      - See :attr:`numpy.ndarray.flatten`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.index`
      - Return first occurence of value between `start` and `end` - defaults to full range
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.insert`
      - Insert object `arg1` before index `arg0`.
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.max`
      - See :attr:`numpy.ndarray.max`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.mean`
      - See :attr:`numpy.ndarray.mean`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.min`
      - See :attr:`numpy.ndarray.min`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.nonzero`
      - See :attr:`numpy.ndarray.nonzero`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.pop`
      - Remove and return item at `index` (default last).
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.prod`
      - See :attr:`numpy.ndarray.prod`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.ravel`
      - See :attr:`numpy.ndarray.ravel`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.remove`
      - Remove first occurrence of `arg`.
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.repeat`
      - See :attr:`numpy.ndarray.repeat`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.reshape`
      - See :attr:`numpy.ndarray.reshape`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.round`
      - See :attr:`numpy.ndarray.round`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.savexml`
      - Saves variable to file
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.squeeze`
      - See :attr:`numpy.ndarray.squeeze`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.std`
      - See :attr:`numpy.ndarray.std`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.sum`
      - See :attr:`numpy.ndarray.sum`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.tolist`
      - See :attr:`numpy.ndarray.tolist`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.trace`
      - See :attr:`numpy.ndarray.trace`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.transpose`
      - See :attr:`numpy.ndarray.transpose`
    * - Method
      - :func:`~pyarts3.arts.ArrayOfIndex.var`
      - See :attr:`numpy.ndarray.var`
    * - Static Method
      - :func:`~pyarts3.arts.ArrayOfIndex.fromxml`
      - Create variable from file
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.T`
      - See :attr:`numpy.ndarray.T`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.dtype`
      - See :attr:`numpy.ndarray.dtype`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.imag`
      - See :attr:`numpy.ndarray.imag`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.itemsize`
      - See :attr:`numpy.ndarray.itemsize`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.nbytes`
      - See :attr:`numpy.ndarray.nbytes`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.ndim`
      - See :attr:`numpy.ndarray.ndim`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.real`
      - See :attr:`numpy.ndarray.real`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.shape`
      - See :attr:`numpy.ndarray.shape`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.size`
      - See :attr:`numpy.ndarray.size`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.strides`
      - See :attr:`numpy.ndarray.strides`.
    * - Attribute
      - :attr:`~pyarts3.arts.ArrayOfIndex.value`
      - A :class:`~numpy.ndarray` of the object.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__abs__`
      - See :attr:`numpy.ndarray.__abs__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__add__`
      - See :attr:`numpy.ndarray.__add__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__and__`
      - See :attr:`numpy.ndarray.__and__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__array__`
      - __array__(self, dtype: object | None = None, copy: object | None = None) -> numpy.ndarray[dtype=int64, shape=(*), order='C'] | object
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__contains__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__delitem__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__divmod__`
      - See :attr:`numpy.ndarray.__divmod__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__eq__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__floordiv__`
      - See :attr:`numpy.ndarray.__floordiv__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__ge__`
      - See :attr:`numpy.ndarray.__ge__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__getitem__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__getstate__`
      - __getstate__(self) -> tuple[pyarts3.arts.ArrayOfIndex]
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__gt__`
      - See :attr:`numpy.ndarray.__gt__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__iadd__`
      - See :attr:`numpy.ndarray.__iadd__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__iand__`
      - See :attr:`numpy.ndarray.__iand__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__ifloordiv__`
      - See :attr:`numpy.ndarray.__ifloordiv__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__imatmul__`
      - See :attr:`numpy.ndarray.__imatmul__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__imod__`
      - See :attr:`numpy.ndarray.__imod__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__imul__`
      - See :attr:`numpy.ndarray.__imul__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__init__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__ior__`
      - See :attr:`numpy.ndarray.__ior__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__ipow__`
      - See :attr:`numpy.ndarray.__ipow__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__isub__`
      - See :attr:`numpy.ndarray.__isub__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__iter__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__itruediv__`
      - See :attr:`numpy.ndarray.__itruediv__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__le__`
      - See :attr:`numpy.ndarray.__le__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__len__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__lt__`
      - See :attr:`numpy.ndarray.__lt__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__matmul__`
      - See :attr:`numpy.ndarray.__matmul__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__mod__`
      - See :attr:`numpy.ndarray.__mod__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__mul__`
      - See :attr:`numpy.ndarray.__mul__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__ne__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__or__`
      - See :attr:`numpy.ndarray.__or__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__pow__`
      - See :attr:`numpy.ndarray.__pow__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__radd__`
      - See :attr:`numpy.ndarray.__radd__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rand__`
      - See :attr:`numpy.ndarray.__rand__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rdivmod__`
      - See :attr:`numpy.ndarray.__rdivmod__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rfloordiv__`
      - See :attr:`numpy.ndarray.__rfloordiv__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rmatmul__`
      - See :attr:`numpy.ndarray.__rmatmul__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rmod__`
      - See :attr:`numpy.ndarray.__rmod__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rmul__`
      - See :attr:`numpy.ndarray.__rmul__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__ror__`
      - See :attr:`numpy.ndarray.__ror__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rpow__`
      - See :attr:`numpy.ndarray.__rpow__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rsub__`
      - See :attr:`numpy.ndarray.__rsub__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__rtruediv__`
      - See :attr:`numpy.ndarray.__rtruediv__`
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__setitem__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__setstate__`
      - __setstate__(self, arg: tuple[pyarts3.arts.ArrayOfIndex]) -> None
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__str__`
      - __str__(self) -> str
    * - Operator
      - :func:`~pyarts3.arts.ArrayOfIndex.__truediv__`
      - See :attr:`numpy.ndarray.__truediv__`

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: ArrayOfIndex.append
  .. automethod:: ArrayOfIndex.clear
  .. automethod:: ArrayOfIndex.conj
  .. automethod:: ArrayOfIndex.conjugate
  .. automethod:: ArrayOfIndex.copy
  .. automethod:: ArrayOfIndex.count
  .. automethod:: ArrayOfIndex.cumprod
  .. automethod:: ArrayOfIndex.cumsum
  .. automethod:: ArrayOfIndex.diagonal
  .. automethod:: ArrayOfIndex.extend
  .. automethod:: ArrayOfIndex.fill
  .. automethod:: ArrayOfIndex.flatten
  .. automethod:: ArrayOfIndex.index
  .. automethod:: ArrayOfIndex.insert
  .. automethod:: ArrayOfIndex.max
  .. automethod:: ArrayOfIndex.mean
  .. automethod:: ArrayOfIndex.min
  .. automethod:: ArrayOfIndex.nonzero
  .. automethod:: ArrayOfIndex.pop
  .. automethod:: ArrayOfIndex.prod
  .. automethod:: ArrayOfIndex.ravel
  .. automethod:: ArrayOfIndex.readxml
  .. automethod:: ArrayOfIndex.remove
  .. automethod:: ArrayOfIndex.repeat
  .. automethod:: ArrayOfIndex.reshape
  .. automethod:: ArrayOfIndex.round
  .. automethod:: ArrayOfIndex.savexml
  .. automethod:: ArrayOfIndex.squeeze
  .. automethod:: ArrayOfIndex.std
  .. automethod:: ArrayOfIndex.sum
  .. automethod:: ArrayOfIndex.tolist
  .. automethod:: ArrayOfIndex.trace
  .. automethod:: ArrayOfIndex.transpose
  .. automethod:: ArrayOfIndex.var

  .. rubric:: Static Methods

  .. automethod:: ArrayOfIndex.fromxml

  .. rubric:: Attributes

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

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

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

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

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

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

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

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

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

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

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


  .. rubric:: Operators

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