Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attribute functions operating on Qobj #155

Merged
merged 37 commits into from
Jun 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
e56bcf7
add missing `@doc raw`, throw `DimensionMismatch` if `A.dims != B.dims`
ytdHuang May 31, 2024
3115ffc
support generalized `dot` and introduce `matrix_element`
ytdHuang May 31, 2024
ae1d113
minor changes
ytdHuang May 31, 2024
ca1e66d
fix tests for `matrix_element`
ytdHuang Jun 3, 2024
865583e
introduce `trans`, add docstring for `conj` and `transpose`
ytdHuang Jun 3, 2024
7131d30
add docstrings for boolean attribute functions
ytdHuang Jun 3, 2024
188e7ca
introduce `isherm`
ytdHuang Jun 3, 2024
ac1a48a
fix docstring in `dot`
ytdHuang Jun 3, 2024
759acef
add docstring for `adjoint`
ytdHuang Jun 3, 2024
fe9d772
introduce `dag` and `dagger`
ytdHuang Jun 3, 2024
1f78451
fix runtests
ytdHuang Jun 3, 2024
9a2e3da
format files
ytdHuang Jun 3, 2024
deb00cc
add docstrings for `inv`
ytdHuang Jun 3, 2024
d563220
ignore jupyter notebook files
ytdHuang Jun 3, 2024
11a07f4
support `normalize` for `Operator` and introduce `unit`
ytdHuang Jun 3, 2024
b6b657a
add docstring for `sqrt`
ytdHuang Jun 3, 2024
d867e38
add docstring for `exp` and introduce `expm`
ytdHuang Jun 3, 2024
ebb6d75
fix typo in `tidyup\!` docstring
ytdHuang Jun 3, 2024
4795cd5
fix input type of `Qobj` for `exp`, `expm`, `sinm`, and `cosm`
ytdHuang Jun 3, 2024
91b2f30
introduce `diag`
ytdHuang Jun 3, 2024
41300fb
introduce `log` and `logm`
ytdHuang Jun 3, 2024
daac4be
introduce `purity`
ytdHuang Jun 3, 2024
a763c0b
introduce `proj`
ytdHuang Jun 3, 2024
d8f1d66
fix document
ytdHuang Jun 4, 2024
ee1403c
fix typo in docstring
ytdHuang Jun 4, 2024
1b196dc
Merge branch 'main' into dev/qobj-attribute
ytdHuang Jun 7, 2024
b054bc2
add missing `@doc raw` for docstrings
ytdHuang Jun 7, 2024
a047653
separate synonyms from standard attribute functions
ytdHuang Jun 8, 2024
f85a6ef
fix typos
ytdHuang Jun 8, 2024
4fd9dc3
move `isherm` to synonyms
ytdHuang Jun 8, 2024
ebf5e2f
support for `sin` and `cos` in `LinearAlgebra`
ytdHuang Jun 8, 2024
fbefb40
move `Qobj` to synonyms
ytdHuang Jun 8, 2024
45110f1
move `tensor` to synonyms
ytdHuang Jun 8, 2024
d0c5b8c
improve `eye` for `type`, `dims` checks and corresponding runtests
ytdHuang Jun 8, 2024
a2b7f5b
fix typo in the docstring of `qeye`
ytdHuang Jun 8, 2024
7025242
introduce `shape`
ytdHuang Jun 8, 2024
ea57987
remove typo
ytdHuang Jun 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,7 @@ Manifest.toml
docs/build/

.vscode
*.json
*.json

.ipynb_checkpoints
*.ipynb
5 changes: 4 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
#! format: off
# turns off the julia formatting of this file

using QuantumToolbox
using Documenter

Expand All @@ -17,7 +20,7 @@ const PAGES = [
"Manipulating States and Operators" => "users_guide/states_and_operators.md",
"Tensor Products and Partial Traces" => "users_guide/tensor.md",
"Time Evolution and Dynamics" => [
"Introduction" => "users_guide/time_evolution/intro.md"
"Introduction" => "users_guide/time_evolution/intro.md",
],
"Solving for Steady-State Solutions" => [],
"Symmetries" => [],
Expand Down
46 changes: 38 additions & 8 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ OperatorKet
SuperOperatorQuantumObject
SuperOperator
QuantumObject
Qobj
size
eltype
length
Expand All @@ -36,18 +35,34 @@ isoper
isoperbra
isoperket
issuper
LinearAlgebra.ishermitian
LinearAlgebra.issymmetric
LinearAlgebra.isposdef
```

## [Qobj arithmetic and attributes](@id doc-API:Qobj-arithmetic-and-attributes)

```@docs
sqrtm
sinm
cosm
Base.conj
ytdHuang marked this conversation as resolved.
Show resolved Hide resolved
LinearAlgebra.transpose
LinearAlgebra.adjoint
LinearAlgebra.dot
LinearAlgebra.sqrt
LinearAlgebra.log
LinearAlgebra.exp
LinearAlgebra.sin
LinearAlgebra.cos
LinearAlgebra.tr
LinearAlgebra.svdvals
LinearAlgebra.norm
LinearAlgebra.normalize
LinearAlgebra.normalize!
LinearAlgebra.inv
LinearAlgebra.diag
proj
ptrace
purity
permute
tidyup
tidyup!
get_data
Expand All @@ -73,9 +88,6 @@ eigsolve_al
ket2dm
expect
LinearAlgebra.kron
tensor
permute
sparse_to_dense
dense_to_sparse
vec2mat
Expand Down Expand Up @@ -106,7 +118,6 @@ create
fdestroy
fcreate
eye
qeye
projection
commutator
spre
Expand All @@ -115,6 +126,25 @@ sprepost
lindblad_dissipator
```

## [Synonyms of functions for Qobj](@id doc-API:Synonyms-of-functions-for-Qobj)
```@docs
Qobj
shape
isherm
trans
dag
matrix_element
unit
sqrtm
logm
expm
sinm
cosm
tensor
qeye
```

## [Time evolution](@id doc-API:Time-evolution)

```@docs
Expand Down
1 change: 1 addition & 0 deletions src/QuantumToolbox.jl
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ include("qobj/eigsolve.jl")
include("qobj/functions.jl")
include("qobj/states.jl")
include("qobj/operators.jl")
include("qobj/synonyms.jl")

# time evolution
include("time_evolution/time_evolution.jl")
Expand Down
Loading
Loading