Mercurial > repos > public > sbplib_julia

annotate src/LazyTensors/lazy_tensor_operations.jl @ 1840:cb3a8450ed44 refactor/lazy_tensors/elementwise_ops

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some docstring
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 10 Jan 2025 19:45:11 +0100
parents e1077273eda5
children 21e5fe1545c0
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 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
2 TensorApplication{T,R,D} <: LazyArray{T,R}
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
4 Struct for lazy application of a LazyTensor. Created using `*`.
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
6 Allows the result of a `LazyTensor` applied to a vector to be treated as an `AbstractArray`.
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
7 With a mapping `m` and a vector `v` the TensorApplication object can be created by `m*v`.
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1365
diff changeset
8 The actual result will be calculated when indexing into `m*v`.
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
10 struct TensorApplication{T,R,D, TM<:LazyTensor{<:Any,R,D}, AA<:AbstractArray{<:Any,D}} <: LazyArray{T,R}
378
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
942
7829c09f8137 Add promotion calculation of element type for LazyTensorMappingApplication
Jonatan Werpers <jonatan@werpers.com>
parents: 838
diff changeset
13
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
14 function TensorApplication(t::LazyTensor{<:Any,R,D}, o::AbstractArray{<:Any,D}) where {R,D}
1005
becd95ba0fce Add bounds checking for lazy tensor application and clea up tests a bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1002
diff changeset
15 @boundscheck check_domain_size(t, size(o))
977
043d13ef8898 Fix type calculation of LazyTensorMappingApplication element type
Jonatan Werpers <jonatan@werpers.com>
parents: 976
diff changeset
16 I = ntuple(i->1, range_dim(t))
043d13ef8898 Fix type calculation of LazyTensorMappingApplication element type
Jonatan Werpers <jonatan@werpers.com>
parents: 976
diff changeset
17 T = typeof(apply(t,o,I...))
942
7829c09f8137 Add promotion calculation of element type for LazyTensorMappingApplication
Jonatan Werpers <jonatan@werpers.com>
parents: 838
diff changeset
18 return new{T,R,D,typeof(t), typeof(o)}(t,o)
7829c09f8137 Add promotion calculation of element type for LazyTensorMappingApplication
Jonatan Werpers <jonatan@werpers.com>
parents: 838
diff changeset
19 end
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 end
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
22 function Base.getindex(ta::TensorApplication{T,R}, I::Vararg{Any,R}) where {T,R}
1005
becd95ba0fce Add bounds checking for lazy tensor application and clea up tests a bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1002
diff changeset
23 @boundscheck checkbounds(ta, Int.(I)...)
1015
4dd3c2312d9e Fix some @boundscheck @inboudns combos
Jonatan Werpers <jonatan@werpers.com>
parents: 1007
diff changeset
24 return @inbounds apply(ta.t, ta.o, I...)
1005
becd95ba0fce Add bounds checking for lazy tensor application and clea up tests a bit
Jonatan Werpers <jonatan@werpers.com>
parents: 1002
diff changeset
25 end
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
26 Base.@propagate_inbounds Base.getindex(ta::TensorApplication{T,1} where T, I::CartesianIndex{1}) = ta[Tuple(I)...] # Would otherwise be caught in the previous method.
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
27 Base.size(ta::TensorApplication) = range_size(ta.t)
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29
194
d30d42a11566 Move all Lazy operation into the same module
Jonatan Werpers <jonatan@werpers.com>
parents: 190
diff changeset
30 """
1037
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
31 TensorTranspose{T,R,D} <: LazyTensor{T,D,R}
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
32
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
33 Struct for lazy transpose of a LazyTensor.
197
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 If a mapping implements the the `apply_transpose` method this allows working with
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
36 the transpose of mapping `m` by using `m'`. `m'` will work as a regular LazyTensor lazily calling
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
37 the appropriate methods of `m`.
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
38 """
1037
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
39 struct TensorTranspose{T,R,D, TM<:LazyTensor{T,R,D}} <: LazyTensor{T,D,R}
438
907b0510699f Change LazyTensorTranspose to have concrete fields
Jonatan Werpers <jonatan@werpers.com>
parents: 436
diff changeset
40 tm::TM
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
41 end
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
42
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
43 # # TBD: Should this be implemented on a type by type basis or through a trait to provide earlier errors?
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
44 # Jonatan 2020-09-25: Is the problem that you can take the transpose of any LazyTensor even if it doesn't implement `apply_transpose`?
1037
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
45 Base.adjoint(tm::LazyTensor) = TensorTranspose(tm)
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
46 Base.adjoint(tmt::TensorTranspose) = tmt.tm
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
47
1037
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
48 apply(tmt::TensorTranspose{T,R,D}, v::AbstractArray{<:Any,R}, I::Vararg{Any,D}) where {T,R,D} = apply_transpose(tmt.tm, v, I...)
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
49 apply_transpose(tmt::TensorTranspose{T,R,D}, v::AbstractArray{<:Any,D}, I::Vararg{Any,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
50
1037
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
51 range_size(tmt::TensorTranspose) = domain_size(tmt.tm)
9e76bf19904c Drop more prefixes
Jonatan Werpers <jonatan@werpers.com>
parents: 1017
diff changeset
52 domain_size(tmt::TensorTranspose) = range_size(tmt.tm)
197
a340fa91b1fc Move transpose def to the bottom of the file
Jonatan Werpers <jonatan@werpers.com>
parents: 196
diff changeset
53
1840
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
54
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
55 """
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
56 TensorNegation{T,R,D,...} <: LazyTensor{T,R,D}
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
57
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
58 The negation of a LazyTensor.
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
59 """
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
60 struct TensorNegation{T,R,D,TM<:LazyTensor{T,R,D}} <: LazyTensor{T,R,D}
1836
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
61 tm::TM
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
62 end
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
63
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
64 apply(tm::TensorNegation, v, I...) = -apply(tm.tm, v, I...)
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
65 apply_transpose(tm::TensorNegation, v, I...) = -apply_transpose(tm.tm, v, I...)
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
66
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
67 range_size(tm::TensorNegation) = range_size(tm.tm)
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
68 domain_size(tm::TensorNegation) = domain_size(tm.tm)
368999a2e243 Add TensorNegation
Jonatan Werpers <jonatan@werpers.com>
parents: 1789
diff changeset
69
1840
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
70 """
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
71 TensorSum{T,R,D,...} <: LazyTensor{T,R,D}
1002
271aa6ae1055 Split out a file for tensor types
Jonatan Werpers <jonatan@werpers.com>
parents: 1001
diff changeset
72
1840
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
73 The sum of 2 or more lazy tensors.
cb3a8450ed44 Add some docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1839
diff changeset
74 """
1837
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
75 struct TensorSum{T,R,D,TT<:NTuple{N, LazyTensor{T,R,D}} where N} <: LazyTensor{T,R,D}
1788
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
76 tms::TT
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
77
1837
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
78 function TensorSum{T,R,D}(tms::TT) where {T,R,D, TT<:NTuple{N, LazyTensor{T,R,D}} where N}
1788
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
79 @boundscheck map(tms) do tm
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
80 check_domain_size(tm, domain_size(tms[1]))
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
81 check_range_size(tm, range_size(tms[1]))
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
82 end
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
83
1837
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
84 return new{T,R,D,TT}(tms)
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
85 end
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
86 end
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
87
1837
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
88 function TensorSum(ts::Vararg{LazyTensor})
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
89 T = eltype(ts[1])
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
90 R = range_dim(ts[1])
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
91 D = domain_dim(ts[1])
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
92 return TensorSum{T,R,D}(ts)
1788
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
93 end
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
94
1837
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
95 function apply(tmBinOp::TensorSum{T,R,D}, v::AbstractArray{<:Any,D}, I::Vararg{Any,R}) where {T,R,D}
1788
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
96 vs = map(tmBinOp.tms) do tm
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
97 apply(tm,v,I...)
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
98 end
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
99
1788
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
100 return +(vs...)
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
101 end
8b64df6cadba Refactor ElementWiseOperation to give a flatter structure of tensor compositions improving type inference
Jonatan Werpers <jonatan@werpers.com>
parents: 1609
diff changeset
102
1837
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
103 range_size(tmBinOp::TensorSum) = range_size(tmBinOp.tms[1])
200971c71657 Refactor ElementwiseTensorOperation into TensorSum and use TensorNegation for handling subtraction
Jonatan Werpers <jonatan@werpers.com>
parents: 1836
diff changeset
104 domain_size(tmBinOp::TensorSum) = domain_size(tmBinOp.tms[1])
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
105
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
106
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
107 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
108 TensorComposition{T,R,K,D}
210
2aa33d0eef90 Add ability to add and subtract TensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 209
diff changeset
109
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
110 Lazily compose two `LazyTensor`s, so that they can be handled as a single `LazyTensor`.
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
111 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
112 struct TensorComposition{T,R,K,D, TM1<:LazyTensor{T,R,K}, TM2<:LazyTensor{T,K,D}} <: LazyTensor{T,R,D}
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
113 t1::TM1
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
114 t2::TM2
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
115
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
116 function TensorComposition(t1::LazyTensor{T,R,K}, t2::LazyTensor{T,K,D}) where {T,R,K,D}
485
4b49f03bdb98 Switch from DimensionMismatch to SizeMismatch for boundschecks on compositions
Jonatan Werpers <jonatan@werpers.com>
parents: 484
diff changeset
117 @boundscheck check_domain_size(t1, range_size(t2))
417
4c6604b7d990 Add dimension checking in the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 415
diff changeset
118 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
119 end
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
120 end
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
121
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
122 range_size(tm::TensorComposition) = range_size(tm.t1)
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
123 domain_size(tm::TensorComposition) = domain_size(tm.t2)
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
124
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
125 function apply(c::TensorComposition{T,R,K,D}, v::AbstractArray{<:Any,D}, I::Vararg{Any,R}) where {T,R,K,D}
418
264af2bb646f Switch to using * instead of calling the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 417
diff changeset
126 apply(c.t1, c.t2*v, I...)
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
127 end
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
128
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
129 function apply_transpose(c::TensorComposition{T,R,K,D}, v::AbstractArray{<:Any,R}, I::Vararg{Any,D}) where {T,R,K,D}
418
264af2bb646f Switch to using * instead of calling the constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 417
diff changeset
130 apply_transpose(c.t2, c.t1'*v, I...)
412
d94891b8dfca Start implementing TensorComposition
Jonatan Werpers <jonatan@werpers.com>
parents: 402
diff changeset
131 end
190
8964b3165097 Break LazyTensors.jl into several files
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
132
377
8414c2334393 Start implementing LazyLinearMap
Jonatan Werpers <jonatan@werpers.com>
parents: 359
diff changeset
133 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
134 TensorComposition(tm, tmi::IdentityTensor)
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
135 TensorComposition(tmi::IdentityTensor, tm)
479
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
136
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1365
diff changeset
137 Composes a `LazyTensor` `tm` with an `IdentityTensor` `tmi`, by returning `tm`
479
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
138 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
139 function TensorComposition(tm::LazyTensor{T,R,D}, tmi::IdentityTensor{T,D}) where {T,R,D}
485
4b49f03bdb98 Switch from DimensionMismatch to SizeMismatch for boundschecks on compositions
Jonatan Werpers <jonatan@werpers.com>
parents: 484
diff changeset
140 @boundscheck check_domain_size(tm, range_size(tmi))
479
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
141 return tm
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
142 end
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
143
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
144 function TensorComposition(tmi::IdentityTensor{T,R}, tm::LazyTensor{T,R,D}) where {T,R,D}
485
4b49f03bdb98 Switch from DimensionMismatch to SizeMismatch for boundschecks on compositions
Jonatan Werpers <jonatan@werpers.com>
parents: 484
diff changeset
145 @boundscheck check_domain_size(tmi, range_size(tm))
479
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
146 return tm
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
147 end
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
148 # Specialization for the case where tm is an IdentityTensor. Required to resolve ambiguity.
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
149 function TensorComposition(tm::IdentityTensor{T,D}, tmi::IdentityTensor{T,D}) where {T,D}
485
4b49f03bdb98 Switch from DimensionMismatch to SizeMismatch for boundschecks on compositions
Jonatan Werpers <jonatan@werpers.com>
parents: 484
diff changeset
150 @boundscheck check_domain_size(tm, range_size(tmi))
479
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
151 return tmi
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
152 end
95f3b9036801 Specialize composition operator for composing a tensormapping with an identitymapping.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 465
diff changeset
153
1084
2e606d4c0ab1 Add support for multiplying a LazyTensor with a scalar
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1037
diff changeset
154 Base.:*(a::T, tm::LazyTensor{T}) where T = TensorComposition(ScalingTensor{T,range_dim(tm)}(a,range_size(tm)), tm)
2e606d4c0ab1 Add support for multiplying a LazyTensor with a scalar
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1037
diff changeset
155 Base.:*(tm::LazyTensor{T}, a::T) where T = a*tm
992
bc384aaade30 Add a bunch of todos and add a ScalingTensor
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
156
459
11e58c49fb46 Add some documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 458
diff changeset
157 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
158 InflatedTensor{T,R,D} <: LazyTensor{T,R,D}
459
11e58c49fb46 Add some documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 458
diff changeset
159
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1365
diff changeset
160 An inflated `LazyTensor` with dimensions added before and after its actual dimensions.
459
11e58c49fb46 Add some documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 458
diff changeset
161 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
162 struct InflatedTensor{T,R,D,D_before,R_middle,D_middle,D_after, TM<:LazyTensor{T,R_middle,D_middle}} <: LazyTensor{T,R,D}
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
163 before::IdentityTensor{T,D_before}
449
14d60de71b72 Change to concrete fields in the type
Jonatan Werpers <jonatan@werpers.com>
parents: 448
diff changeset
164 tm::TM
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
165 after::IdentityTensor{T,D_after}
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
166
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
167 function InflatedTensor(before, tm::LazyTensor{T}, after) where T
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
168 R_before = range_dim(before)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
169 R_middle = range_dim(tm)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
170 R_after = range_dim(after)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
171 R = R_before+R_middle+R_after
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
172
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
173 D_before = domain_dim(before)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
174 D_middle = domain_dim(tm)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
175 D_after = domain_dim(after)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
176 D = D_before+D_middle+D_after
449
14d60de71b72 Change to concrete fields in the type
Jonatan Werpers <jonatan@werpers.com>
parents: 448
diff changeset
177 return new{T,R,D,D_before,R_middle,D_middle,D_after, typeof(tm)}(before, tm, after)
448
912ae510dec9 Use new name of IdentityMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 447
diff changeset
178 end
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
179 end
1002
271aa6ae1055 Split out a file for tensor types
Jonatan Werpers <jonatan@werpers.com>
parents: 1001
diff changeset
180
461
a0e40d16ba0e Better documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 460
diff changeset
181 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
182 InflatedTensor(before, tm, after)
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
183 InflatedTensor(before,tm)
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
184 InflatedTensor(tm,after)
461
a0e40d16ba0e Better documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 460
diff changeset
185
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
186 The outer product of `before`, `tm` and `after`, where `before` and `after` are `IdentityTensor`s.
465
f270d82fc9ad Change documention in an attempt to follow the guidelines
Jonatan Werpers <jonatan@werpers.com>
parents: 464
diff changeset
187
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
188 If one of `before` or `after` is left out, a 0-dimensional `IdentityTensor` is used as the default value.
493
df566372bb4f Implement constructors to avoid creating nested InflatedTensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 487
diff changeset
189
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
190 If `tm` already is an `InflatedTensor`, `before` and `after` will be extended instead of
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
191 creating a nested `InflatedTensor`.
461
a0e40d16ba0e Better documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 460
diff changeset
192 """
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
193 InflatedTensor(::IdentityTensor, ::LazyTensor, ::IdentityTensor)
493
df566372bb4f Implement constructors to avoid creating nested InflatedTensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 487
diff changeset
194
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
195 function InflatedTensor(before, itm::InflatedTensor, after)
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
196 return InflatedTensor(
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
197 IdentityTensor(before.size..., itm.before.size...),
493
df566372bb4f Implement constructors to avoid creating nested InflatedTensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 487
diff changeset
198 itm.tm,
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
199 IdentityTensor(itm.after.size..., after.size...),
493
df566372bb4f Implement constructors to avoid creating nested InflatedTensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 487
diff changeset
200 )
df566372bb4f Implement constructors to avoid creating nested InflatedTensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 487
diff changeset
201 end
df566372bb4f Implement constructors to avoid creating nested InflatedTensorMappings
Jonatan Werpers <jonatan@werpers.com>
parents: 487
diff changeset
202
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
203 InflatedTensor(before::IdentityTensor, tm::LazyTensor{T}) where T = InflatedTensor(before,tm,IdentityTensor{T}())
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
204 InflatedTensor(tm::LazyTensor{T}, after::IdentityTensor) where T = InflatedTensor(IdentityTensor{T}(),tm,after)
465
f270d82fc9ad Change documention in an attempt to follow the guidelines
Jonatan Werpers <jonatan@werpers.com>
parents: 464
diff changeset
205 # Resolve ambiguity between the two previous methods
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
206 InflatedTensor(I1::IdentityTensor{T}, I2::IdentityTensor{T}) where T = InflatedTensor(I1,I2,IdentityTensor{T}())
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
207
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
208 # TODO: Implement some pretty printing in terms of ⊗. E.g InflatedTensor(I(3),B,I(2)) -> I(3)⊗B⊗I(2)
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
209
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
210 function range_size(itm::InflatedTensor)
1225
6567e38b05ca Replace flatten_tuple with concatenate_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1098
diff changeset
211 return concatenate_tuples(
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
212 range_size(itm.before),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
213 range_size(itm.tm),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
214 range_size(itm.after),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
215 )
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
216 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
217
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
218 function domain_size(itm::InflatedTensor)
1225
6567e38b05ca Replace flatten_tuple with concatenate_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1098
diff changeset
219 return concatenate_tuples(
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
220 domain_size(itm.before),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
221 domain_size(itm.tm),
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
222 domain_size(itm.after),
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 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
225
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
226 function apply(itm::InflatedTensor{T,R,D}, v::AbstractArray{<:Any,D}, I::Vararg{Any,R}) where {T,R,D}
538
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
227 dim_before = range_dim(itm.before)
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
228 dim_domain = domain_dim(itm.tm)
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
229 dim_range = range_dim(itm.tm)
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
230 dim_after = range_dim(itm.after)
520
fe86ac896377 Start refactoring split index and apply to accomodate future addition of apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 501
diff changeset
231
1229
8f4259fbd39c Simplify split_index
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
232 view_index, inner_index = split_index(dim_before, dim_domain, dim_range, dim_after, I...)
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
233
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
234 v_inner = view(v, view_index...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
235 return apply(itm.tm, v_inner, inner_index...)
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
236 end
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
237
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
238 function apply_transpose(itm::InflatedTensor{T,R,D}, v::AbstractArray{<:Any,R}, I::Vararg{Any,D}) where {T,R,D}
538
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
239 dim_before = range_dim(itm.before)
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
240 dim_domain = domain_dim(itm.tm)
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
241 dim_range = range_dim(itm.tm)
848dec405332 Change variable names in apply and apply_transpose
Jonatan Werpers <jonatan@werpers.com>
parents: 537
diff changeset
242 dim_after = range_dim(itm.after)
526
be152486d136 Implement apply_transpose with tests
Jonatan Werpers <jonatan@werpers.com>
parents: 525
diff changeset
243
1229
8f4259fbd39c Simplify split_index
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
244 view_index, inner_index = split_index(dim_before, dim_range, dim_domain, dim_after, I...)
526
be152486d136 Implement apply_transpose with tests
Jonatan Werpers <jonatan@werpers.com>
parents: 525
diff changeset
245
be152486d136 Implement apply_transpose with tests
Jonatan Werpers <jonatan@werpers.com>
parents: 525
diff changeset
246 v_inner = view(v, view_index...)
be152486d136 Implement apply_transpose with tests
Jonatan Werpers <jonatan@werpers.com>
parents: 525
diff changeset
247 return apply_transpose(itm.tm, v_inner, inner_index...)
be152486d136 Implement apply_transpose with tests
Jonatan Werpers <jonatan@werpers.com>
parents: 525
diff changeset
248 end
be152486d136 Implement apply_transpose with tests
Jonatan Werpers <jonatan@werpers.com>
parents: 525
diff changeset
249
446
904aae1899df Start implementing InflatedTensorMapping
Jonatan Werpers <jonatan@werpers.com>
parents: 429
diff changeset
250
838
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
251 @doc raw"""
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
252 LazyOuterProduct(tms...)
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
253
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1365
diff changeset
254 Creates a `TensorComposition` for the outer product of `tms...`.
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
255 This is done by separating the outer product into regular products of outer products involving only identity mappings and one non-identity mapping.
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
256
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
257 First let
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
258 ```math
838
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
259 \begin{aligned}
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
260 A &= A_{I,J} \\
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
261 B &= B_{M,N} \\
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
262 C &= C_{P,Q} \\
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
263 \end{aligned}
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
264 ```
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
265
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
266 where ``I``, ``M``, ``P`` are multi-indexes for the ranges of ``A``, ``B``, ``C``, and ``J``, ``N``, ``Q`` are multi-indexes of the domains.
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
267
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
268 We use ``⊗`` to denote the outer product
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
269 ```math
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
270 (A⊗B)_{IM,JN} = A_{I,J}B_{M,N}
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
271 ```
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
272
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
273 We note that
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
274 ```math
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
275 A⊗B⊗C = (A⊗B⊗C)_{IMP,JNQ} = A_{I,J}B_{M,N}C_{P,Q}
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
276 ```
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
277 And that
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
278 ```math
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
279 A⊗B⊗C = (A⊗I_{|M|}⊗I_{|P|})(I_{|J|}⊗B⊗I_{|P|})(I_{|J|}⊗I_{|N|}⊗C)
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
280 ```
838
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
281 where ``|⋅|`` of a multi-index is a vector of sizes for each dimension. ``I_v`` denotes the identity tensor of size ``v[i]`` in each direction
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
282 To apply ``A⊗B⊗C`` we evaluate
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
283
838
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
284 ```math
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
285 (A⊗B⊗C)v = [(A⊗I_{|M|}⊗I_{|P|}) [(I_{|J|}⊗B⊗I_{|P|}) [(I_{|J|}⊗I_{|N|}⊗C)v]]]
838
76e5682d0e52 Fix a bunch of docstring mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 625
diff changeset
286 ```
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
287 """
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
288 function LazyOuterProduct end
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
289
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
290 function LazyOuterProduct(tm1::LazyTensor{T}, tm2::LazyTensor{T}) where T
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
291 itm1 = InflatedTensor(tm1, IdentityTensor{T}(range_size(tm2)))
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
292 itm2 = InflatedTensor(IdentityTensor{T}(domain_size(tm1)),tm2)
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
293
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
294 return itm1∘itm2
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
295 end
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
296
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
297 LazyOuterProduct(t1::IdentityTensor{T}, t2::IdentityTensor{T}) where T = IdentityTensor{T}(t1.size...,t2.size...)
1017
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
298 LazyOuterProduct(t1::LazyTensor, t2::IdentityTensor) = InflatedTensor(t1, t2)
6abbb2c6c3e4 Remove the Lazy prefix on some types
Jonatan Werpers <jonatan@werpers.com>
parents: 1016
diff changeset
299 LazyOuterProduct(t1::IdentityTensor, t2::LazyTensor) = InflatedTensor(t1, t2)
491
2dc2eac27f75 Add special methods for Identity mappings
Jonatan Werpers <jonatan@werpers.com>
parents: 475
diff changeset
300
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
301 LazyOuterProduct(tms::Vararg{LazyTensor}) = foldl(LazyOuterProduct, tms)
468
a52f38e72258 Start implementing function for outer products
Jonatan Werpers <jonatan@werpers.com>
parents: 461
diff changeset
302
498
5a600ec40ccc Merge in default
Jonatan Werpers <jonatan@werpers.com>
parents: 491 493
diff changeset
303
5a600ec40ccc Merge in default
Jonatan Werpers <jonatan@werpers.com>
parents: 491 493
diff changeset
304
1022
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
305 """
1088
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
306 inflate(tm::LazyTensor, sz, dir)
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
307
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
308 Inflate `tm` such that it gets the size `sz` in all directions except `dir`.
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
309 Here `sz[dir]` is ignored and replaced with the range and domains size of
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
310 `tm`.
1022
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
311
1088
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
312 An example of when this operation is useful is when extending a one
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1365
diff changeset
313 dimensional difference operator `D` to a 2D grid of a certain size. In that
1088
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
314 case we could have
1022
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
315
1088
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
316 ```julia
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
317 Dx = inflate(D, (10,10), 1)
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
318 Dy = inflate(D, (10,10), 2)
62f321caa964 Improve docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1044
diff changeset
319 ```
1022
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
320 """
1023
52f07c77299d Merge refactor/lazy_tensors
Jonatan Werpers <jonatan@werpers.com>
parents: 1022 1007
diff changeset
321 function inflate(tm::LazyTensor, sz, dir)
52f07c77299d Merge refactor/lazy_tensors
Jonatan Werpers <jonatan@werpers.com>
parents: 1022 1007
diff changeset
322 Is = IdentityTensor{eltype(tm)}.(sz)
1022
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
323 parts = Base.setindex(Is, tm, dir)
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
324 return foldl(⊗, parts)
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
325 end
bbbc31953367 Introduce an inflate function in lazy tensors and use it in volume_operator and boundary_operator
Jonatan Werpers <jonatan@werpers.com>
parents: 977
diff changeset
326
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
327 function check_domain_size(tm::LazyTensor, sz)
487
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
328 if domain_size(tm) != sz
1006
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
329 throw(DomainSizeMismatch(tm,sz))
487
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
330 end
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
331 end
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
332
1006
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
333 function check_range_size(tm::LazyTensor, sz)
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
334 if range_size(tm) != sz
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
335 throw(RangeSizeMismatch(tm,sz))
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
336 end
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
337 end
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
338
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
339 struct DomainSizeMismatch <: Exception
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
340 tm::LazyTensor
487
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
341 sz
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
342 end
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
343
1006
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
344 function Base.showerror(io::IO, err::DomainSizeMismatch)
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
345 print(io, "DomainSizeMismatch: ")
995
1ba8a398af9c Rename types
Jonatan Werpers <jonatan@werpers.com>
parents: 994
diff changeset
346 print(io, "domain size $(domain_size(err.tm)) of LazyTensor not matching size $(err.sz)")
487
6a6b7eaf9edf Move exception handling to end of file and update error message.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 485
diff changeset
347 end
1006
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
348
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
349
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
350 struct RangeSizeMismatch <: Exception
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
351 tm::LazyTensor
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
352 sz
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
353 end
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
354
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
355 function Base.showerror(io::IO, err::RangeSizeMismatch)
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
356 print(io, "RangeSizeMismatch: ")
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
357 print(io, "range size $(range_size(err.tm)) of LazyTensor not matching size $(err.sz)")
d9476fede83d Add check methods for range size
Jonatan Werpers <jonatan@werpers.com>
parents: 1005
diff changeset
358 end