diff src/LazyTensors/lazy_tensor.jl @ 1858:4a9be96f2569 feature/documenter_logo

Merge default
author Jonatan Werpers <jonatan@werpers.com>
date Sun, 12 Jan 2025 21:18:44 +0100
parents dfb43fdac9fc
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/LazyTensors/lazy_tensor.jl	Sun Jan 12 21:18:44 2025 +0100
@@ -0,0 +1,73 @@
+"""
+    LazyTensor{T,R,D}
+
+Describes a mapping of a `D` dimension tensor to an `R` dimension tensor.
+The action of the mapping is implemented through the method
+```julia
+    apply(t::LazyTensor{T,R,D}, v::AbstractArray{<:Any,D}, I::Vararg) where {R,D,T}
+```
+
+The size of the range and domain that the operator works with should be returned by
+the functions
+```julia
+    range_size(::LazyTensor)
+    domain_size(::LazyTensor)
+```
+to allow querying for one or the other.
+
+Optionally the action of the transpose may be defined through
+```julia
+    apply_transpose(t::LazyTensor{T,R,D}, v::AbstractArray{T,D}, I::Vararg) where {R,D,T}
+```
+"""
+abstract type LazyTensor{T,R,D} end
+
+"""
+    apply(t::LazyTensor{T,R,D}, v::AbstractArray{<:Any,D}, I::Vararg) where {R,D,T}
+
+Return the result of the mapping for a given index.
+"""
+function apply end
+
+"""
+    apply_transpose(t::LazyTensor{T,R,D}, v::AbstractArray{<:Any,R}, I::Vararg) where {R,D,T}
+
+Return the result of the transposed mapping for a given index.
+"""
+function apply_transpose end
+
+"""
+    range_dim(::LazyTensor)
+Return the dimension of the range space of a given mapping
+"""
+range_dim(::LazyTensor{T,R,D}) where {T,R,D} = R
+
+"""
+    domain_dim(::LazyTensor)
+Return the dimension of the domain space of a given mapping
+"""
+domain_dim(::LazyTensor{T,R,D}) where {T,R,D} = D
+
+
+"""
+    range_size(M::LazyTensor)
+
+Return the range size for the mapping.
+"""
+function range_size end
+
+"""
+    domain_size(M::LazyTensor)
+
+Return the domain size for the mapping.
+"""
+function domain_size end
+
+
+"""
+    eltype(::LazyTensor{T})
+
+The type of elements the LazyTensor acts on.
+"""
+Base.eltype(::LazyTensor{T}) where T = T
+