Merge pull request #158 from JuliaDiff/ox/simrandtan

make rand_tangent of struct with no perturbable fields return DoesNotExist

Author: oxinabox

src/rand_tangent.jl

@@ -37,7 +37,12 @@ function rand_tangent(rng::AbstractRNG, x::T) where {T}
         tangents = map(field_names) do field_name
             rand_tangent(rng, getfield(x, field_name))
         end
-        return Composite{T}(; NamedTuple{field_names}(tangents)...)
+        if all(tangent isa DoesNotExist for tangent in tangents)
+            # if none of my fields can be perturbed then I can't be perturbed
+            return DoesNotExist()
+        else
+            Composite{T}(; NamedTuple{field_names}(tangents)...)
+        end
     else
         return NO_FIELDS
     end

test/rand_tangent.jl

@@ -33,9 +33,13 @@ using FiniteDifferences: rand_tangent
         ((a=5.0, b=1), Composite{NamedTuple{(:a, :b), Tuple{Float64, Int}}}),
 
         # structs.
-        (sin, typeof(NO_FIELDS)),
         (Foo(5.0, 4, rand(rng, 3)), Composite{Foo}),
         (Foo(4.0, 3, Foo(5.0, 2, 4)), Composite{Foo}),
+        (sin, typeof(NO_FIELDS)),
+        # all fields DoesNotExist implies DoesNotExist
+        (Pair(:a, "b"), DoesNotExist),
+        (1:10, DoesNotExist),
+        (1:2:10, DoesNotExist),
 
         # LinearAlgebra types (also just structs).
         (