Merge pull request #46 from tpapp/tp/add-ascii-aliases

Add scalar aliases.

Author: tpapp

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 0.3.3
+
+- Add ASCII aliases for common scalar transforms
+
 # 0.3.2
 
 - Check length of inputs for CorrCholeskyFactor

Project.toml

@@ -1,7 +1,7 @@
 name = "TransformVariables"
 uuid = "84d833dd-6860-57f9-a1a7-6da5db126cff"
 authors = ["Tamas K. Papp <[email protected]>"]
-version = "0.3.2"
+version = "0.3.3"
 
 [deps]
 ArgCheck = "dce04be8-c92d-5529-be00-80e4d2c0e197"
@@ -12,6 +12,9 @@ MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 Parameters = "d96e819e-fc66-5662-9728-84c9c7592b0a"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
+[compat]
+julia = "^1"
+
 [extras]
 Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
 LogDensityProblems = "6fdf6af0-433a-55f7-b3ed-c6c6e0b8df7c"
@@ -22,6 +25,3 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
 test = ["Flux", "LogDensityProblems", "OffsetArrays", "Random", "ReverseDiff", "Test"]
-
-[compat]
-julia = "^1"

src/scalar.jl

@@ -1,4 +1,5 @@
-export ∞, asℝ, asℝ₊, asℝ₋, as𝕀
+export ∞, asℝ, asℝ₊, asℝ₋, as𝕀, as_real, as_positive_real, as_negative_real,
+    as_unit_interval
 
 """
 $(TYPEDEF)
@@ -170,14 +171,38 @@ function as(::Type{Real}, left::Real, right::Real)
     ScaledShiftedLogistic(right - left, left)
 end
 
-"Transform to a non-negative real number."
+"""
+Transform to a positive real number.
+
+`asℝ₊` and `as_positive_real` are equivalent alternatives.
+"""
 const asℝ₊ = as(Real, 0.0, ∞)
 
-"Transform to a non-positive real number."
+const as_positive_real = asℝ₊
+
+"""
+Transform to a negative real number.
+
+`asℝ₋` and `as_negative_real` are equivalent alternatives.
+"""
 const asℝ₋ = as(Real, -∞, 0.0)
 
-"Transform to the unit interval `(0, 1)`."
+const as_negative_real = asℝ₋
+
+"""
+Transform to the unit interval `(0, 1)`.
+
+`as𝕀` and `as_unit_interval` are equivalent alternatives.
+"""
 const as𝕀 = as(Real, 0.0, 1.0)
 
-"Transform to the real line (identity)."
+const as_unit_interval = as𝕀
+
+"""
+Transform to the real line (identity).
+
+`asℝ` and `as_real` are equivalent alternatives.
+"""
 const asℝ = as(Real, -∞, ∞)
+
+const as_real = asℝ

test/runtests.jl

@@ -63,6 +63,13 @@ end
     @test_throws DomainError inverse_and_logjac(t, 11.0)
 end
 
+@testset "scalar alternatives" begin
+    @test as_real ≡ asℝ
+    @test as_positive_real ≡ asℝ₊
+    @test as_negative_real ≡ asℝ₋
+    @test as_unit_interval ≡ as𝕀
+end
+
 @testset "to unit vector" begin
     @testset "dimension checks" begin
         U = UnitVector(3)