Rename stack to stack_transforms (#256)

* renamed stack to stack_transforms

* bump version

* reverted unintentional change

* dont export stack

* Apply suggestions from code review

* added missing constructor

* restricted the 2nd argument of Stacked

* Update src/bijectors/stacked.jl

Co-authored-by: David Widmann <devmotion@users.noreply.github.com>

---------

Co-authored-by: David Widmann <devmotion@users.noreply.github.com>

Author: torfjelde

Project.toml

@@ -1,6 +1,6 @@
 name = "Bijectors"
 uuid = "76274a88-744f-5084-9051-94815aaf08c4"
-version = "0.12.3"
+version = "0.12.4"
 
 [deps]
 ArgCheck = "dce04be8-c92d-5529-be00-80e4d2c0e197"

src/Bijectors.jl

@@ -66,7 +66,6 @@ export  TransformDistribution,
         Bijector,
         Inverse,
         Stacked,
-        stack,
         bijector,
         transformed,
         UnivariateTransformed,

src/bijectors/stacked.jl

@@ -21,12 +21,13 @@ b = stack(b1, b2)
 b([0.0, 1.0]) == [b1(0.0), 1.0]  # => true
 ```
 """
-struct Stacked{Bs, Rs} <: Transform
+struct Stacked{Bs, Rs<:Union{Tuple,AbstractArray}} <: Transform
     bs::Bs
     ranges::Rs
 end
 Stacked(bs::Tuple) = Stacked(bs, ntuple(i -> i:i, length(bs)))
 Stacked(bs::AbstractArray) = Stacked(bs, [i:i for i in 1:length(bs)])
+Stacked(bs...) = Stacked(bs, ntuple(i -> i:i, length(bs)))
 
 # Avoid mixing tuples and arrays.
 Stacked(bs::Tuple, ranges::AbstractArray) = Stacked(collect(bs), ranges)
@@ -47,7 +48,6 @@ isclosedform(b::Stacked) = all(isclosedform, b.bs)
 
 isinvertible(b::Stacked) = all(isinvertible, b.bs)
 
-stack(bs...) = Stacked(bs)
 
 # For some reason `inverse.(sb.bs)` was unstable... This works though.
 inverse(sb::Stacked) = Stacked(map(inverse, sb.bs), sb.ranges)

test/interface.jl

@@ -1,6 +1,3 @@
-# using Pkg; Pkg.activate("..")
-# using TestEnv; TestEnv.activate()
-
 using Test
 using Random
 using LinearAlgebra
@@ -204,7 +201,7 @@ end
     x = rand(d)
     y = b(x)
 
-    sb1 = @inferred stack(b, b, inverse(b), inverse(b))             # <= Tuple
+    sb1 = @inferred Stacked(b, b, inverse(b), inverse(b))             # <= Tuple
     res1 = with_logabsdet_jacobian(sb1, [x, x, y, y])
     @test sb1(param([x, x, y, y])) isa TrackedArray
 
@@ -222,7 +219,7 @@ end
 
     # value-test
     x = ones(3)
-    sb = @inferred stack(elementwise(exp), elementwise(log), Shift(5.0))
+    sb = @inferred Stacked(elementwise(exp), elementwise(log), Shift(5.0))
     res = with_logabsdet_jacobian(sb, x)
     @test sb(param(x)) isa TrackedArray
     @test sb(x) == [exp(x[1]), log(x[2]), x[3] + 5.0]

test/norm_flows.jl

@@ -117,10 +117,10 @@ end
     x = rand(d) .+ 10
     y = b(x)
 
-    sb = stack(b1, b1)
+    sb = Stacked(b1, b1)
     @test all((sb ∘ b)(x) .≤ 1.0)
 
-    sb = stack(b1, b2)
+    sb = Stacked(b1, b2)
     cb = (sb ∘ b)
     y = cb(x)
     @test (0 ≤ y[1] ≤ 1.0) && (0 < y[2])