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

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

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

## Module Contents

### Functions

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

* - {py:obj}`eye <qcheff.operators.operators.eye>`
  - ```{autodoc2-docstring} qcheff.operators.operators.eye
    :summary:
    ```
* - {py:obj}`create <qcheff.operators.operators.create>`
  - ```{autodoc2-docstring} qcheff.operators.operators.create
    :summary:
    ```
* - {py:obj}`destroy <qcheff.operators.operators.destroy>`
  - ```{autodoc2-docstring} qcheff.operators.operators.destroy
    :summary:
    ```
* - {py:obj}`number <qcheff.operators.operators.number>`
  - ```{autodoc2-docstring} qcheff.operators.operators.number
    :summary:
    ```
* - {py:obj}`identity <qcheff.operators.operators.identity>`
  - ```{autodoc2-docstring} qcheff.operators.operators.identity
    :summary:
    ```
* - {py:obj}`basis <qcheff.operators.operators.basis>`
  - ```{autodoc2-docstring} qcheff.operators.operators.basis
    :summary:
    ```
* - {py:obj}`projector <qcheff.operators.operators.projector>`
  - ```{autodoc2-docstring} qcheff.operators.operators.projector
    :summary:
    ```
* - {py:obj}`charge <qcheff.operators.operators.charge>`
  - ```{autodoc2-docstring} qcheff.operators.operators.charge
    :summary:
    ```
* - {py:obj}`position <qcheff.operators.operators.position>`
  - ```{autodoc2-docstring} qcheff.operators.operators.position
    :summary:
    ```
* - {py:obj}`momentum <qcheff.operators.operators.momentum>`
  - ```{autodoc2-docstring} qcheff.operators.operators.momentum
    :summary:
    ```
* - {py:obj}`sigmax <qcheff.operators.operators.sigmax>`
  - ```{autodoc2-docstring} qcheff.operators.operators.sigmax
    :summary:
    ```
* - {py:obj}`sigmay <qcheff.operators.operators.sigmay>`
  - ```{autodoc2-docstring} qcheff.operators.operators.sigmay
    :summary:
    ```
* - {py:obj}`sigmaz <qcheff.operators.operators.sigmaz>`
  - ```{autodoc2-docstring} qcheff.operators.operators.sigmaz
    :summary:
    ```
* - {py:obj}`sigmap <qcheff.operators.operators.sigmap>`
  - ```{autodoc2-docstring} qcheff.operators.operators.sigmap
    :summary:
    ```
* - {py:obj}`sigmam <qcheff.operators.operators.sigmam>`
  - ```{autodoc2-docstring} qcheff.operators.operators.sigmam
    :summary:
    ```
````

### API

````{py:function} eye(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.eye

```{autodoc2-docstring} qcheff.operators.operators.eye
```
````

````{py:function} create(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.create

```{autodoc2-docstring} qcheff.operators.operators.create
```
````

````{py:function} destroy(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.destroy

```{autodoc2-docstring} qcheff.operators.operators.destroy
```
````

````{py:function} number(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.number

```{autodoc2-docstring} qcheff.operators.operators.number
```
````

````{py:function} identity(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.identity

```{autodoc2-docstring} qcheff.operators.operators.identity
```
````

````{py:function} basis(n: int, i: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.basis

```{autodoc2-docstring} qcheff.operators.operators.basis
```
````

````{py:function} projector(n: int, i: int, j: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.projector

```{autodoc2-docstring} qcheff.operators.operators.projector
```
````

````{py:function} charge(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.charge

```{autodoc2-docstring} qcheff.operators.operators.charge
```
````

````{py:function} position(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.position

```{autodoc2-docstring} qcheff.operators.operators.position
```
````

````{py:function} momentum(n: int, dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.momentum

```{autodoc2-docstring} qcheff.operators.operators.momentum
```
````

````{py:function} sigmax(dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.sigmax

```{autodoc2-docstring} qcheff.operators.operators.sigmax
```
````

````{py:function} sigmay(dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.sigmay

```{autodoc2-docstring} qcheff.operators.operators.sigmay
```
````

````{py:function} sigmaz(dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.sigmaz

```{autodoc2-docstring} qcheff.operators.operators.sigmaz
```
````

````{py:function} sigmap(dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.sigmap

```{autodoc2-docstring} qcheff.operators.operators.sigmap
```
````

````{py:function} sigmam(dtype: type | None = None, sparse: bool | None = None)
:canonical: qcheff.operators.operators.sigmam

```{autodoc2-docstring} qcheff.operators.operators.sigmam
```
````