BlockMatrix
###########

.. currentmodule:: pyarts.arts

.. autoclass:: BlockMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

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

  .. rubric:: Static Methods

  .. automethod:: BlockMatrix.fromxml

  .. rubric:: Attributes

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

  .. rubric:: Operators

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