Merge pull request #510 from SciML/returncode

Update return codes from symbols to ReturnCode

Author: ChrisRackauckas

src/iterator_interface.jl

@@ -2,7 +2,7 @@
   if integrator.opts.advance_to_tstop
     @inbounds while integrator.tdir * integrator.t < first(integrator.opts.tstops)
       loopheader!(integrator)
-      check_error!(integrator) != :Success && return
+      check_error!(integrator) != ReturnCode.Success && return
       perform_step!(integrator,integrator.cache)
       loopfooter!(integrator)
     end
@@ -12,7 +12,7 @@
     @inbounds loopfooter!(integrator)
     @inbounds while !integrator.accept_step
       loopheader!(integrator)
-      check_error!(integrator) != :Success && return
+      check_error!(integrator) != ReturnCode.Success && return
       perform_step!(integrator,integrator.cache)
       loopfooter!(integrator)
     end

src/solve.jl

@@ -607,7 +607,7 @@ function DiffEqBase.solve!(integrator::SDEIntegrator)
   @inbounds while !isempty(integrator.opts.tstops)
     while integrator.tdir*integrator.t < first(integrator.opts.tstops)
       loopheader!(integrator)
-      if integrator.do_error_check && check_error!(integrator) != :Success
+      if integrator.do_error_check && check_error!(integrator) != ReturnCode.Success
         return integrator.sol
       end
       perform_step!(integrator,integrator.cache)
@@ -628,7 +628,7 @@ function DiffEqBase.solve!(integrator::SDEIntegrator)
   if integrator.sol.retcode != :Default
     return integrator.sol
   end
-  integrator.sol = DiffEqBase.solution_new_retcode(integrator.sol,:Success)
+  integrator.sol = DiffEqBase.solution_new_retcode(integrator.sol,ReturnCode.Success)
 end
 
 # Helpers

test/levy_areas.jl

@@ -28,7 +28,7 @@ end
 
   for alg ∈ LevyArea.ITER_INT_ALGS
     @test diag(StochasticDiffEq.get_iterated_I(dt, W.dW, W.dZ, alg, nothing, 1)) == true_diag
-  end   
+  end
 end
 
 # Commutative noise tests
@@ -44,7 +44,7 @@ end
 
   for alg ∈ LevyArea.ITER_INT_ALGS
     @test diag(StochasticDiffEq.get_iterated_I(dt, W.dW, W.dZ, alg, nothing, 1)) == diag(true_commute)
-  end   
+  end
 end
 
 
@@ -90,7 +90,7 @@ function test_compare_sample_mean_and_var(alg, Δ, m, samples=Int(1e6), p=Int(1e
   calculate_step!(W,dt,nothing,nothing)
   for i in 1:10
     accept_step!(W,dt,nothing,nothing)
-  end  
+  end
 
   xs = [StochasticDiffEq.get_iterated_I(Δ, W.dW, W.dZ, alg, p, 1)[1,2]]
   coms = [1//2*W.dW[1]*W.dW[2]]
@@ -100,7 +100,7 @@ function test_compare_sample_mean_and_var(alg, Δ, m, samples=Int(1e6), p=Int(1e
     accept_step!(W,Δ,nothing,nothing)
     com = 1//2*W.dW[1]*W.dW[2]
     x = StochasticDiffEq.get_iterated_I(Δ, W.dW, W.dZ, alg, p, 1)[1,2]
-    
+
     push!(xs,x)
     push!(coms,com)
   end
@@ -119,7 +119,7 @@ end
     Random.seed!(seed)
     I = StochasticDiffEq.get_iterated_I(dt, W.dW, W.dZ, alg, 1, 1)
     Random.seed!(seed)
-    A = LevyArea.levyarea(W.dW/√dt, 1, alg) 
+    A = LevyArea.levyarea(W.dW/√dt, 1, alg)
     @test dt*A + true_commute == I # because of correction with \mu term
     @test diag(A) == diag(zero(A))
     @test diag(true_commute) == diag(I)
@@ -131,15 +131,15 @@ end
 
     # test other StatsJ
     @time test_compare_sample_mean_and_var(alg, 1.0, 2)
-  end  
+  end
 end
 
 @testset "Simulate non-com. SDEs tests" begin
   u₀ = [0.0,0.0,0.0]
   f(u,p,t) = [0.0,0.0,0.0]
   g(u,p,t) = [1.0 0.0;0.0 1.0;0.0 u[1]]
   f!(du,u,p,t) = du .*= false
-  function g!(du,u,p,t) 
+  function g!(du,u,p,t)
     du[1,1] = 1.0
     du[2,2] = 1.0
     du[3,2] = u[1]
@@ -151,16 +151,16 @@ end
   prob! = SDEProblem(f!,g!,u₀,(0.0,1.0); noise_rate_prototype=zeros(3,2))
 
   sol = solve(prob, RKMilGeneral(;ii_approx=IICommutative()), dt=dt, adaptive=false)
-  @test sol.retcode == :Success
+  @test sol.retcode == ReturnCode.Success
   sol = solve(prob, RKMilGeneral(;ii_approx=IILevyArea()), dt=dt, adaptive=false)
-  @test sol.retcode == :Success
+  @test sol.retcode == ReturnCode.Success
   sol = solve(prob, RKMilGeneral(ii_approx=Fourier()), dt=dt, adaptive=false)
-  @test sol.retcode == :Success
+  @test sol.retcode == ReturnCode.Success
 
   sol = solve(prob!, RKMilGeneral(;ii_approx=IICommutative()), dt=dt, adaptive=false)
-  @test sol.retcode == :Success
+  @test sol.retcode == ReturnCode.Success
   sol = solve(prob!, RKMilGeneral(;ii_approx=IILevyArea()), dt=dt, adaptive=false)
-  @test sol.retcode == :Success
+  @test sol.retcode == ReturnCode.Success
   sol = solve(prob!, RKMilGeneral(ii_approx=Fourier()), dt=dt, adaptive=false)
-  @test sol.retcode == :Success
+  @test sol.retcode == ReturnCode.Success
 end

test/sparsediff_tests.jl

@@ -44,7 +44,7 @@ prob_sp = SDEProblem(sdefun_sp,g,u0,tspan)
 prob_std = SDEProblem(f,g,u0,tspan)
 
 sol_sp=solve(prob_sp,SKenCarp(autodiff=false))
-@test sol_sp.retcode==:Success#test sparse finitediff
+@test sol_sp.retcode== ReturnCode.Success#test sparse finitediff
 sol=solve(prob_std,SKenCarp(autodiff=false))
 @test sol_sp.u[end]≈sol.u[end] atol=1e-4
 @test length(sol_sp.t)==length(sol.t)