Remove synonyms for QuantumObject types

Author: albertomercurio

docs/src/getting_started/type_stability.md

@@ -158,7 +158,7 @@ and its type is
 obj_type = typeof(σx_2)
 ```
 
-This is exactly what the Julia compiler sees: it is a [`QuantumObject`](@ref), composed by a field of type `SparseMatrixCSC{ComplexF64, Int64}` (i.e., the 8x8 matrix containing the Pauli matrix, tensored with the identity matrices of the other two qubits). Then, we can also see that it is a [`OperatorQuantumObject`](@ref), with `3` subsystems in total. Hence, just looking at the type of the object, the compiler has all the information it needs to generate a specialized version of the functions.
+This is exactly what the Julia compiler sees: it is a [`QuantumObject`](@ref), composed by a field of type `SparseMatrixCSC{ComplexF64, Int64}` (i.e., the 8x8 matrix containing the Pauli matrix, tensored with the identity matrices of the other two qubits). Then, we can also see that it is a [`Operator`](@ref), with `3` subsystems in total. Hence, just looking at the type of the object, the compiler has all the information it needs to generate a specialized version of the functions.
 
 Let's see more in the details all the internal fields of the [`QuantumObject`](@ref) type:
 
@@ -174,7 +174,6 @@ fieldnames(obj_type)
 σx_2.type
 ```
 
