Merge pull request #198 from jClugstor/dir_docstrings

Update docstrings to document dir kwarg

Author: ChrisRackauckas

src/derivatives.jl

@@ -150,7 +150,9 @@ end
         f,
         x::AbstractArray{<:Number},
         cache::DerivativeCache{T1,T2,fdtype,returntype};
-        [epsilon_factor])
+        relstep=default_relstep(fdtype, eltype(x)),
+        absstep=relstep,
+        dir=true)
     
 Compute the derivative `df` of a scalar-valued map `f` at a collection of points `x`.
 

src/gradients.jl

@@ -120,7 +120,9 @@ end
         fdtype::Type{T1}=Val{:central},
         returntype::Type{T2}=eltype(x),
         inplace::Type{Val{T3}}=Val{true};
-        [epsilon_factor])
+        relstep=default_relstep(fdtype, eltype(x)),
+        absstep=relstep,
+        dir=true)
 
 Gradients are either a vector->scalar map `f(x)`, or a scalar->vector map `f(fx,x)` if `inplace=Val{true}` and `fx=f(x)` if `inplace=Val{false}`.
 
@@ -171,7 +173,8 @@ end
         fdtype::Type{T1}=Val{:central},
         returntype::Type{T2}=eltype(df),
         inplace::Type{Val{T3}}=Val{true};
-        [epsilon_factor])
+        relstep=default_relstep(fdtype, eltype(x)),
+        absstep=relstep)
 
 Gradients are either a vector->scalar map `f(x)`, or a scalar->vector map `f(fx,x)` if `inplace=Val{true}` and `fx=f(x)` if `inplace=Val{false}`.
 
@@ -200,7 +203,9 @@ end
         f,
         x::AbstractArray{<:Number},
         cache::GradientCache;
-        [epsilon_factor])
+        relstep=default_relstep(fdtype, eltype(x)),
+        absstep=relstep
+        dir=true)
 
 Gradients are either a vector->scalar map `f(x)`, or a scalar->vector map `f(fx,x)` if `inplace=Val{true}` and `fx=f(x)` if `inplace=Val{false}`.
 

src/jacobians.jl

@@ -152,7 +152,8 @@ end
         absstep=relstep,
         colorvec = 1:length(x),
         sparsity = nothing,
-        jac_prototype = nothing)
+        jac_prototype = nothing,
+        dir=true)
 
 Cache-less.
 """
@@ -187,7 +188,8 @@ void_setindex!(args...) = (setindex!(args...); return)
         absstep=relstep,
         colorvec = cache.colorvec,
         sparsity = cache.sparsity,
-        jac_prototype = nothing)
+        jac_prototype = nothing,
+        dir=true)
 
 Cached.
 """
@@ -399,7 +401,8 @@ end
         relstep=default_relstep(fdtype, eltype(x)),
         absstep=relstep,
         colorvec = cache.colorvec,
-        sparsity = cache.sparsity)
+        sparsity = cache.sparsity,
+        dir=true)
 
 Cached.
 """

src/jvp.jl

@@ -146,7 +146,8 @@ end
         v::AbstractArray{<:Number},
         cache::JVPCache;
         relstep=default_relstep(fdtype, eltype(x)),
-        absstep=relstep,)
+        absstep=relstep,
+        dir=true)
 
 Cached.
 """