add some docs

rveltz · Nov 29, 2016 · 864ff4d · 864ff4d
1 parent d1195a9
commit 864ff4d
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/solver.jl b/src/solver.jl
@@ -59,7 +59,7 @@ end
 """
   lsoda(f::Function, y0::Vector{Float64}, tspan::Vector{Float64}; userdata::Any=nothing, reltol::Union{Float64,Vector}=1e-4, abstol::Union{Float64,Vector}=1e-10)
 
-Solves a set of ordinary differential equations using the LSODA algorithm.
+Solves a set of ordinary differential equations using the LSODA algorithm. The vector field encoded in an inplace f::Function needs to have the self-explanatory arguments f(t, y, ydot, data)
 """
 function lsoda(f::Function, y0::Vector{Float64}, tspan::Vector{Float64}; userdata::Any=nothing, reltol::Union{Float64,Vector}=1e-4, abstol::Union{Float64,Vector}=1e-10)
   neq = Int32(length(y0))
@@ -113,6 +113,11 @@ function lsoda(f::Function, y0::Vector{Float64}, tspan::Vector{Float64}; userdat
   return ctx, yres
 end
 
+"""
+  lsoda_evolve!(ctx::lsoda_context_t,y::Vector{Float64},tspan::Vector{Float64};data=nothing)
+
+Solves a set of ordinary differential equations using the LSODA algorithm and the context variable ctx. This avoid re-allocating ctx.
+"""
 function lsoda_evolve!(ctx::lsoda_context_t,y::Vector{Float64},tspan::Vector{Float64};data=nothing)
 	if data != nothing
 		ctx.data.userdata = data