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

.. currentmodule:: pyarts3.arts

.. autoclass:: BlockMatrix

  .. rubric:: Overview

  .. list-table::

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

  .. 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

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

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

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

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

  .. attribute:: BlockMatrix.matrix
     :type: ~pyarts3.arts.Matrix | ~pyarts3.arts.Sparse
     
     The matrix of the block
     
     .. :class:`~pyarts3.arts.Matrix`
     
     .. :class:`~pyarts3.arts.Sparse`

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

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

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

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

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

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

  .. attribute:: BlockMatrix.value
     :type: ~numpy.ndarray | scipy.sparse.csr_matrix
     
     A python friendly version of the object.
     
     .. :class:`~numpy.ndarray`
     
     .. :class:`scipy.sparse.csr_matrix`


  .. 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__