Merge pull request #46 from apkille/express

Migrate `express` and `AbstractRepresentation` type from QuantumSymbolics
qojulia · Jan 16, 2025 · 8f8c0e2 · 8f8c0e2 · apkille · Jan 16, 2025
2 parents f22adb7 + 7ce478a
commit 8f8c0e2
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # News
 
+## v0.3.7 - 2025-01-16
+
+- Migrate `express` functionalities and representation types from QuantumSymbolics.
+
 ## v0.3.6 - 2024-09-08
 
 - Add `coherentstate`, `thermalstate`, `displace`, `squeeze`, `wigner`, previously from QuantumOptics.

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "QuantumInterface"
 uuid = "5717a53b-5d69-4fa3-b976-0bf2f97ca1e5"
 authors = ["QuantumInterface.jl contributors"]
-version = "0.3.6"
+version = "0.3.7"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

diff --git a/src/QuantumInterface.jl b/src/QuantumInterface.jl
@@ -100,5 +100,6 @@ include("julia_linalg.jl")
 include("sparse.jl")
 
 include("sortedindices.jl")
+include("express.jl")
 
 end # module
diff --git a/src/express.jl b/src/express.jl
@@ -0,0 +1,32 @@
+"""
+    express(obj, repr::AbstractRepresentation)
+    express(obj, repr::AbstractRepresentation, use::AbstractUse)
+
+Translate a quantum object `obj` to a backend representation `repr`. It is relevant to define `use`
+for formalism-specific cases, e.g., for `QuantumCliffordRepr`.
+"""
+function express end
+
+"""An abstract type for the supported representation of quantum objects."""
+abstract type AbstractRepresentation end
+abstract type AbstractUse end
+struct UseAsState <: AbstractUse end
+struct UseAsOperation <: AbstractUse end
+struct UseAsObservable <: AbstractUse end
+
+express(obj) = express(obj, QuantumOpticsRepr()) # The default representation
+express(s::Number, repr::AbstractRepresentation, use::AbstractUse) = s
+express(s, repr::AbstractRepresentation) = express(s, repr, UseAsState())
+
+##
+# Commonly used representations -- interfaces for each one defined in separate packages
+##
+
+"""Representation using kets, bras, density matrices, and superoperators governed by `QuantumOptics.jl`."""
+Base.@kwdef struct QuantumOpticsRepr <: AbstractRepresentation 
+    cutoff::Int = 2
+end
+"""Similar to `QuantumOpticsRepr`, but using trajectories instead of superoperators."""
+struct QuantumMCRepr <: AbstractRepresentation end
+"""Representation using tableaux governed by `QuantumClifford.jl`"""
+struct CliffordRepr <: AbstractRepresentation end
diff --git a/test/test_jet.jl b/test/test_jet.jl
@@ -49,6 +49,6 @@ end
         )
     )
     @show rep
-    @test length(JET.get_reports(rep)) <= 2
+    @test length(JET.get_reports(rep)) <= 3
     @test_broken length(JET.get_reports(rep)) == 0
 end