rename differential to refine_differential

Author: oxinabox

src/ChainRulesCore.jl

@@ -2,7 +2,7 @@ module ChainRulesCore
 using Base.Broadcast: materialize, materialize!, broadcasted, Broadcasted, broadcastable
 
 export frule, rrule
-export wirtinger_conjugate, wirtinger_primal, differential
+export wirtinger_conjugate, wirtinger_primal, refine_differential
 export @scalar_rule, @thunk
 export extern, cast, store!
 export Wirtinger, Zero, One, Casted, DNE, Thunk, InplaceableThunk

src/differentials.jl

@@ -291,14 +291,14 @@ function itself, when that function is not a closure.
 const NO_FIELDS = DNE()
 
 """
-    differential(𝒟::Type, der)
+    refine_differential(𝒟::Type, der)
 
 Converts, if required, a differential object `der`
 (e.g. a `Number`, `AbstractDifferential`, `Matrix`, etc.),
 to another  differential that is more suited for the domain given by the type 𝒟.
 Often this will behave as the identity function on `der`.
 """
-function differential(::Type{<:Union{<:Real, AbstractArray{<:Real}}}, w::Wirtinger)
+function refine_differential(::Type{<:Union{<:Real, AbstractArray{<:Real}}}, w::Wirtinger)
     return wirtinger_primal(w) + wirtinger_conjugate(w)
 end
-differential(::Any, der) = der  # most of the time leave it alone.
+refine_differential(::Any, der) = der  # most of the time leave it alone.

src/rule_definition_tools.jl

@@ -81,7 +81,7 @@ function wirtinger_propagation_expr(𝒟, wirtinger_indices, Δs, ∂s)
     return quote  # This will be a block, so will have value equal to last statement
         $(∂_wirtinger_defs...)
         w = Wirtinger($primal_sum, $conjugate_sum)
-        differential($𝒟, w)
+        refine_differential($𝒟, w)
     end
 end
 

test/differentials.jl

@@ -81,17 +81,17 @@
     end
 
 
-    @testset "Differential" begin
-        @test differential(typeof(1.0 + 1im), Wirtinger(2,2)) == Wirtinger(2,2)
-        @test differential(typeof([1.0 + 1im]), Wirtinger(2,2)) == Wirtinger(2,2)
+    @testset "Refine Differential" begin
+        @test refine_differential(typeof(1.0 + 1im), Wirtinger(2,2)) == Wirtinger(2,2)
+        @test refine_differential(typeof([1.0 + 1im]), Wirtinger(2,2)) == Wirtinger(2,2)
 
-        @test differential(typeof(1.2), Wirtinger(2,2)) == 4
-        @test differential(typeof([1.2]), Wirtinger(2,2)) == 4
+        @test refine_differential(typeof(1.2), Wirtinger(2,2)) == 4
+        @test refine_differential(typeof([1.2]), Wirtinger(2,2)) == 4
 
         # For most differentials, in most domains, this does nothing
         for der in (DNE(), @thunk(23), @thunk(Wirtinger(2,2)), [1 2], One(), Zero(), 0.0)
             for 𝒟 in typeof.((1.0 + 1im, [1.0 + 1im], 1.2, [1.2]))
-                @test differential(𝒟, der) === der
+                @test refine_differential(𝒟, der) === der
             end
         end
     end