Merge pull request #1198 from SciML/add_simulation_type_preservation_tests

Add simulation type preservation tests

Author: TorkelE

test/simulation_and_solving/simulate_ODEs.jl

@@ -164,6 +164,39 @@ end
 
 ### Other Tests ###
 
+# Checks that solution values have types consistent with their input types.
+# Check that both float types are preserved in the solution (and problems), while integers are 
+# promoted to floats.
+# Checks that the time types are correct (`Float64` by default or possibly `Float32`).
+let
+    # Create model. Checks when input type is `Float64` the produced values are also `Float64`.
+    rn = @reaction_network begin
+        (k1,k2), X1 <--> X2
+    end
+    u0 = [:X1 => 1.0, :X2 => 3.0]
+    ps = [:k1 => 2.0, :k2 => 3.0]
+    oprob = ODEProblem(rn, u0, 1.0, ps)
+    osol = solve(oprob)
+    @test eltype(osol[:X1]) == eltype(osol[:X2]) == typeof(oprob[:X1]) == typeof(oprob[:X2]) == Float64
+    @test eltype(osol.t) == typeof(oprob.tspan[1]) == typeof(oprob.tspan[2]) == Float64
+
+    # Checks that `Int64` values are promoted to `Float64`. 
+    u0 = [:X1 => 1, :X2 => 3]
+    ps = [:k1 => 2, :k2 => 3]
+    oprob = ODEProblem(rn, u0, 1, ps)
+    osol = solve(oprob)
+    @test eltype(osol[:X1]) == eltype(osol[:X2]) == typeof(oprob[:X1]) == typeof(oprob[:X2]) == Float64
+    @test eltype(osol.t) == Float64
+
+    # Checks when values are `Float32` (a valid type and should be preserved).
+    u0 = [:X1 => 1.0f0, :X2 => 3.0f0]
+    ps = [:k1 => 2.0f0, :k2 => 3.0f0]
+    oprob = ODEProblem(rn, u0, 1.0f0, ps)
+    osol = solve(oprob)
+    @test eltype(osol[:X1]) == eltype(osol[:X2]) == typeof(oprob[:X1]) == typeof(oprob[:X2]) == Float32
+    @test eltype(osol.t) == typeof(oprob.tspan[1]) == typeof(oprob.tspan[2]) == Float32
+end
+
 # Tests simulating a network without parameters.
 let
     no_param_network = @reaction_network begin 

test/simulation_and_solving/simulate_SDEs.jl

@@ -383,6 +383,40 @@ end
 
 ### Other Tests ###
 
+# Checks that solution values have types consistent with their input types.
+# Check that both float types are preserved in the solution (and problems), while integers are 
+# promoted to floats.
+# Checks that the time types are correct (`Float64` by default or possibly `Float32`), however,
+# type conversion only occurs in the solution, and integer types are preserved in problems.
+let
+    # Create model. Checks when input type is `Float64` the produced values are also `Float64`.
+    rn = @reaction_network begin
+        (k1,k2), X1 <--> X2
+    end
+    u0 = [:X1 => 1.0, :X2 => 3.0]
+    ps = [:k1 => 2.0, :k2 => 3.0]
+    sprob = SDEProblem(rn, u0, 1.0, ps)
+    ssol = solve(sprob, ISSEM())
+    @test eltype(ssol[:X1]) == eltype(ssol[:X2]) == typeof(sprob[:X1]) == typeof(sprob[:X2]) == Float64
+    @test eltype(ssol.t) == typeof(sprob.tspan[1]) == typeof(sprob.tspan[2]) == Float64
+
+    # Checks that `Int64` values are promoted to `Float64`. 
+    u0 = [:X1 => 1, :X2 => 3]
+    ps = [:k1 => 2, :k2 => 3]
+    sprob = SDEProblem(rn, u0, 1, ps)
+    ssol = solve(sprob, ISSEM())
+    @test eltype(ssol[:X1]) == eltype(ssol[:X2]) == typeof(sprob[:X1]) == typeof(sprob[:X2]) == Float64
+    @test eltype(ssol.t) == Float64
+
+    # Checks when values are `Float32` (a valid type and should be preserved).
+    u0 = [:X1 => 1.0f0, :X2 => 3.0f0]
+    ps = [:k1 => 2.0f0, :k2 => 3.0f0]
+    sprob = SDEProblem(rn, u0, 1.0f0, ps)
+    ssol = solve(sprob, ISSEM())
+    @test eltype(ssol[:X1]) == eltype(ssol[:X2]) == typeof(sprob[:X1]) == typeof(sprob[:X2]) == Float32
+    @test eltype(ssol.t) == typeof(sprob.tspan[1]) == typeof(sprob.tspan[2]) == Float32
+end
+
 # Tests simulating a network without parameters.
 let
     no_param_network = @reaction_network begin

test/simulation_and_solving/simulate_jumps.jl

@@ -220,3 +220,47 @@ let
     @test (means1[1] - means1[2]) < .1 * means1[1]
     @test (means2[1] - means2[2]) < .1 * means2[1]
 end
