# {py:mod}`qcheff.operators.operator_base`

```{py:module} qcheff.operators.operator_base
```

```{autodoc2-docstring} qcheff.operators.operator_base
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`OperatorMatrix <qcheff.operators.operator_base.OperatorMatrix>`
  - ```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`qcheff_dense_array <qcheff.operators.operator_base.qcheff_dense_array>`
  - ```{autodoc2-docstring} qcheff.operators.operator_base.qcheff_dense_array
    :summary:
    ```
* - {py:obj}`qcheff_sparse_array <qcheff.operators.operator_base.qcheff_sparse_array>`
  - ```{autodoc2-docstring} qcheff.operators.operator_base.qcheff_sparse_array
    :summary:
    ```
* - {py:obj}`qcheff_array <qcheff.operators.operator_base.qcheff_array>`
  - ```{autodoc2-docstring} qcheff.operators.operator_base.qcheff_array
    :summary:
    ```
* - {py:obj}`SparseMatrix <qcheff.operators.operator_base.SparseMatrix>`
  - ```{autodoc2-docstring} qcheff.operators.operator_base.SparseMatrix
    :summary:
    ```
* - {py:obj}`DenseMatrix <qcheff.operators.operator_base.DenseMatrix>`
  - ```{autodoc2-docstring} qcheff.operators.operator_base.DenseMatrix
    :summary:
    ```
````

### API

````{py:data} qcheff_dense_array
:canonical: qcheff.operators.operator_base.qcheff_dense_array
:type: typing.TypeAlias
:value: >
   None

```{autodoc2-docstring} qcheff.operators.operator_base.qcheff_dense_array
```

````

````{py:data} qcheff_sparse_array
:canonical: qcheff.operators.operator_base.qcheff_sparse_array
:type: typing.TypeAlias
:value: >
   None

```{autodoc2-docstring} qcheff.operators.operator_base.qcheff_sparse_array
```

````

````{py:data} qcheff_array
:canonical: qcheff.operators.operator_base.qcheff_array
:type: typing.TypeAlias
:value: >
   None

```{autodoc2-docstring} qcheff.operators.operator_base.qcheff_array
```

````

````{py:data} SparseMatrix
:canonical: qcheff.operators.operator_base.SparseMatrix
:type: typing.TypeAlias
:value: >
   None

```{autodoc2-docstring} qcheff.operators.operator_base.SparseMatrix
```

````

````{py:data} DenseMatrix
:canonical: qcheff.operators.operator_base.DenseMatrix
:type: typing.TypeAlias
:value: >
   None

```{autodoc2-docstring} qcheff.operators.operator_base.DenseMatrix
```

````

`````{py:class} OperatorMatrix
:canonical: qcheff.operators.operator_base.OperatorMatrix

Bases: {py:obj}`typing.Protocol`

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix
```

````{py:attribute} op
:canonical: qcheff.operators.operator_base.OperatorMatrix.op
:type: qcheff.operators.operator_base.qcheff_array
:value: >
   None

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix.op
```

````

````{py:attribute} backend_module
:canonical: qcheff.operators.operator_base.OperatorMatrix.backend_module
:type: types.ModuleType
:value: >
   'field(...)'

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix.backend_module
```

````

````{py:method} save(filename: str) -> None
:canonical: qcheff.operators.operator_base.OperatorMatrix.save
:abstractmethod:

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix.save
```

````

````{py:method} load(filename: str) -> qcheff.operators.operator_base.OperatorMatrix
:canonical: qcheff.operators.operator_base.OperatorMatrix.load
:abstractmethod:
:classmethod:

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix.load
```

````

````{py:method} diagonals() -> qcheff.operators.operator_base.qcheff_array
:canonical: qcheff.operators.operator_base.OperatorMatrix.diagonals

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix.diagonals
```

````

````{py:method} couplings() -> qcheff.operators.operator_base.qcheff_array
:canonical: qcheff.operators.operator_base.OperatorMatrix.couplings

```{autodoc2-docstring} qcheff.operators.operator_base.OperatorMatrix.couplings
```

````

`````