Merge pull request #78 from tpapp/tp/deprecations

deprecate t(x) interface

Author: tpapp

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Unreleased
 
+# 0.3.11
+
 - remove dependency on MacroTools for abstract dispatch workaround, but require Julia 1.3
+- deprecate t(x) interface
+
+# 0.3.10
+
+- compat bump
 
 # 0.3.9
 

Project.toml

@@ -1,7 +1,7 @@
 name = "TransformVariables"
 uuid = "84d833dd-6860-57f9-a1a7-6da5db126cff"
 authors = ["Tamas K. Papp <[email protected]>"]
-version = "0.3.10"
+version = "0.3.11"
 
 [deps]
 ArgCheck = "dce04be8-c92d-5529-be00-80e4d2c0e197"

src/generic.jl

@@ -117,7 +117,11 @@ Transform `x` using `t`. Also available as `t(x)`.
 """
 function transform end
 
-(t::AbstractTransform)(x) = transform(t, x)
+function (t::AbstractTransform)(x)
+    Base.depwarn("(t::AbstractTransform)(x) is deprecated, use transform(t, x) instead",
+                 :AbstractTransform) # hack, but works
+    transform(t, x)
+end
 
 """
 $(TYPEDEF)

test/runtests.jl

@@ -1,5 +1,3 @@
-const CIENV = get(ENV, "TRAVIS", "") == "true"  || get(ENV, "CI", "") == "true"
-
 using DocStringExtensions, LinearAlgebra, LogDensityProblems, OffsetArrays, Parameters,
     Random, Test, TransformVariables, StaticArrays
 import Tracker, ForwardDiff
@@ -8,6 +6,8 @@ using TransformVariables:
     AbstractTransform, ScalarTransform, VectorTransform, ArrayTransform,
     unit_triangular_dimension, logistic, logistic_logjac, logit, inverse_and_logjac
 
+const CIENV = get(ENV, "CI", "") == "true"
+
 include("utilities.jl")
 
 Random.seed!(1)
@@ -86,7 +86,6 @@ end
     @testset "dimension checks" begin
         U = UnitVector(3)
         x = zeros(3)               # incorrect
-        @test_throws ArgumentError U(x)
         @test_throws ArgumentError transform(U, x)
         @test_throws ArgumentError transform_and_logjac(U, x)
     end
@@ -107,7 +106,6 @@ end
     @testset "dimension checks" begin
         S = UnitSimplex(3)
         x = zeros(3)               # incorrect
-        @test_throws ArgumentError S(x)
         @test_throws ArgumentError transform(S, x)
         @test_throws ArgumentError transform_and_logjac(S, x)
     end
@@ -131,7 +129,6 @@ end
         C = CorrCholeskyFactor(3)
         wrong_x = zeros(dimension(C) + 1)
 
-        @test_throws ArgumentError C(wrong_x)
         @test_throws ArgumentError transform(C, wrong_x)
         @test_throws ArgumentError transform_and_logjac(C, wrong_x)
     end
@@ -282,7 +279,7 @@ end
         tt = as((a = as(Tuple(as(Vector, asℝ₊, 2) for _ in 1:N)),
                  b = as(Tuple(UnitVector(n) for n in 1:N))))
         x = randn(dimension(tt))
-        y = tt(x)
+        y = transform(tt, x)
         x′ = inverse(tt, y)
         @test x ≈ x′
     end
@@ -310,7 +307,7 @@ end
             f = as(Array, 9)))
     z = zeros(dimension(t))
     f(θ) = θ.a + θ.b + sum(abs2, θ.c.d) + sum(abs2, θ.c.e)
-    @test (@inferred f(t(z))) isa Float64
+    @test (@inferred f(transform(t, z))) isa Float64
     @test (@inferred transform_logdensity(t, f, z)) isa Float64
 end
 
@@ -486,12 +483,12 @@ end
 ####
 
 @testset "broadcasting" begin
-    @test as𝕀.([0, 0]) == [0.5, 0.5]
+    @test transform.(as𝕀, [0, 0]) == [0.5, 0.5]
 
     t = UnitVector(3)
     d = dimension(t)
     x = [zeros(d), zeros(d)]
-    @test t.(x) == map(t, x)
+    @test transform.(t, x) == map(x -> transform(t, x), x)
 end
 
 ####

test/utilities.jl

@@ -34,7 +34,7 @@ function test_transformation(t::AbstractTransform, is_valid_y;
         x isa ScalarTransform && @test dimension(x) == 1
         y = @inferred transform(t, x)
         @test is_valid_y(y)
-        @test t(x) == y         # callable
+        @test transform(t, x) == y
         y2, lj = @inferred transform_and_logjac(t, x)
         @test y2 == y
         if t isa ScalarTransform