+
+### Other Tests ###
+
+# Checks that solution values have types consistent with their input types.
+# Check that both float and integer types are preserved in the solution (and problems).
+# Checks that the time types are correct (`Float64` by default or possibly `Float32`).
+# `JumpInputs` currently does not support integer time spans. When it does, we will check that
+# these produce `Float64` time values.
+let
+    # Create model. Checks when input type is `Float64` the produced values are also `Float64`.
+    rn = @reaction_network begin
+        (k1,k2), X1 <--> X2
+    end
+    u0 = [:X1 => 1.0, :X2 => 3.0]
+    ps = [:k1 => 2.0, :k2 => 3.0]
+    jprob = JumpProblem(JumpInputs(rn, u0, (0.0, 1.0), ps))
+    jsol = solve(jprob)
+    @test eltype(jsol[:X1]) == eltype(jsol[:X2]) == typeof(jprob[:X1]) == typeof(jprob[:X2]) == Float64
+    @test eltype(jsol.t) == typeof(jprob.prob.tspan[1]) == typeof(jprob.prob.tspan[2]) == Float64
+
+    # Checks that `Int64` gives `Int64` species values.
+    u0 = [:X1 => 1 :X2 => 3]
+    ps = [:k1 => 2, :k2 => 3]
+    jprob = JumpProblem(JumpInputs(rn, u0, (0.0, 1.0), ps))
+    jsol = solve(jprob)
+    @test eltype(jsol[:X1]) == eltype(jsol[:X2]) == typeof(jprob[:X1]) == typeof(jprob[:X2]) == Int64
+    @test eltype(jsol.t) == typeof(jprob.prob.tspan[1]) == typeof(jprob.prob.tspan[2]) == Float64
+
+    # Checks when values are `Float32` (a valid type and should be preserved).
+    u0 = [:X1 => 1.0f0, :X2 => 3.0f0]
+    ps = [:k1 => 2.0f0, :k2 => 3.0f0]
+    jprob = JumpProblem(JumpInputs(rn, u0, (0.0f0, 1.0f0), ps))
+    jsol = solve(jprob)
+    @test eltype(jsol[:X1]) == eltype(jsol[:X2]) == typeof(jprob[:X1]) == typeof(jprob[:X2]) == Float32
+    @test eltype(jsol.t) == typeof(jprob.prob.tspan[1]) == typeof(jprob.prob.tspan[2]) == Float32
+
+    # Checks when values are `Int32` (a valid species type and should be preserved).
+    u0 = [:X1 => Int32(1), :X2 => Int32(3)]
+    ps = [:k1 => Int32(2), :k2 => Int32(3)]
+    jprob = JumpProblem(JumpInputs(rn, u0, (0.0, 1.0), ps))
+    jsol = solve(jprob)
+    @test eltype(jsol[:X1]) == eltype(jsol[:X2]) == typeof(jprob[:X1]) == typeof(jprob[:X2]) == Int32
+    @test eltype(jsol.t) == typeof(jprob.prob.tspan[1]) == typeof(jprob.prob.tspan[2]) == Float64
+end

test/simulation_and_solving/solve_nonlinear.jl

@@ -101,3 +101,34 @@ end
     @test f_eval(steady_state_network_3, [:X => sol1[X], :Y => sol1[Y], :Y2 => sol1[Y2], :XY2 => sol1[XY2]], p, 0.0) ≈ [0.0, 0.0, 0.0, 0.0] atol=1e-10
     @test f_eval(steady_state_network_3, [:X => sol2[X], :Y => sol2[Y], :Y2 => sol2[Y2], :XY2 => sol2[XY2]], p, 0.0) ≈ [0.0, 0.0, 0.0, 0.0] atol=1e-10
 end
+
+### Other Tests ###
+
+# Checks that solution values have types consistent with their input types.
+# Check for values that types that should be preserved (`Float64` and `Float32`) and types
+# that should be converted to the default (conversion of `Int64 to `Float64`).
+let
+    # Create model. Checks when input type is `Float64` that the problem and solution types are `Float64`.
+    rn = @reaction_network begin
+        (k1,k2), X1 <--> X2
+    end
+    u0 = [:X1 => 1.0, :X2 => 3.0]
+    ps = [:k1 => 2.0, :k2 => 3.0]
+    nlprob = NonlinearProblem(rn, u0, ps)
+    nlsol = solve(nlprob)
+    @test eltype(nlsol[:X1]) == eltype(nlsol[:X2]) == typeof(nlprob[:X1]) == typeof(nlprob[:X2]) == Float64
+
+    # Checks that input type `Int64` is converted to `Float64`.
+    u0 = [:X1 => 1, :X2 => 3]
+    ps = [:k1 => 2, :k2 => 3]
+    nlprob = NonlinearProblem(rn, u0, ps)
+    nlsol = solve(nlprob)
+    @test eltype(nlsol[:X1]) == eltype(nlsol[:X2]) == typeof(nlprob[:X1]) == typeof(nlprob[:X2]) == Float64
+
+    # Checks that input type `Float32` is preserved
+    u0 = [:X1 => 1.0f0, :X2 => 3.0f0]
+    ps = [:k1 => 2.0f0, :k2 => 3.0f0]
+    nlprob = NonlinearProblem(rn, u0, ps)
+    nlsol = solve(nlprob)
+    @test eltype(nlsol[:X1]) == eltype(nlsol[:X2]) == typeof(nlprob[:X1]) == typeof(nlprob[:X2]) == Float32
+end