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

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

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

## Module Contents

### Classes

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

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

### API

`````{py:class} SparseOperator
:canonical: qcheff.operators.sparse_operator.SparseOperator

Bases: {py:obj}`qcheff.operators.operator_base.OperatorMatrix`

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator
```

````{py:attribute} op
:canonical: qcheff.operators.sparse_operator.SparseOperator.op
:type: qcheff.operators.operator_base.SparseMatrix
:value: >
   None

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.op
```

````

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

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.backend_module
```

````

````{py:method} save(filename: str) -> None
:canonical: qcheff.operators.sparse_operator.SparseOperator.save

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.save
```

````

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

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.load
```

````

````{py:method} to(backend: str) -> None
:canonical: qcheff.operators.sparse_operator.SparseOperator.to

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.to
```

````

````{py:method} diagonals() -> qcheff.operators.operator_base.SparseMatrix
:canonical: qcheff.operators.sparse_operator.SparseOperator.diagonals

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.diagonals
```

````

````{py:method} couplings() -> qcheff.operators.operator_base.SparseMatrix
:canonical: qcheff.operators.sparse_operator.SparseOperator.couplings

```{autodoc2-docstring} qcheff.operators.sparse_operator.SparseOperator.couplings
```

````

`````