Skip to content

Commit 92870f8

Browse files
committed
update docstrings for dir
1 parent b6aa8e4 commit 92870f8

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

src/gradients.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ end
120120
fdtype::Type{T1}=Val{:central},
121121
returntype::Type{T2}=eltype(x),
122122
inplace::Type{Val{T3}}=Val{true};
123-
[epsilon_factor])
123+
[epsilon_factor],
124+
dir=true)
124125
125126
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}`.
126127
@@ -200,6 +201,7 @@ end
200201
f,
201202
x::AbstractArray{<:Number},
202203
cache::GradientCache;
204+
dir=true
203205
[epsilon_factor])
204206
205207
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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ end
152152
absstep=relstep,
153153
colorvec = 1:length(x),
154154
sparsity = nothing,
155-
jac_prototype = nothing)
155+
jac_prototype = nothing,
156+
dir=true)
156157
157158
Cache-less.
158159
"""
@@ -187,7 +188,8 @@ void_setindex!(args...) = (setindex!(args...); return)
187188
absstep=relstep,
188189
colorvec = cache.colorvec,
189190
sparsity = cache.sparsity,
190-
jac_prototype = nothing)
191+
jac_prototype = nothing,
192+
dir=true)
191193
192194
Cached.
193195
"""
@@ -399,7 +401,8 @@ end
399401
relstep=default_relstep(fdtype, eltype(x)),
400402
absstep=relstep,
401403
colorvec = cache.colorvec,
402-
sparsity = cache.sparsity)
404+
sparsity = cache.sparsity,
405+
dir=true)
403406
404407
Cached.
405408
"""

src/jvp.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,8 @@ end
146146
v::AbstractArray{<:Number},
147147
cache::JVPCache;
148148
relstep=default_relstep(fdtype, eltype(x)),
149-
absstep=relstep,)
149+
absstep=relstep,
150+
dir=true)
150151
151152
Cached.
152153
"""

0 commit comments

Comments
 (0)