Mercurial > repos > public > sbplib_julia

annotate src/LazyTensors/lazy_tensor_operations.jl @ 448:912ae510dec9 feature/inflated_tensormapping

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use new name of IdentityMapping
author Jonatan Werpers <jonatan@werpers.com>
date Mon, 19 Oct 2020 21:04:51 +0200
parents 27e0e256e5d9
children 14d60de71b72
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
196
b3c252280a19 Move LazyArray and make LazyTensorMappingApplication and LazyElementwiseOperation subtypes of it
Jonatan Werpers <jonatan@werpers.com>
parents: 195
diff changeset
1 """
b3c252280a19 Move LazyArray and make LazyTensorMappingApplication and LazyElementwiseOperation subtypes of it
Jonatan Werpers <jonatan@werpers.com>
parents: 195
diff changeset
2 LazyTensorMappingApplication{T,R,D} <: LazyArray{T,R}
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 Struct for lazy application of a TensorMapping. Created using `*`.
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 Allows the result of a `TensorMapping` applied to a vector to be treated as an `AbstractArray`.
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 With a mapping `m` and a vector `v` the LazyTensorMappingApplication object can be created by `m*v`.
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 The actual result will be calcualted when indexing into `m*v`.
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 """
378
946516954c85 Use concrete types in LazyTensorApplication
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
10 struct LazyTensorMappingApplication{T,R,D, TM<:TensorMapping{T,R,D}, AA<:AbstractArray{T,D}} <: LazyArray{T,R}
946516954c85 Use concrete types in LazyTensorApplication
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
11 t::TM
946516954c85 Use concrete types in LazyTensorApplication
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
12 o::AA
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 end
348
7fe43d902a27 Start trying to change LazyTensors
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
14 # TODO: Do boundschecking on creation!
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 export LazyTensorMappingApplication
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 378
diff changeset
17 # TODO: Go through and remove unneccerary type parameters on functions
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 378
diff changeset
18
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 Base.:*(tm::TensorMapping{T,R,D}, o::AbstractArray{T,D}) where {T,R,D} = LazyTensorMappingApplication(tm,o)
310
ece3f6f8a1d4 Change all applys to dispatch on Vararg
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 279
diff changeset
20 Base.getindex(ta::LazyTensorMappingApplication{T,R,D}, I::Vararg{Index,R}) where {T,R,D} = apply(ta.t, ta.o, I...)
ece3f6f8a1d4 Change all applys to dispatch on Vararg
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 279
diff changeset
21 Base.getindex(ta::LazyTensorMappingApplication{T,R,D}, I::Vararg{Int,R}) where {T,R,D} = apply(ta.t, ta.o, Index{Unknown}.(I)...)
359
ba46a952a450 Remove unnecessary type parameters
Jonatan Werpers <jonatan@werpers.com>
parents: 348
diff changeset
22 Base.size(ta::LazyTensorMappingApplication) = range_size(ta.t)
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 # TODO: What else is needed to implement the AbstractArray interface?
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
24
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
25 # # We need the associativity to be a→b→c = a→(b→c), which is the case for '→'
257
d4cd4882ee9f Improve error messages when multiblying with TensorMappings and add some tests for TensorOperators
Jonatan Werpers <jonatan@werpers.com>
parents: 237
diff changeset
26 Base.:*(a::TensorMapping{T,R,D}, b::TensorMapping{T,D,K}, args::Union{TensorMapping{T}, AbstractArray{T}}...) where {T,R,D,K} = foldr(*,(a,b,args...))
274
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
27 # # Should we overload some other infix binary opesrator?
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 # →(tm::TensorMapping{T,R,D}, o::AbstractArray{T,D}) where {T,R,D} = LazyTensorMappingApplication(tm,o)
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 # TODO: We need to be really careful about good error messages.
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 # For example what happens if you try to multiply LazyTensorMappingApplication with a TensorMapping(wrong order)?
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31
194
d30d42a11566 Move all Lazy operation into the same module
Jonatan Werpers <jonatan@werpers.com>
parents: 190
diff changeset
32 """
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
33 LazyTensorMappingTranspose{T,R,D} <: TensorMapping{T,D,R}
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
34
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
35 Struct for lazy transpose of a TensorMapping.
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
36
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
37 If a mapping implements the the `apply_transpose` method this allows working with
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
38 the transpose of mapping `m` by using `m'`. `m'` will work as a regular TensorMapping lazily calling
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
39 the appropriate methods of `m`.
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
40 """
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
41 struct LazyTensorMappingTranspose{T,R,D} <: TensorMapping{T,D,R}
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
42 tm::TensorMapping{T,R,D}
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
43 end
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
44 export LazyTensorMappingTranspose
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
45
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
46 # # TBD: Should this be implemented on a type by type basis or through a trait to provide earlier errors?
348
7fe43d902a27 Start trying to change LazyTensors
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
47 # Jonatan 2020-09-25: Is the problem that you can take the transpose of any TensorMapping even if it doesn't implement `apply_transpose`?
274
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
48 Base.adjoint(tm::TensorMapping) = LazyTensorMappingTranspose(tm)
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
49 Base.adjoint(tmt::LazyTensorMappingTranspose) = tmt.tm
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
50
310
ece3f6f8a1d4 Change all applys to dispatch on Vararg
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 279
diff changeset
51 apply(tmt::LazyTensorMappingTranspose{T,R,D}, v::AbstractArray{T,R}, I::Vararg{Index,D}) where {T,R,D} = apply_transpose(tmt.tm, v, I...)
ece3f6f8a1d4 Change all applys to dispatch on Vararg
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 279
diff changeset
52 apply_transpose(tmt::LazyTensorMappingTranspose{T,R,D}, v::AbstractArray{T,D}, I::Vararg{Index,R}) where {T,R,D} = apply(tmt.tm, v, I...)
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
53
359
ba46a952a450 Remove unnecessary type parameters
Jonatan Werpers <jonatan@werpers.com>
parents: 348
diff changeset
54 range_size(tmt::LazyTensorMappingTranspose) = domain_size(tmt.tm)
ba46a952a450 Remove unnecessary type parameters
Jonatan Werpers <jonatan@werpers.com>
parents: 348
diff changeset
55 domain_size(tmt::LazyTensorMappingTranspose) = range_size(tmt.tm)
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
56
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
57
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
58 struct LazyTensorMappingBinaryOperation{Op,T,R,D,T1<:TensorMapping{T,R,D},T2<:TensorMapping{T,R,D}} <: TensorMapping{T,D,R}
274
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
59 tm1::T1
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
60 tm2::T2
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
61
274
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
62 @inline function LazyTensorMappingBinaryOperation{Op,T,R,D}(tm1::T1,tm2::T2) where {Op,T,R,D, T1<:TensorMapping{T,R,D},T2<:TensorMapping{T,R,D}}
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
63 return new{Op,T,R,D,T1,T2}(tm1,tm2)
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
64 end
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
65 end
348
7fe43d902a27 Start trying to change LazyTensors
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
66 # TODO: Boundschecking in constructor.
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
67
310
ece3f6f8a1d4 Change all applys to dispatch on Vararg
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 279
diff changeset
68 apply(tmBinOp::LazyTensorMappingBinaryOperation{:+,T,R,D}, v::AbstractArray{T,D}, I::Vararg{Index,R}) where {T,R,D} = apply(tmBinOp.tm1, v, I...) + apply(tmBinOp.tm2, v, I...)
ece3f6f8a1d4 Change all applys to dispatch on Vararg
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 279
diff changeset
69 apply(tmBinOp::LazyTensorMappingBinaryOperation{:-,T,R,D}, v::AbstractArray{T,D}, I::Vararg{Index,R}) where {T,R,D} = apply(tmBinOp.tm1, v, I...) - apply(tmBinOp.tm2, v, I...)
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
70
348
7fe43d902a27 Start trying to change LazyTensors
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
71 range_size(tmBinOp::LazyTensorMappingBinaryOperation{Op,T,R,D}) where {Op,T,R,D} = range_size(tmBinOp.tm1)
7fe43d902a27 Start trying to change LazyTensors
Jonatan Werpers <jonatan@werpers.com>
parents: 333
diff changeset
72 domain_size(tmBinOp::LazyTensorMappingBinaryOperation{Op,T,R,D}) where {Op,T,R,D} = domain_size(tmBinOp.tm1)
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
73
274
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
74 Base.:+(tm1::TensorMapping{T,R,D}, tm2::TensorMapping{T,R,D}) where {T,R,D} = LazyTensorMappingBinaryOperation{:+,T,R,D}(tm1,tm2)
11010bb74260 Dispatch getindex for TensorMappingApplication on region indices. Dispatch apply
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 267
diff changeset
75 Base.:-(tm1::TensorMapping{T,R,D}, tm2::TensorMapping{T,R,D}) where {T,R,D} = LazyTensorMappingBinaryOperation{:-,T,R,D}(tm1,tm2)
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
76
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
77 """
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
78 TensorMappingComposition{T,R,K,D}
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
79
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
80 Lazily compose two TensorMappings, so that they can be handled as a single TensorMapping.
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
81 """
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
82 struct TensorMappingComposition{T,R,K,D, TM1<:TensorMapping{T,R,K}, TM2<:TensorMapping{T,K,D}} <: TensorMapping{T,R,D}
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
83 t1::TM1
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
84 t2::TM2
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
85
417
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
86 @inline function TensorMappingComposition(t1::TensorMapping{T,R,K}, t2::TensorMapping{T,K,D}) where {T,R,K,D}
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
87 @boundscheck if domain_size(t1) != range_size(t2)
419
2958b4ebd565 Change error message to fit guidelines
Jonatan Werpers <jonatan@werpers.com>
parents: 418
diff changeset
88 throw(DimensionMismatch("the first argument has domain size $(domain_size(t1)) while the second has range size $(range_size(t2)) "))
417
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
89 end
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
90 return new{T,R,K,D, typeof(t1), typeof(t2)}(t1,t2)
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
91 end
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
92 # Add check for matching sizes as a boundscheck
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
93 end
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
94 export TensorMappingComposition
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
95
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
96 range_size(tm::TensorMappingComposition) = range_size(tm.t1)
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
97 domain_size(tm::TensorMappingComposition) = domain_size(tm.t2)
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
98
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
99 function apply(c::TensorMappingComposition{T,R,K,D}, v::AbstractArray{T,D}, I::Vararg{S,R} where S) where {T,R,K,D}
418
264af2bb646f Switch to using * instead of calling the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 417
diff changeset
100 apply(c.t1, c.t2*v, I...)
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
101 end
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
102
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
103 function apply_transpose(c::TensorMappingComposition{T,R,K,D}, v::AbstractArray{T,R}, I::Vararg{S,D} where S) where {T,R,K,D}
418
264af2bb646f Switch to using * instead of calling the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 417
diff changeset
104 apply_transpose(c.t2, c.t1'*v, I...)
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
105 end
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
106
417
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
107 Base.@propagate_inbounds Base.:∘(s::TensorMapping, t::TensorMapping) = TensorMappingComposition(s,t)
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
108
377
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
109 """
393
b14eacf823b6 Test applying LazyLinearMap to random vectors and matrices. Fix indentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 392
diff changeset
110 LazyLinearMap{T,R,D,...}(A, range_indicies, domain_indicies)
377
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
111
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
112 TensorMapping defined by the AbstractArray A. `range_indicies` and `domain_indicies` define which indicies of A should
400
c640f37d1c74 Update documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 399
diff changeset
113 be considerd the range and domain of the TensorMapping. Each set of indices must be ordered in ascending order.
394
7ad644d112de Expand tests for LazyLinearMap and update its documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 393
diff changeset
114
400
c640f37d1c74 Update documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 399
diff changeset
115 For instance, if A is a m x n matrix, and range_size = (1,), domain_size = (2,), then the LazyLinearMap performs the
c640f37d1c74 Update documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 399
diff changeset
116 standard matrix-vector product on vectors of size n.
377
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
117 """
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
118 struct LazyLinearMap{T,R,D, RD, AA<:AbstractArray{T,RD}} <: TensorMapping{T,R,D}
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
119 A::AA
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
120 range_indicies::NTuple{R,Int}
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
121 domain_indicies::NTuple{D,Int}
399
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
122
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
123 function LazyLinearMap(A::AA, range_indicies::NTuple{R,Int}, domain_indicies::NTuple{D,Int}) where {T,R,D, RD, AA<:AbstractArray{T,RD}}
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
124 if !issorted(range_indicies) || !issorted(domain_indicies)
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
125 throw(DomainError("range_indicies and domain_indicies must be sorted in ascending order"))
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
126 end
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
127
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
128 return new{T,R,D,RD,AA}(A,range_indicies,domain_indicies)
3b4b1758a8ad Add a check for permuted indecies.
Jonatan Werpers <jonatan@werpers.com>
parents: 394
diff changeset
129 end
377
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
130 end
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
131 export LazyLinearMap
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
132
392
418cfd945715 Fix bug in range_size and domain_size for LazyLinearMap and expand the test
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 377
diff changeset
133 range_size(llm::LazyLinearMap) = size(llm.A)[[llm.range_indicies...]]
418cfd945715 Fix bug in range_size and domain_size for LazyLinearMap and expand the test
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 377
diff changeset
134 domain_size(llm::LazyLinearMap) = size(llm.A)[[llm.domain_indicies...]]
377
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
135
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
136 function apply(llm::LazyLinearMap{T,R,D}, v::AbstractArray{T,D}, I::Vararg{Index,R}) where {T,R,D}
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
137 view_index = ntuple(i->:,ndims(llm.A))
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
138 for i ∈ 1:R
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
139 view_index = Base.setindex(view_index, Int(I[i]), llm.range_indicies[i])
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
140 end
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
141 A_view = @view llm.A[view_index...]
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
142 return sum(A_view.*v)
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
143 end
411
4aa59af074ef Add implementation of apply_transpose for LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
144
4aa59af074ef Add implementation of apply_transpose for LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
145 function apply_transpose(llm::LazyLinearMap{T,R,D}, v::AbstractArray{T,R}, I::Vararg{Index,D}) where {T,R,D}
4aa59af074ef Add implementation of apply_transpose for LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
146 apply(LazyLinearMap(llm.A, llm.domain_indicies, llm.range_indicies), v, I...)
4aa59af074ef Add implementation of apply_transpose for LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
147 end
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
148
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
149
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
150 """
434
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
151 IdentityMapping{T,D} <: TensorMapping{T,D,D}
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
152
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
153 The lazy identity TensorMapping for a given size. Usefull for building up higher dimensional tensor mappings from lower
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
154 dimensional ones through outer products. Also used in the Implementation for InflatedTensorMapping.
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
155 """
434
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
156 struct IdentityMapping{T,D} <: TensorMapping{T,D,D}
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
157 size::NTuple{D,Int}
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
158 end
434
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
159 export IdentityMapping
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
160
434
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
161 IdentityMapping{T}(size::NTuple{D,Int}) where {T,D} = IdentityMapping{T,D}(size)
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
162
434
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
163 range_size(tmi::IdentityMapping) = tmi.size
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
164 domain_size(tmi::IdentityMapping) = tmi.size
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
165
434
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
166 apply(tmi::IdentityMapping{T,D}, v::AbstractArray{T,D}, I::Vararg{Any,D}) where {T,D} = v[I...]
648a36ebac99 Change name from LazyIdentity to IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 433
diff changeset
167 apply_transpose(tmi::IdentityMapping{T,D}, v::AbstractArray{T,D}, I::Vararg{Any,D}) where {T,D} = v[I...]
429
46acb2560451 Start implementing LazyIdentity
Jonatan Werpers <jonatan@werpers.com>
parents: 411
diff changeset
168
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
169 struct InflatedTensorMapping{T,R,D,D_before,R_middle,D_middle,D_after} <: TensorMapping{T,R,D}
448
912ae510dec9 Use new name of IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 447
diff changeset
170 before::IdentityMapping{T,D_before}
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
171 tm::TensorMapping{T,R_middle,D_middle}
448
912ae510dec9 Use new name of IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 447
diff changeset
172 after::IdentityMapping{T,D_after}
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
173
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
174 function InflatedTensorMapping(before, tm::TensorMapping{T}, after) where T
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
175 R_before = range_dim(before)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
176 R_middle = range_dim(tm)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
177 R_after = range_dim(after)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
178 R = R_before+R_middle+R_after
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
179
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
180 D_before = domain_dim(before)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
181 D_middle = domain_dim(tm)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
182 D_after = domain_dim(after)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
183 D = D_before+D_middle+D_after
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
184 return new{T,R,D,D_before,R_middle,D_middle,D_after}(before, tm, after)
448
912ae510dec9 Use new name of IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 447
diff changeset
185 end
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
186 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
187
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
188 # TODO: Implement constructors where one of `before` or `after` is missing
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
189
448
912ae510dec9 Use new name of IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 447
diff changeset
190 # TODO: Implement syntax and constructors for products of different combinations of InflatedTensorMapping and IdentityMapping
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
191
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
192 # TODO: Implement some pretty printing in terms of ⊗. E.g InflatedTensorMapping(I(3),B,I(2)) -> I(3)⊗B⊗I(2)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
193
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
194 function range_size(itm::InflatedTensorMapping)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
195 return flatten_tuple(
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
196 range_size(itm.before),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
197 range_size(itm.tm),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
198 range_size(itm.after),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
199 )
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
200 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
201
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
202 function domain_size(itm::InflatedTensorMapping)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
203 return flatten_tuple(
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
204 domain_size(itm.before),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
205 domain_size(itm.tm),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
206 domain_size(itm.after),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
207 )
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
208 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
209
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
210 function apply(itm::InflatedTensorMapping{T,R,D}, v::AbstractArray{T,D}, I::Vararg{S,R} where S) where {T,R,D}
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
211 view_index, inner_index = split_index(I...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
212
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
213 v_inner = view(v, view_index...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
214 return apply(itm.tm, v_inner, inner_index...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
215 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
216
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
217
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
218 """
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
219 split_index(...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
220
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
221 Splits the multi-index into two parts. One part for the view that the inner TensorMapping acts on, and one part for indexing the result
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
222 Eg.
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
223 ```
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
224 (1,2,3,4) -> (1,:,:,4), (2,3)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
225 ```
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
226 """
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
227 function split_index(itm::InflatedTensorMapping{T,R,D}, I::Vararg{S,R} where S) where {T,R,D}
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
228 I_before = I[1:range_dim(itm.before)]
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
229 I_after = I[(end-range_dim(itm.after)+1):end]
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
230
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
231 view_index = (I_before..., ntuple((i)->:,domain_dim(itm.tm))..., I_after...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
232 A_view = @view llm.A[view_index...]
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
233 inner_index = I[range_dim(itm.before)+1:end-range_dim(itm.after)]
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
234
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
235 return (view_index, inner_index)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
236 return sum(A_view.*v)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
237 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
238
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
239 flatten_tuple(t::NTuple{N, Number} where N) = t
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
240 flatten_tuple(t::Tuple) = ((flatten_tuple.(t)...)...,) # simplify?
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
241 flatten_tuple(ts::Vararg) = flatten_tuple(ts)