Add dir field to AutoFiniteDiff (#106)

* add dir field to AutoFiniteDiff

* add dir to docstrings and tests

* increment minor version

* Update src/dense.jl

* fix printing

* Add test

---------

Co-authored-by: Guillaume Dalle <[email protected]>

Author: jClugstor

Project.toml

@@ -1,7 +1,7 @@
 name = "ADTypes"
 uuid = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
 authors = ["Vaibhav Dixit <[email protected]>, Guillaume Dalle and contributors"]
-version = "1.12.1"
+version = "1.13.0"
 
 [deps]
 ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"

src/dense.jl

@@ -115,13 +115,15 @@ Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
   - `fdhtype::T3`: finite difference type for the Hessian
   - `relstep`: relative finite difference step size
   - `absstep`: absolute finite difference step size
+  - `dir`: direction of the finite difference step
 """
-Base.@kwdef struct AutoFiniteDiff{T1, T2, T3, S1, S2} <: AbstractADType
+Base.@kwdef struct AutoFiniteDiff{T1, T2, T3, S1, S2, S3} <: AbstractADType
     fdtype::T1 = Val(:forward)
     fdjtype::T2 = fdtype
     fdhtype::T3 = Val(:hcentral)
     relstep::S1 = nothing
     absstep::S2 = nothing
+    dir::S3 = true
 end
 
 mode(::AutoFiniteDiff) = ForwardMode()
@@ -137,7 +139,9 @@ function Base.show(io::IO, backend::AutoFiniteDiff)
     !isnothing(backend.relstep) &&
         print(io, "relstep=", repr(backend.relstep; context = io), ", ")
     !isnothing(backend.absstep) &&
-        print(io, "absstep=", repr(backend.absstep; context = io))
+        print(io, "absstep=", repr(backend.absstep; context = io), ", ")
+    backend.dir != true &&
+        print(io, "dir=", repr(backend.dir; context = io))
     print(io, ")")
 end
 

test/dense.jl

@@ -69,8 +69,9 @@ end
     @test ad.fdhtype === Val(:hcentral)
     @test ad.relstep === nothing
     @test ad.absstep === nothing
+    @test ad.dir
 
-    ad = AutoFiniteDiff(; fdtype = Val(:central), fdjtype = Val(:forward), relstep = 1e-3, absstep = 1e-4)
+    ad = AutoFiniteDiff(; fdtype = Val(:central), fdjtype = Val(:forward), relstep = 1e-3, absstep = 1e-4, dir = false)
     @test ad isa AbstractADType
     @test ad isa AutoFiniteDiff
     @test mode(ad) isa ForwardMode
@@ -79,6 +80,7 @@ end
     @test ad.fdhtype === Val(:hcentral)
     @test ad.relstep == 1e-3
     @test ad.absstep == 1e-4
+    @test !ad.dir
 end
 
 @testset "AutoFiniteDifferences" begin

test/runtests.jl

@@ -63,7 +63,8 @@ function every_ad_with_options()
         AutoEnzyme(mode = :forward),
         AutoFastDifferentiation(),
         AutoFiniteDiff(),
-        AutoFiniteDiff(fdtype = :fd, fdjtype = :fdj, fdhtype = :fdh),
+        AutoFiniteDiff(fdtype = :fd, fdjtype = :fdj, fdhtype = :fdh,
+            relstep = 1, absstep = 2, dir = false),
         AutoFiniteDifferences(; fdm = :fdm),
         AutoForwardDiff(),
         AutoForwardDiff(chunksize = 3, tag = :tag),