Merge pull request #155 from ytdHuang/dev/qobj-attribute

Attribute functions operating on `Qobj`

.gitignore

@@ -7,4 +7,7 @@ Manifest.toml
 docs/build/
 
 .vscode
-*.json
+*.json
+
+.ipynb_checkpoints
+*.ipynb

docs/make.jl

@@ -1,3 +1,6 @@
+#! format: off
+# turns off the julia formatting of this file
+
 using QuantumToolbox
 using Documenter
 
@@ -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" => [],

docs/src/api.md

@@ -26,7 +26,6 @@ OperatorKet
 SuperOperatorQuantumObject
 SuperOperator
 QuantumObject
-Qobj
 size
 eltype
 length
@@ -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
+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
@@ -73,9 +88,6 @@ eigsolve_al
 ket2dm
 expect
 LinearAlgebra.kron
-tensor
-⊗
-permute
 sparse_to_dense
 dense_to_sparse
 vec2mat
@@ -106,7 +118,6 @@ create
 fdestroy
 fcreate
 eye
-qeye
 projection
 commutator
 spre
@@ -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

src/QuantumToolbox.jl

@@ -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")