Separate normalized and unnormalized objects

src/StatesZoo/StatesZoo.jl

@@ -5,7 +5,10 @@ using QuantumSymbolics, QuantumOpticsBase
 using QuantumSymbolics: withmetadata, @withmetadata, Metadata
 import QuantumSymbolics: express_nolookup
 
-export SingleRailMidSwapBell, DualRailMidSwapBell, ZALMSpinPair
+using LinearAlgebra
+import LinearAlgebra: tr
+
+export SingleRailMidSwapBellU, SingleRailMidSwapBellN, DualRailMidSwapBellU, DualRailMidSwapBellN, ZALMSpinPairU, ZALMSpinPairN
 
 abstract type AbstractTwoQubitState <: QuantumSymbolics.AbstractTwoQubitOp end #For representing density matrices
 Base.show(io::IO, x::AbstractTwoQubitState) = print(io, "$(symbollabel(x))")

src/StatesZoo/single_dual_rail_midswap/single_dual_rail_midswap.jl

@@ -34,7 +34,7 @@ Fields:
 
 $FIELDS
 
-Generates the spin-spin density matrix for linear photonic entanglement swap 
+Generates the unnormalized spin-spin density matrix for linear photonic entanglement swap 
 with emissive memories emitting single rail photonic qubits from the paper [prajit2023entangling](@cite)
 It takes the following parameters:
 - eA, eB: Link efficiencies for memories A and B upto the swap (include link loss, detector efficiency, etc.)
@@ -45,12 +45,12 @@ It takes the following parameters:
 ```jldoctest
 julia> r = Register(2)
 
-julia> initialize!(r[1:2], SingleRailMidSwapBell(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
+julia> initialize!(r[1:2], SingleRailMidSwapBellU(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
 
 julia> observable(r[1:2], Z⊗Z)
 ```
 """
-@withmetadata struct SingleRailMidSwapBell <: AbstractTwoQubitState
+@withmetadata struct SingleRailMidSwapBellU <: AbstractTwoQubitState
     eA::Float64
     eB::Float64
     gA::Float64
@@ -59,7 +59,7 @@ julia> observable(r[1:2], Z⊗Z)
     Vis::Float64
 end
 
-symbollabel(x::SingleRailMidSwapBell) = "ρˢʳᵐˢ"
+symbollabel(x::SingleRailMidSwapBellU) = "ρˢʳᵐˢᵁ"
 
 
 """
@@ -69,7 +69,42 @@ Fields:
 
 $FIELDS
 
-Generates the spin-spin density matrix for linear photonic entanglement swap with emissive
+Generates the normalized spin-spin density matrix for linear photonic entanglement swap 
+with emissive memories emitting single rail photonic qubits from the paper [prajit2023entangling](@cite)
+It takes the following parameters:
+- eA, eB: Link efficiencies for memories A and B upto the swap (include link loss, detector efficiency, etc.)
+- gA, gB: Memory initialization parameter for memories A and B
+- Pd: Detector dark count probability per photonic mode (assumed to be the same for both detectors)
+- Vis: Interferometer visibility for the midpoint swap' can be complex to account for phase instability
+
+```jldoctest
+julia> r = Register(2)
+
+julia> initialize!(r[1:2], SingleRailMidSwapBellN(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
+
+julia> observable(r[1:2], Z⊗Z)
+```
+"""
+@withmetadata struct SingleRailMidSwapBellN <: AbstractTwoQubitState
+    eA::Float64
+    eB::Float64
+    gA::Float64
+    gB::Float64
+    Pd::Float64
+    Vis::Float64
+end
+
+symbollabel(x::SingleRailMidSwapBellN) = "ρˢʳᵐˢᴺ"
+
+
+"""
+$TYPEDEF
+
+Fields:
+
+$FIELDS
+
+Generates the unnormalized spin-spin density matrix for linear photonic entanglement swap with emissive
  memories emitting dual rail photonic qubits from the paper [prajit2023entangling](@cite).
  It takes the following parameters:
  - eA, eB: Link efficiencies for memories A and B upto the swap (include link loss, detector efficiency, etc.)