-[`Operator`](@ref) is a synonym for [`OperatorQuantumObject`](@ref).
 
 ```@example type-stability
 σx_2.dims

docs/src/resources/api.md

@@ -21,17 +21,11 @@ Space
 Dimensions
 GeneralDimensions
 AbstractQuantumObject
-BraQuantumObject
 Bra
-KetQuantumObject
 Ket
-OperatorQuantumObject
 Operator
-OperatorBraQuantumObject
 OperatorBra
-OperatorKetQuantumObject
 OperatorKet
-SuperOperatorQuantumObject
 SuperOperator
 QuantumObject
 QuantumObjectEvolution

ext/QuantumToolboxMakieExt.jl

@@ -54,7 +54,7 @@ function QuantumToolbox.plot_wigner(
     location::Union{GridPosition,Nothing} = nothing,
     colorbar::Bool = false,
     kwargs...,
-) where {OpType<:Union{BraQuantumObject,KetQuantumObject,OperatorQuantumObject}}
+) where {OpType<:Union{Bra,Ket,Operator}}
     QuantumToolbox.getVal(projection) == :two_dim ||
         QuantumToolbox.getVal(projection) == :three_dim ||
         throw(ArgumentError("Unsupported projection: $projection"))
@@ -84,7 +84,7 @@ function _plot_wigner(
     location::Union{GridPosition,Nothing},
     colorbar::Bool;
     kwargs...,
-) where {OpType<:Union{BraQuantumObject,KetQuantumObject,OperatorQuantumObject}}
+) where {OpType<:Union{Bra,Ket,Operator}}
     fig, location = _getFigAndLocation(location)
 
     lyt = GridLayout(location)
@@ -117,7 +117,7 @@ function _plot_wigner(
     location::Union{GridPosition,Nothing},
     colorbar::Bool;
     kwargs...,
-) where {OpType<:Union{BraQuantumObject,KetQuantumObject,OperatorQuantumObject}}
+) where {OpType<:Union{Bra,Ket,Operator}}
     fig, location = _getFigAndLocation(location)
 
     lyt = GridLayout(location)
@@ -148,7 +148,7 @@ end
         unit_y_range::Bool = true,
         location::Union{GridPosition,Nothing} = nothing,
         kwargs...
-    ) where {SType<:Union{KetQuantumObject,OperatorQuantumObject}}
+    ) where {SType<:Union{Ket,Operator}}
 
 Plot the [Fock state](https://en.wikipedia.org/wiki/Fock_state) distribution of `ρ`. 
 
@@ -178,7 +178,7 @@ function QuantumToolbox.plot_fock_distribution(
     unit_y_range::Bool = true,
     location::Union{GridPosition,Nothing} = nothing,
     kwargs...,
-) where {SType<:Union{BraQuantumObject,KetQuantumObject,OperatorQuantumObject}}
+) where {SType<:Union{Bra,Ket,Operator}}
     return _plot_fock_distribution(
         library,
         ρ;
@@ -196,7 +196,7 @@ function _plot_fock_distribution(
     unit_y_range::Bool = true,
     location::Union{GridPosition,Nothing} = nothing,
     kwargs...,
-) where {SType<:Union{BraQuantumObject,KetQuantumObject,OperatorQuantumObject}}
+) where {SType<:Union{Bra,Ket,Operator}}
     ρ = ket2dm(ρ)
     D = prod(ρ.dims)
     isapprox(tr(ρ), 1, atol = 1e-4) || (@warn "The input ρ should be normalized.")

src/correlations.jl

@@ -29,13 +29,13 @@ function correlation_3op_2t(
     tlist::AbstractVector,
     τlist::AbstractVector,
     c_ops::Union{Nothing,AbstractVector,Tuple},
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject},
-    C::QuantumObject{OperatorQuantumObject};
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator},
+    C::QuantumObject{Operator};
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 }
     # check tlist and τlist
     _check_correlation_time_list(tlist)
@@ -78,13 +78,13 @@ function correlation_3op_1t(
     ψ0::Union{Nothing,QuantumObject{StateOpType}},
     τlist::AbstractVector,
     c_ops::Union{Nothing,AbstractVector,Tuple},
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject},
-    C::QuantumObject{OperatorQuantumObject};
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator},
+    C::QuantumObject{Operator};
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 }
     corr = correlation_3op_2t(H, ψ0, [0], τlist, c_ops, A, B, C; kwargs...)
 
@@ -114,13 +114,13 @@ function correlation_2op_2t(
     tlist::AbstractVector,
     τlist::AbstractVector,
     c_ops::Union{Nothing,AbstractVector,Tuple},
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject};
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator};
     reverse::Bool = false,
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 }
     C = eye(prod(H.dimensions), dims = H.dimensions)
     if reverse
@@ -153,13 +153,13 @@ function correlation_2op_1t(
     ψ0::Union{Nothing,QuantumObject{StateOpType}},
     τlist::AbstractVector,
     c_ops::Union{Nothing,AbstractVector,Tuple},
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject};
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator};
     reverse::Bool = false,
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 }
     corr = correlation_2op_2t(H, ψ0, [0], τlist, c_ops, A, B; reverse = reverse, kwargs...)
 

src/deprecated.jl

@@ -33,14 +33,14 @@ correlation_3op_2t(
     ψ0::QuantumObject{StateOpType},
     t_l::AbstractVector,
     τ_l::AbstractVector,
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject},
-    C::QuantumObject{OperatorQuantumObject},
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator},
+    C::QuantumObject{Operator},
     c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 } = error(
     "The parameter order of `correlation_3op_2t` has been changed, please use `?correlation_3op_2t` to check the updated docstring.",
 )
@@ -49,14 +49,14 @@ correlation_3op_1t(
     H::QuantumObject{HOpType},
     ψ0::QuantumObject{StateOpType},
     τ_l::AbstractVector,
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject},
-    C::QuantumObject{OperatorQuantumObject},
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator},
+    C::QuantumObject{Operator},
     c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 } = error(
     "The parameter order of `correlation_3op_1t` has been changed, please use `?correlation_3op_1t` to check the updated docstring.",
 )
@@ -66,14 +66,14 @@ correlation_2op_2t(
     ψ0::QuantumObject{StateOpType},
     t_l::AbstractVector,
     τ_l::AbstractVector,
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject},
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator},
     c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
     reverse::Bool = false,
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 } = error(
     "The parameter order of `correlation_2op_2t` has been changed, please use `?correlation_2op_2t` to check the updated docstring.",
 )
@@ -82,14 +82,14 @@ correlation_2op_1t(
     H::QuantumObject{HOpType},
     ψ0::QuantumObject{StateOpType},
     τ_l::AbstractVector,
-    A::QuantumObject{OperatorQuantumObject},
-    B::QuantumObject{OperatorQuantumObject},
+    A::QuantumObject{Operator},
+    B::QuantumObject{Operator},
     c_ops::Union{Nothing,AbstractVector,Tuple} = nothing;
     reverse::Bool = false,
     kwargs...,
 ) where {
-    HOpType<:Union{OperatorQuantumObject,SuperOperatorQuantumObject},
-    StateOpType<:Union{KetQuantumObject,OperatorQuantumObject},
+    HOpType<:Union{Operator,SuperOperator},
+    StateOpType<:Union{Ket,Operator},
 } = error(
     "The parameter order of `correlation_2op_1t` has been changed, please use `?correlation_2op_1t` to check the updated docstring.",
 )

src/entropy.jl

@@ -48,7 +48,7 @@ function entropy_vn(
     ρ::QuantumObject{ObjType};
     base::Int = 0,
     tol::Real = 1e-15,
-) where {ObjType<:Union{KetQuantumObject,OperatorQuantumObject}}
+) where {ObjType<:Union{Ket,Operator}}
     T = eltype(ρ)
     vals = eigenenergies(ket2dm(ρ))
     indexes = findall(x -> abs(x) > tol, vals)
@@ -79,8 +79,8 @@ function entropy_relative(
     base::Int = 0,
     tol::Real = 1e-15,
 ) where {
-    ObjType1<:Union{KetQuantumObject,OperatorQuantumObject},
-    ObjType2<:Union{KetQuantumObject,OperatorQuantumObject},
+    ObjType1<:Union{Ket,Operator},
+    ObjType2<:Union{Ket,Operator},
 }
     check_dimensions(ρ, σ)
 
@@ -131,7 +131,7 @@ Calculates the quantum linear entropy ``S_L = 1 - \textrm{Tr} \left[ \hat{\rho}^
 
 Note that `ρ` can be either a [`Ket`](@ref) or an [`Operator`](@ref).
 """
-entropy_linear(ρ::QuantumObject{ObjType}) where {ObjType<:Union{KetQuantumObject,OperatorQuantumObject}} =
+entropy_linear(ρ::QuantumObject{ObjType}) where {ObjType<:Union{Ket,Operator}} =
     1.0 - purity(ρ) # use 1.0 to make sure it always return value in Float-type
 
 @doc raw"""
@@ -153,7 +153,7 @@ function entropy_mutual(
     selA::Union{Int,AbstractVector{Int},Tuple},
     selB::Union{Int,AbstractVector{Int},Tuple};
     kwargs...,
-) where {ObjType<:Union{KetQuantumObject,OperatorQuantumObject},N}
+) where {ObjType<:Union{Ket,Operator},N}
     # check if selA and selB matches the dimensions of ρAB
     sel_A_B = (selA..., selB...)
     (length(sel_A_B) != N) && throw(
@@ -185,7 +185,7 @@ entropy_conditional(
     ρAB::QuantumObject{ObjType,<:AbstractDimensions{N,N}},
     selB::Union{Int,AbstractVector{Int},Tuple};
     kwargs...,
-) where {ObjType<:Union{KetQuantumObject,OperatorQuantumObject},N} =
+) where {ObjType<:Union{Ket,Operator},N} =
     entropy_vn(ρAB; kwargs...) - entropy_vn(ptrace(ρAB, selB); kwargs...)
 
 @doc raw"""
@@ -203,7 +203,7 @@ function entanglement(
     ρ::QuantumObject{OpType},
     sel::Union{Int,AbstractVector{Int},Tuple},
     kwargs...,
-) where {OpType<:Union{KetQuantumObject,OperatorQuantumObject}}
+) where {OpType<:Union{Ket,Operator}}
     p = purity(ρ)
     isapprox(p, 1; atol = 1e-2) || throw(
         ArgumentError(
@@ -229,7 +229,7 @@ Calculate the [concurrence](https://en.wikipedia.org/wiki/Concurrence_(quantum_c
 
 - [Hill-Wootters1997](@citet)
 """
-function concurrence(ρ::QuantumObject{OpType}) where {OpType<:Union{KetQuantumObject,OperatorQuantumObject}}
+function concurrence(ρ::QuantumObject{OpType}) where {OpType<:Union{Ket,Operator}}
     (ρ.dimensions == Dimensions((Space(2), Space(2)))) || throw(
         ArgumentError(
             "The `concurrence` only works for a two-qubit state, invalid dims = $(_get_dims_string(ρ.dimensions)).",

src/metrics.jl

@@ -16,14 +16,14 @@ Here, the definition is from [Nielsen-Chuang2011](@citet). It is the square root
 
 Note that `ρ` and `σ` must be either [`Ket`](@ref) or [`Operator`](@ref).
 """
-function fidelity(ρ::QuantumObject{OperatorQuantumObject}, σ::QuantumObject{OperatorQuantumObject})
+function fidelity(ρ::QuantumObject{Operator}, σ::QuantumObject{Operator})
     sqrt_ρ = sqrt(ρ)
     eigval = abs.(eigvals(sqrt_ρ * σ * sqrt_ρ))
     return sum(sqrt, eigval)
 end
-fidelity(ρ::QuantumObject{OperatorQuantumObject}, ψ::QuantumObject{KetQuantumObject}) = sqrt(abs(expect(ρ, ψ)))
-fidelity(ψ::QuantumObject{KetQuantumObject}, σ::QuantumObject{OperatorQuantumObject}) = fidelity(σ, ψ)
-fidelity(ψ::QuantumObject{KetQuantumObject}, ϕ::QuantumObject{KetQuantumObject}) = abs(dot(ψ, ϕ))
+fidelity(ρ::QuantumObject{Operator}, ψ::QuantumObject{Ket}) = sqrt(abs(expect(ρ, ψ)))
+fidelity(ψ::QuantumObject{Ket}, σ::QuantumObject{Operator}) = fidelity(σ, ψ)
+fidelity(ψ::QuantumObject{Ket}, ϕ::QuantumObject{Ket}) = abs(dot(ψ, ϕ))
 
 @doc raw"""
     tracedist(ρ::QuantumObject, σ::QuantumObject)
@@ -37,8 +37,8 @@ tracedist(
     ρ::QuantumObject{ObjType1},
     σ::QuantumObject{ObjType2},
 ) where {
-    ObjType1<:Union{KetQuantumObject,OperatorQuantumObject},
-    ObjType2<:Union{KetQuantumObject,OperatorQuantumObject},
+    ObjType1<:Union{Ket,Operator},
+    ObjType2<:Union{Ket,Operator},
 } = norm(ket2dm(ρ) - ket2dm(σ), 1) / 2
 
 @doc raw"""
@@ -56,8 +56,8 @@ function hilbert_dist(
     ρ::QuantumObject{ObjType1},
     σ::QuantumObject{ObjType2},
 ) where {
-    ObjType1<:Union{KetQuantumObject,OperatorQuantumObject},
-    ObjType2<:Union{KetQuantumObject,OperatorQuantumObject},
+    ObjType1<:Union{Ket,Operator},
+    ObjType2<:Union{Ket,Operator},
 }
     check_dimensions(ρ, σ)
 
@@ -80,8 +80,8 @@ function hellinger_dist(
     ρ::QuantumObject{ObjType1},
     σ::QuantumObject{ObjType2},
 ) where {
-    ObjType1<:Union{KetQuantumObject,OperatorQuantumObject},
-    ObjType2<:Union{KetQuantumObject,OperatorQuantumObject},
+    ObjType1<:Union{Ket,Operator},
+    ObjType2<:Union{Ket,Operator},
 }
     # Ket (pure state) doesn't need to do square root
     sqrt_ρ = isket(ρ) ? ket2dm(ρ) : sqrt(ρ)