Make common stochastic solution struct

Author: albertomercurio

docs/src/resources/api.md

@@ -189,8 +189,7 @@ cosm
 TimeEvolutionProblem
 TimeEvolutionSol
 TimeEvolutionMCSol
-TimeEvolutionSSESol
-TimeEvolutionSMESol
+TimeEvolutionStochasticSol
 sesolveProblem
 mesolveProblem
 mcsolveProblem

docs/src/users_guide/time_evolution/intro.md

@@ -36,7 +36,8 @@ The following table lists the solvers provided by `QuantumToolbox` for dynamic q
 | Unitary evolution, Schrödinger equation | [`sesolve`](@ref) | [`sesolveProblem`](@ref) | [`TimeEvolutionSol`](@ref) |
 | Lindblad master eqn. or Von Neuman eqn.| [`mesolve`](@ref) | [`mesolveProblem`](@ref) | [`TimeEvolutionSol`](@ref) |
 | Monte Carlo evolution | [`mcsolve`](@ref) | [`mcsolveProblem`](@ref) [`mcsolveEnsembleProblem`](@ref) | [`TimeEvolutionMCSol`](@ref) |
-| Stochastic Schrödinger equation | [`ssesolve`](@ref) | [`ssesolveProblem`](@ref) [`ssesolveEnsembleProblem`](@ref) | [`TimeEvolutionSSESol`](@ref) |
+| Stochastic Schrödinger equation | [`ssesolve`](@ref) | [`ssesolveProblem`](@ref) [`ssesolveEnsembleProblem`](@ref) | [`TimeEvolutionStochasticSol`](@ref) |
+| Stochastic master equation | [`smesolve`](@ref) | [`smesolveProblem`](@ref) [`smesolveEnsembleProblem`](@ref) | [`TimeEvolutionStochasticSol`](@ref) |
 
 !!! note "Solving dynamics with pre-defined problems"
     `QuantumToolbox` provides two different methods to solve the dynamics. One can use the function calls listed above by either taking all the operators (like Hamiltonian and collapse operators, etc.) as inputs directly, or generating the `prob`lems by yourself and take it as an input of the function call, e.g., `sesolve(prob)`.

src/time_evolution/smesolve.jl

@@ -301,7 +301,7 @@ Above, ``\hat{C}_n`` represent the operators related to pure dissipation, while
 
 # Returns
 
