QuantumState
############

.. currentmodule:: pyarts3.arts

.. autoclass:: QuantumState

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts3.arts.QuantumState.clear`
      - Remove all items
    * - Method
      - :func:`~pyarts3.arts.QuantumState.items`
      - Returns an iterable view of the map's items.
    * - Method
      - :func:`~pyarts3.arts.QuantumState.keys`
      - Returns an iterable view of the map's keys.
    * - Method
      - :func:`~pyarts3.arts.QuantumState.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts3.arts.QuantumState.savexml`
      - Saves variable to file
    * - Method
      - :func:`~pyarts3.arts.QuantumState.update`
      - Update the map with element from `arg`
    * - Method
      - :func:`~pyarts3.arts.QuantumState.values`
      - Returns an iterable view of the map's values.
    * - Static Method
      - :func:`~pyarts3.arts.QuantumState.fromxml`
      - Create variable from file
    * - Static Data
      - ``pyarts3.arts.QuantumState.ItemView``
      - <class 'pyarts3.arts.QuantumState.ItemView'> (:class:`~nb_type_0`)
    * - Static Data
      - ``pyarts3.arts.QuantumState.KeyView``
      - <class 'pyarts3.arts.QuantumState.KeyView'> (:class:`~nb_type_0`)
    * - Static Data
      - ``pyarts3.arts.QuantumState.ValueView``
      - <class 'pyarts3.arts.QuantumState.ValueView'> (:class:`~nb_type_0`)
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__contains__`
      - __contains__(self, arg: object, /) -> bool
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__delitem__`
      - __delitem__(self, arg: pyarts3.arts.QuantumNumberType, /) -> None
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__eq__`
      - __eq__(self, arg: object, /) -> bool
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__ge__`
      - Return self>=value.
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__getitem__`
      - __getitem__(self, arg: pyarts3.arts.QuantumNumberType, /) -> pyarts3.arts.QuantumUpperLower
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__getstate__`
      - Helper for pickle.
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__gt__`
      - Return self>value.
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__init__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__iter__`
      - __iter__(self) -> collections.abc.Iterator[pyarts3.arts.QuantumNumberType]
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__le__`
      - Return self<=value.
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__len__`
      - __len__(self) -> int
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__lt__`
      - Return self<value.
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__ne__`
      - __ne__(self, arg: object, /) -> bool
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__setitem__`
      - __setitem__(self, arg0: pyarts3.arts.QuantumNumberType, arg1: pyarts3.arts.QuantumUpperLower, /) -> None
    * - Operator
      - :func:`~pyarts3.arts.QuantumState.__str__`
      - __str__(self) -> str

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: QuantumState.clear
  .. automethod:: QuantumState.items
  .. automethod:: QuantumState.keys
  .. automethod:: QuantumState.readxml
  .. automethod:: QuantumState.savexml
  .. automethod:: QuantumState.update
  .. automethod:: QuantumState.values

  .. rubric:: Static Methods

  .. automethod:: QuantumState.fromxml

  .. rubric:: Operators

  .. automethod:: QuantumState.__contains__
  .. automethod:: QuantumState.__delitem__
  .. automethod:: QuantumState.__eq__
  .. automethod:: QuantumState.__format__
  .. automethod:: QuantumState.__ge__
  .. automethod:: QuantumState.__getitem__
  .. automethod:: QuantumState.__getstate__
  .. automethod:: QuantumState.__gt__
  .. automethod:: QuantumState.__hash__
  .. automethod:: QuantumState.__init__
  .. automethod:: QuantumState.__iter__
  .. automethod:: QuantumState.__le__
  .. automethod:: QuantumState.__len__
  .. automethod:: QuantumState.__lt__
  .. automethod:: QuantumState.__ne__
  .. automethod:: QuantumState.__repr__
  .. automethod:: QuantumState.__setitem__
  .. automethod:: QuantumState.__str__