@@ -80,12 +115,12 @@ Generates the spin-spin density matrix for linear photonic entanglement swap wit
 ```jldoctest
 julia> r = Register(2)
 
-julia> initialize!(r[1:2], DualRailMidSwapBell(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
+julia> initialize!(r[1:2], DualRailMidSwapBellU(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
 
 julia> observable(r[1:2], Z⊗Z)
 ```
 """
-@withmetadata struct DualRailMidSwapBell <: AbstractTwoQubitState
+@withmetadata struct DualRailMidSwapBellU <: AbstractTwoQubitState
     eA::Float64
     eB::Float64
     gA::Float64
@@ -94,17 +129,67 @@ julia> observable(r[1:2], Z⊗Z)
     Vis::Float64
 end
 
-symbollabel(x::DualRailMidSwapBell) = "ρᵈʳᵐˢ"
+symbollabel(x::DualRailMidSwapBellU) = "ρᵈʳᵐˢᵁ"
+
+
+"""
+$TYPEDEF
+
+Fields:
+
+$FIELDS
+
+Generates the normalized spin-spin density matrix for linear photonic entanglement swap with emissive
+ memories emitting dual rail photonic qubits from the paper [prajit2023entangling](@cite).
+ It takes the following parameters:
+ - eA, eB: Link efficiencies for memories A and B upto the swap (include link loss, detector efficiency, etc.)
+- gA, gB: Memory initialization parameter for memories A and B 
+- Pd: Detector dark count probability per photonic mode (assumed to be the same for both detectors)
+- Vis: Interferometer visibility for the midpoint swap 
+
+```jldoctest
+julia> r = Register(2)
+
+julia> initialize!(r[1:2], DualRailMidSwapBellN(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
+
+julia> observable(r[1:2], Z⊗Z)
+```
+"""
+@withmetadata struct DualRailMidSwapBellN <: AbstractTwoQubitState
+    eA::Float64
+    eB::Float64
+    gA::Float64
+    gB::Float64
+    Pd::Float64
+    Vis::Float64
+end
+
+symbollabel(x::DualRailMidSwapBellN) = "ρᵈʳᵐˢᴺ"
 
 
 ## express
 
-function express_nolookup(x::SingleRailMidSwapBell, ::QuantumOpticsRepr)
+function express_nolookup(x::SingleRailMidSwapBellU, ::QuantumOpticsRepr)
     data = midswap_single_rail(x.eA, x.eB, x.gA, x.gB, x.Pd, x.Vis)
     return SparseOperator(_bspin⊗_bspin, Complex.(data))
 end
 
-function express_nolookup(x::DualRailMidSwapBell, ::QuantumOpticsRepr)
+function express_nolookup(x::SingleRailMidSwapBellN, ::QuantumOpticsRepr)
+    data = midswap_single_rail(x.eA, x.eB, x.gA, x.gB, x.Pd, x.Vis)
+    return SparseOperator(_bspin⊗_bspin, Complex.(data/tr(data)))
+end
+
+function express_nolookup(x::DualRailMidSwapBellU, ::QuantumOpticsRepr)
     data = midswap_dual_rail(x.eA, x.eB, x.gA, x.gB, x.Pd, x.Vis)
     return SparseOperator(_bspin⊗_bspin, Complex.(data))
-end
+end
+
+function express_nolookup(x::DualRailMidSwapBellN, ::QuantumOpticsRepr)
+    data = midswap_dual_rail(x.eA, x.eB, x.gA, x.gB, x.Pd, x.Vis)
+    return SparseOperator(_bspin⊗_bspin, Complex.(data/tr(data)))
+end
+
+## trace
+
+tr(x::SingleRailMidSwapBellU) = Float64(tr(express(x).data))
+tr(x::DualRailMidSwapBellU) = Float64(tr(express(x).data))

src/StatesZoo/zalm_pair/zalm_pair.jl

@@ -568,7 +568,7 @@ Fields:
 
 $FIELDS
 
-Generate symbolic object for the spin-spin density matrix for a 
+Generate symbolic object for the unnormalized spin-spin density matrix for a 
 cascaded source swapped with emissive spin memories. The cascaded 
 source from papers [prajit2022heralded](@cite) and [kevin2023zero](@cite) 
 is stored in spin memories as discussed in [prajit2023entangling](@cite).
@@ -589,12 +589,12 @@ It takes the following parameters:
 ```jldoctest
 julia> r = Register(2)
 
-julia> initialize!(r[1:2], ZALMSpinPair(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99))
+julia> initialize!(r[1:2], ZALMSpinPairU(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99))
 
 juilia> observable(r[1:2], Z⊗Z)
 ```
 """
-@withmetadata struct ZALMSpinPair <: AbstractTwoQubitState
+@withmetadata struct ZALMSpinPairU <: AbstractTwoQubitState
     Ns::Float64
     gA::Float64
     gB::Float64
@@ -609,9 +609,70 @@ juilia> observable(r[1:2], Z⊗Z)
     VisF::Float64
 end
 
-symbollabel(x::ZALMSpinPair) = "ρᶻᵃˡᵐ"
+symbollabel(x::ZALMSpinPairU) = "ρᶻᵃˡᵐᵁ"
 
