Uniformized the obsdim argument over the transforms

Author: theogf

src/transform/functiontransform.jl

@@ -0,0 +1,12 @@
+"""
+    FunctionTransform
+
+    Take a function `f` as an argument which is going to act on each vector individually.
+    Make sure that `f` is supposed to act on a vector by eventually using broadcasting
+    For example `f(x)=sin(x)` -> `f(x)=sin.(x)`
+"""
+struct FunctionTransform{F} <: Transform
+    f::F
+end
+
+transform(t::FunctionTransform,X::T,obsdim::Int=defaultobs) where {T} = mapslices(t.f,X,dims=obsdim)

src/transform/lowranktransform.jl

@@ -5,7 +5,7 @@ end
 Base.size(tr::LowRankTransform,i::Int) = size(tr.proj,i)
 Base.size(tr::LowRankTransform) = size(tr.proj)
 
-function transform(t::LowRankTransform,X::AbstractMatrix{<:Real},obsdim::Int)
+function transform(t::LowRankTransform,X::AbstractMatrix{<:Real},obsdim::Int=defaultobs)
     @boundscheck size(t,2) != size(X,feature_dim(obsdim)) ?
         throw(DimensionMismatch("The projection matrix has size $(size(t)) and cannot be used on X with dimensions $(size(X))")) : nothing
     @inbounds _transform(t,X,obsdim)
@@ -15,4 +15,4 @@ function transform(t::LowRankTransform,x::AbstractVector{<:Real})
     t.proj*X
 end
 
-_transform(t::LowRankTransform,X::AbstractVecOrMat{<:Real},obsdim::Int) = obsdim == 2 ? t.proj * X : X * t.proj'
+_transform(t::LowRankTransform,X::AbstractVecOrMat{<:Real},obsdim::Int=defaultobs) = obsdim == 2 ? t.proj * X : X * t.proj'

src/transform/scaletransform.jl

@@ -27,7 +27,6 @@ function transform(t::ScaleTransform{<:AbstractVector{<:Real}},X::AbstractMatrix
     _transform(t,X,obsdim)
 end
 _transform(t::ScaleTransform{<:AbstractVector{<:Real}},x::AbstractVector{<:Real}) = t.s .* x
-_transform(t::ScaleTransform{<:AbstractVector{<:Real}},X::AbstractMatrix{<:Real},obsdim::Int) = obsdim == 1 ? t.s'.*X : t.s .* X
+_transform(t::ScaleTransform{<:AbstractVector{<:Real}},X::AbstractMatrix{<:Real},obsdim::Int=defaultobs) = obsdim == 1 ? t.s'.*X : t.s .* X
 
-transform(t::ScaleTransform{<:Real},x::AbstractVecOrMat,obsdim::Int) = transform(t,x)
-transform(t::ScaleTransform{<:Real},x::AbstractVecOrMat) = t.s .* x
+transform(t::ScaleTransform{<:Real},x::AbstractVecOrMat,obsdim::Int=defaultobs) = t.s .* x

src/transform/transform.jl

@@ -5,6 +5,7 @@ abstract type Transform end
 
 include("scaletransform.jl")
 include("lowranktransform.jl")
+include("functiontransform.jl")
 
 struct TransformChain <: Transform
     transforms::Vector{Transform}
@@ -16,7 +17,7 @@ function TransformChain(v::AbstractVector{<:Transform})
     TransformChain(v)
 end
 
-function transform(t::TransformChain,X::T,obsdim::Int=1) where {T}
+function transform(t::TransformChain,X::T,obsdim::Int=defaultobs) where {T}
     Xtr = copy(X)
     for tr in t.transforms
         Xtr = transform(tr,Xtr,obsdim)
@@ -28,24 +29,9 @@ Base.:∘(t₁::Transform,t₂::Transform) = TransformChain([t₂,t₁])
 Base.:∘(t::Transform,tc::TransformChain) = TransformChain(vcat(tc.transforms,t))
 Base.:∘(tc::TransformChain,t::Transform) = TransformChain(vcat(t,tc.transforms))
 
-"""
-    FunctionTransform
-
-    Take a function `f` as an argument which is going to act on each vector individually.
-    Make sure that `f` is supposed to act on a vector by eventually using broadcasting
-    For example `f(x)=sin(x)` -> `f(x)=sin.(x)`
-"""
-struct FunctionTransform{F} <: Transform
-    f::F
-end
-
-transform(t::FunctionTransform,X::T,obsdim::Int=1) where {T} = mapslices(t.f,X,obsdim) 
-
-
 struct IdentityTransform <: Transform end
 
-transform(t::IdentityTransform,x::AbstractArray,obsdim::Int) = transform(t,x)
-transform(t::IdentityTransform,x::AbstractArray) = return x
+transform(t::IdentityTransform,x::AbstractArray,obsdim::Int=defaultobs) = x
 
 ### TODO Maybe defining adjoints could help but so far it's not working