-- `sol::TimeEvolutionSMESol`: The solution of the time evolution. See also [`TimeEvolutionSMESol`](@ref).
+- `sol::TimeEvolutionStochasticSol`: The solution of the time evolution. See [`TimeEvolutionStochasticSol`](@ref).
 """
 function smesolve(
     H::Union{AbstractQuantumObject{OperatorQuantumObject},Tuple},
@@ -361,7 +361,7 @@ function smesolve(
         _se_me_sse_get_expvals(_sol_1) isa Nothing ? nothing :
         dropdims(sum(expvals_all, dims = 3), dims = 3) ./ length(sol)
 
-    return TimeEvolutionSMESol(
+    return TimeEvolutionStochasticSol(
         ntraj,
         ens_prob.times,
         states,

src/time_evolution/ssesolve.jl

@@ -390,7 +390,7 @@ Above, ``\hat{C}_n`` is the `n`-th collapse operator and ``dW_n(t)`` is the real
 
 # Returns
 
-- `sol::TimeEvolutionSSESol`: The solution of the time evolution. See also [`TimeEvolutionSSESol`](@ref).
+- `sol::TimeEvolutionStochasticSol`: The solution of the time evolution. See [`TimeEvolutionStochasticSol`](@ref).
 """
 function ssesolve(
     H::Union{AbstractQuantumObject{OperatorQuantumObject},Tuple},
@@ -455,7 +455,7 @@ function ssesolve(
             _se_me_sse_get_expvals(_sol_1) isa Nothing ? nothing :
             dropdims(sum(expvals_all, dims = 3), dims = 3) ./ length(sol)
 
-        return TimeEvolutionSSESol(
+        return TimeEvolutionStochasticSol(
             ntraj,
             _sol_1.prob.p.times,
             states,

src/time_evolution/time_evolution.jl

@@ -1,4 +1,4 @@
-export TimeEvolutionSol, TimeEvolutionMCSol, TimeEvolutionSSESol
+export TimeEvolutionSol, TimeEvolutionMCSol, TimeEvolutionStochasticSol
 
 export liouvillian_floquet, liouvillian_generalized
 
@@ -149,61 +149,7 @@ function Base.show(io::IO, sol::TimeEvolutionMCSol)
 end
 
 @doc raw"""
-    struct TimeEvolutionSSESol
-
-A structure storing the results and some information from solving trajectories of the Stochastic Shrodinger equation time evolution.
-
-# Fields (Attributes)
-
-- `ntraj::Int`: Number of trajectories
-- `times::AbstractVector`: The time list of the evolution.
-- `states::Vector{Vector{QuantumObject}}`: The list of result states in each trajectory.
-- `expect::Union{AbstractMatrix,Nothing}`: The expectation values (averaging all trajectories) corresponding to each time point in `times`.
-- `expect_all::Union{AbstractArray,Nothing}`: The expectation values corresponding to each trajectory and each time point in `times`
-- `converged::Bool`: Whether the solution is converged or not.
-- `alg`: The algorithm which is used during the solving process.
-- `abstol::Real`: The absolute tolerance which is used during the solving process.
-- `reltol::Real`: The relative tolerance which is used during the solving process.
-"""
-struct TimeEvolutionSSESol{
-    TT<:AbstractVector{<:Real},
-    TS<:AbstractVector,
-    TE<:Union{AbstractMatrix,Nothing},
-    TEA<:Union{AbstractArray,Nothing},
-    AlgT<:StochasticDiffEqAlgorithm,
-    AT<:Real,
-    RT<:Real,
-}
-    ntraj::Int
-    times::TT
-    states::TS
-    expect::TE
-    expect_all::TEA
-    converged::Bool
-    alg::AlgT
-    abstol::AT
-    reltol::RT
-end
-
-function Base.show(io::IO, sol::TimeEvolutionSSESol)
-    print(io, "Solution of quantum trajectories\n")
-    print(io, "(converged: $(sol.converged))\n")
-    print(io, "--------------------------------\n")
-    print(io, "num_trajectories = $(sol.ntraj)\n")
-    print(io, "num_states = $(length(sol.states[1]))\n")
-    if sol.expect isa Nothing
-        print(io, "num_expect = 0\n")
-    else
-        print(io, "num_expect = $(size(sol.expect, 1))\n")
-    end
-    print(io, "SDE alg.: $(sol.alg)\n")
-    print(io, "abstol = $(sol.abstol)\n")
-    print(io, "reltol = $(sol.reltol)\n")
-    return nothing
-end
-
-@doc raw"""
-    struct TimeEvolutionSMESol
+    struct TimeEvolutionStochasticSol
 
 A structure storing the results and some information from solving trajectories of the Stochastic Master Equation time evolution.
 
@@ -219,7 +165,7 @@ A structure storing the results and some information from solving trajectories o
 - `abstol::Real`: The absolute tolerance which is used during the solving process.
 - `reltol::Real`: The relative tolerance which is used during the solving process.
 """
-struct TimeEvolutionSMESol{
+struct TimeEvolutionStochasticSol{
     TT<:AbstractVector{<:Real},
     TS<:AbstractVector,
     TE<:Union{AbstractMatrix,Nothing},
@@ -239,8 +185,8 @@ struct TimeEvolutionSMESol{
     reltol::RT
 end
 
-function Base.show(io::IO, sol::TimeEvolutionSMESol)
-    print(io, "Solution of quantum trajectories\n")
+function Base.show(io::IO, sol::TimeEvolutionStochasticSol)
+    print(io, "Solution of stochastic quantum trajectories\n")
     print(io, "(converged: $(sol.converged))\n")
     print(io, "--------------------------------\n")
     print(io, "num_trajectories = $(sol.ntraj)\n")

test/core-test/time_evolution.jl

@@ -198,7 +198,7 @@
               "abstol = $(sol_mc_states.abstol)\n" *
               "reltol = $(sol_mc_states.reltol)\n"
         @test sol_sse_string ==
-              "Solution of quantum trajectories\n" *
+              "Solution of stochastic quantum trajectories\n" *
               "(converged: $(sol_sse.converged))\n" *
               "--------------------------------\n" *
               "num_trajectories = $(sol_sse.ntraj)\n" *
@@ -208,7 +208,7 @@
               "abstol = $(sol_sse.abstol)\n" *
               "reltol = $(sol_sse.reltol)\n"
         @test sol_sme_string ==
-              "Solution of quantum trajectories\n" *
+              "Solution of stochastic quantum trajectories\n" *
               "(converged: $(sol_sme.converged))\n" *
               "--------------------------------\n" *
               "num_trajectories = $(sol_sme.ntraj)\n" *