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

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

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

## Module Contents

### Functions

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

* - {py:obj}`eye_like <qcheff.operators.utils.eye_like>`
  - ```{autodoc2-docstring} qcheff.operators.utils.eye_like
    :summary:
    ```
* - {py:obj}`commutator <qcheff.operators.utils.commutator>`
  - ```{autodoc2-docstring} qcheff.operators.utils.commutator
    :summary:
    ```
* - {py:obj}`tensor2 <qcheff.operators.utils.tensor2>`
  - ```{autodoc2-docstring} qcheff.operators.utils.tensor2
    :summary:
    ```
* - {py:obj}`tensor <qcheff.operators.utils.tensor>`
  - ```{autodoc2-docstring} qcheff.operators.utils.tensor
    :summary:
    ```
* - {py:obj}`embed_operator <qcheff.operators.utils.embed_operator>`
  - ```{autodoc2-docstring} qcheff.operators.utils.embed_operator
    :summary:
    ```
* - {py:obj}`state_number_enumerate <qcheff.operators.utils.state_number_enumerate>`
  - ```{autodoc2-docstring} qcheff.operators.utils.state_number_enumerate
    :summary:
    ```
* - {py:obj}`state_number_index <qcheff.operators.utils.state_number_index>`
  - ```{autodoc2-docstring} qcheff.operators.utils.state_number_index
    :summary:
    ```
* - {py:obj}`state_index_number <qcheff.operators.utils.state_index_number>`
  - ```{autodoc2-docstring} qcheff.operators.utils.state_index_number
    :summary:
    ```
````

### API

````{py:function} eye_like(A)
:canonical: qcheff.operators.utils.eye_like

```{autodoc2-docstring} qcheff.operators.utils.eye_like
```
````

````{py:function} commutator(A, B, kind='normal')
:canonical: qcheff.operators.utils.commutator

```{autodoc2-docstring} qcheff.operators.utils.commutator
```
````

````{py:function} tensor2(A, B)
:canonical: qcheff.operators.utils.tensor2

```{autodoc2-docstring} qcheff.operators.utils.tensor2
```
````

````{py:function} tensor(*args)
:canonical: qcheff.operators.utils.tensor

```{autodoc2-docstring} qcheff.operators.utils.tensor
```
````

````{py:function} embed_operator(op, pos: int, system_dims: tuple[int, ...])
:canonical: qcheff.operators.utils.embed_operator

```{autodoc2-docstring} qcheff.operators.utils.embed_operator
```
````

````{py:function} state_number_enumerate(dims, excitations=None)
:canonical: qcheff.operators.utils.state_number_enumerate

```{autodoc2-docstring} qcheff.operators.utils.state_number_enumerate
```
````

````{py:function} state_number_index(dims, state)
:canonical: qcheff.operators.utils.state_number_index

```{autodoc2-docstring} qcheff.operators.utils.state_number_index
```
````

````{py:function} state_index_number(dims, index)
:canonical: qcheff.operators.utils.state_index_number

```{autodoc2-docstring} qcheff.operators.utils.state_index_number
```
````