Skip to content

Commit c9c24f9

Browse files
authored
Add missing documented methods to api.md (#198)
1 parent 0af2efe commit c9c24f9

File tree

2 files changed

+36
-3
lines changed

2 files changed

+36
-3
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "QuantumOpticsBase"
22
uuid = "4f57444f-1401-5e15-980d-4471b28d5678"
3-
version = "0.5.6"
3+
version = "0.5.7"
44

55
[deps]
66
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

docs/src/api.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Bra
3131
Ket
3232
```
3333

34-
* General purpose QuantumOpticsBase. A few more specialized operators are implemented in [API: Quantum-systems](@ref).
34+
* General purpose operators. A few more specialized operators are implemented in [API: Quantum-systems](@ref).
3535

3636
```@docs
3737
AbstractOperator
@@ -53,6 +53,10 @@ DenseOperator
5353
SparseOperator
5454
```
5555

56+
```@docs
57+
LazyKet
58+
```
59+
5660
```@docs
5761
LazyTensor
5862
```
@@ -114,6 +118,10 @@ diagonaloperator
114118
randoperator
115119
```
116120

121+
```@docs
122+
randunitary_haar
123+
```
124+
117125
```@docs
118126
spre
119127
```
@@ -130,7 +138,7 @@ sprepost
130138
liouvillian
131139
```
132140

133-
* As far as it makes sense the same functions are implemented for bases, states, operators and superQuantumOpticsBase.
141+
* As far as it makes sense the same functions are implemented for bases, states, operators and superoperators.
134142

135143
```@docs
136144
QuantumOpticsBase.samebases
@@ -321,6 +329,10 @@ ChargeBasis
321329
ShiftedChargeBasis
322330
```
323331

332+
```@docs
333+
chargestate
334+
```
335+
324336
```@docs
325337
chargeop
326338
```
@@ -351,6 +363,19 @@ transition(::Type{T}, ::NLevelBasis, ::Integer, ::Integer) where T
351363
nlevelstate
352364
```
353365

366+
```@docs
367+
paulix
368+
```
369+
370+
```@docs
371+
pauliy
372+
```
373+
374+
```@docs
375+
pauliz
376+
```
377+
378+
354379
### [Spin](@id API: Spin)
355380

356381
```@docs
@@ -457,6 +482,10 @@ projector(::Type{T}, b1::SubspaceBasis, b2::SubspaceBasis) where T
457482
ManyBodyBasis
458483
```
459484

485+
```@docs
486+
FermionBitstring
487+
```
488+
460489
```@docs
461490
fermionstates
462491
```
@@ -580,6 +609,10 @@ avg_gate_fidelity
580609
randstate
581610
```
582611

612+
```@docs
613+
randstate_haar
614+
```
615+
583616
```@docs
584617
thermalstate
585618
```

0 commit comments

Comments
 (0)