-function express_nolookup(x::ZALMSpinPair, ::QuantumOpticsRepr)
+
+"""
+$TYPEDEF
+
+Fields:
+
+$FIELDS
+
+Generate symbolic object for the normalized spin-spin density matrix for a 
+cascaded source swapped with emissive spin memories. The cascaded 
+source from papers [prajit2022heralded](@cite) and [kevin2023zero](@cite) 
+is stored in spin memories as discussed in [prajit2023entangling](@cite).
+It takes the following parameters:
+- Ns: mean photon number per mode of the cascaded source model
+- gA: qubit initialization parameter on Alice's side 
+- gB: qubit initialization parameter on Bob's side 
+- eAm: memory out-coupling efficiency for Alice's side (Allowed range: [0,1])
+- eBm: memory out-coupling efficiency for Bob's side (Allowed range: [0,1])
+- eAs: source out-coupling efficiency for Alice's side (Allowed range: [0,1])
+- eBs: source out-coupling efficiency for Bob's side (Allowed range: [0,1])
+- eD: detector efficiency (Allowed range: [0,1])
+- Pd: dark click probability per photonic mode on source's swap 
+- Pdo1: dark click probability per photonic mode on Alice side swap 
+- Pdo2: dark click probability per photonic mode on Bob side swap
+- VisF: product of visibilities of all three  interferometers (Allowed range: [0,1])
+
+```jldoctest
+julia> r = Register(2)
+
+julia> initialize!(r[1:2], ZALMSpinPairN(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99))
+
+juilia> observable(r[1:2], Z⊗Z)
+```
+"""
+@withmetadata struct ZALMSpinPairN <: AbstractTwoQubitState
+    Ns::Float64
+    gA::Float64
+    gB::Float64
+    eAm::Float64
+    eBm::Float64
+    eAs::Float64
+    eBs::Float64
+    eD::Float64
+    Pd::Float64
+    Pdo1::Float64
+    Pdo2::Float64
+    VisF::Float64
+end
+
+symbollabel(x::ZALMSpinPairN) = "ρᶻᵃˡᵐᴺ"
+
+## express
+
+function express_nolookup(x::ZALMSpinPairU, ::QuantumOpticsRepr)
     data = cascaded_source_spin(x.Ns, x.gA, x.gB, x.eAm, x.eBm, x.eAs, x.eBs, x.eD, x.Pd, x.Pdo1, x.Pdo2, x.VisF)
     return SparseOperator(_bspin⊗_bspin, Complex.(data))
-end
+end
+
+function express_nolookup(x::ZALMSpinPairN, ::QuantumOpticsRepr)
+    data = cascaded_source_spin(x.Ns, x.gA, x.gB, x.eAm, x.eBm, x.eAs, x.eBs, x.eD, x.Pd, x.Pdo1, x.Pdo2, x.VisF)
+    return SparseOperator(_bspin⊗_bspin, Complex.(data/tr(data)))
+end
+
+## trace
+tr(x::ZALMSpinPairU) = Float64(tr(express(x).data))

test/test_stateszoo_api.jl

@@ -1,15 +1,44 @@
 using QuantumSavory
-using QuantumSavory.StatesZoo: ZALMSpinPair, SingleRailMidSwapBell, DualRailMidSwapBell
+using QuantumSavory.StatesZoo: ZALMSpinPairU, ZALMSpinPairN, SingleRailMidSwapBellU, SingleRailMidSwapBellN, DualRailMidSwapBellU, DualRailMidSwapBellN
+using LinearAlgebra
 using Test
 
-r_zalm = Register(2)
-initialize!(r_zalm[1:2], ZALMSpinPair(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99))
-@test ! iszero(observable(r_zalm[1:2], Z⊗Z))
+zalmU = ZALMSpinPairU(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99)
+zalmN = ZALMSpinPairN(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99)
+srmsU = SingleRailMidSwapBellU(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99)
+srmsN = SingleRailMidSwapBellN(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99)
+drmsU = DualRailMidSwapBellU(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99)
+drmsN = DualRailMidSwapBellN(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99)
 
-r_srms = Register(2)
-initialize!(r_srms[1:2], SingleRailMidSwapBell(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
-@test ! iszero(observable(r_srms[1:2], Z⊗Z))
+r_zalmU = Register(2)
+initialize!(r_zalmU[1:2], zalmU)
+@test ! iszero(observable(r_zalmU[1:2], Z⊗Z))
 
-r_drms = Register(2)
-initialize!(r_drms[1:2], DualRailMidSwapBell(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
-@test ! iszero(observable(r_drms[1:2], Z⊗Z))
+r_zalmN = Register(2)
+initialize!(r_zalmN[1:2], zalmN)
+@test ! iszero(observable(r_zalmN[1:2], Z⊗Z))
+
+r_srmsU = Register(2)
+initialize!(r_srmsU[1:2], srmsU)
+@test ! iszero(observable(r_srmsU[1:2], Z⊗Z))
+
+r_srmsN = Register(2)
+initialize!(r_srmsN[1:2], srmsN)
+@test ! iszero(observable(r_srmsN[1:2], Z⊗Z))
+
+r_drmsU = Register(2)
+initialize!(r_drmsU[1:2], drmsU)
+@test ! iszero(observable(r_drmsU[1:2], Z⊗Z))
+
+r_drmsN = Register(2)
+initialize!(r_drmsN[1:2], drmsN)
+@test ! iszero(observable(r_drmsN[1:2], Z⊗Z))
+
+@test tr(zalmU) < 1.0
+@test tr(express(zalmN).data) ≈ 1
+
+@test tr(srmsU) < 1.0
+@test tr(express(srmsN).data) ≈ 1.0
+
+@test tr(drmsU) < 1.0
+@test tr(express(drmsN).data) ≈ 1.0