Merge pull request #620 from JuliaDiff/ox/zeromore

iszero for Tangents
JuliaDiff · May 9, 2023 · 7ccf8ed · 7ccf8ed
2 parents 79ba4ef + cc7b906
commit 7ccf8ed
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/tangent_types/tangent.jl b/src/tangent_types/tangent.jl
@@ -96,6 +96,10 @@ function Base.show(io::IO, tangent::Tangent{P}) where {P}
     end
 end
 
+Base.iszero(::Tangent{<:,NamedTuple{}}) = true
+Base.iszero(::Tangent{<:,Tuple{}}) = true
+Base.iszero(t::Tangent) = all(iszero, backing(t))
+
 Base.first(tangent::Tangent{P,T}) where {P,T<:Union{Tuple,NamedTuple}} = first(backing(canonicalize(tangent)))
 Base.last(tangent::Tangent{P,T}) where {P,T<:Union{Tuple,NamedTuple}} = last(backing(canonicalize(tangent)))
 

diff --git a/test/tangent_types/tangent.jl b/test/tangent_types/tangent.jl
@@ -369,6 +369,16 @@ end
         @test_throws MethodError Tangent{Foo}(; y=1.5, x=2.5) * @thunk [1 2; 3 4]
     end
 
+    @testset "iszero" begin
+        @test iszero(Tangent{Foo}())
+        @test iszero(Tangent{Tuple{}}())
+        @test iszero(Tangent{Foo}(; x=ZeroTangent()))
+        @test iszero(Tangent{Foo}(; y=0.0))
+        @test iszero(Tangent{Foo}(; x=Tangent{Tuple{}}(), y=0.0))
+
+        @test !iszero(Tangent{Foo}(; y=3.0))
+    end
+
     @testset "show" begin
         @test repr(Tangent{Foo}(; x=1)) == "Tangent{Foo}(x = 1,)"
         # check for exact regex match not occurence( `^...$`)