Mercurial > repos > public > sbplib_julia

annotate src/LazyTensors/tuple_manipulation.jl @ 1226:ea5b4fca85e0 refactor/LazyTensors/tuple_manipulation

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add an example in the docstring to split_tuple
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 18 Feb 2023 21:55:55 +0100
parents 6567e38b05ca
children 06b983f0d236
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
997
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 split_index(::Val{dim_before}, ::Val{dim_view}, ::Val{dim_index}, ::Val{dim_after}, I...)
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 Splits the multi-index `I` into two parts. One part which is expected to be
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 used as a view, and one which is expected to be used as an index.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 Eg.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 ```
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 split_index(Val(1),Val(3),Val(2),Val(1),(1,2,3,4)) -> (1,:,:,:,4), (2,3)
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 ```
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11 `dim_view` controls how many colons are in the view, and `dim_index` controls
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 how many elements are extracted from the middle.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 `dim_before` and `dim_after` decides the length of the index parts before and after the colons in the view index.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 Arguments should satisfy `length(I) == dim_before+B_domain+dim_after`.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
17 The returned values satisfy
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18 * `length(view_index) == dim_before + dim_view + dim_after`
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 * `length(I_middle) == dim_index`
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 function split_index(::Val{dim_before}, ::Val{dim_view}, ::Val{dim_index}, ::Val{dim_after}, I...) where {dim_before,dim_view, dim_index,dim_after}
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 I_before, I_middle, I_after = split_tuple(I, Val(dim_before), Val(dim_index))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
24 view_index = (I_before..., ntuple((i)->:, dim_view)..., I_after...)
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
25
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26 return view_index, I_middle
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
27 end
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
28 # TBD: If the nice split_tuple works, can this be cleaned up as well?
997
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 # TODO: Can this be replaced by something more elegant while still being type stable? 2020-10-21
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31 # See:
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 # https://github.com/JuliaLang/julia/issues/34884
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33 # https://github.com/JuliaLang/julia/issues/30386
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35 slice_tuple(t, Val(l), Val(u))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37 Get a slice of a tuple in a type stable way.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 Equivalent to `t[l:u]` but type stable.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
40 function slice_tuple(t,::Val{L},::Val{U}) where {L,U}
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
41 return ntuple(i->t[i+L-1], U-L+1)
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
42 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
43
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
44 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
45 split_tuple(t::Tuple{...}, ::Val{M}) where {N,M}
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
46
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
47 Split the tuple `t` into two parts. the first part is `M` long.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
48 E.g
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
49 ```julia
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
50 split_tuple((1,2,3,4),Val(3)) -> (1,2,3), (4,)
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
51 ```
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
52 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
53 function split_tuple(t::NTuple{N,Any},::Val{M}) where {N,M}
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
54 return slice_tuple(t,Val(1), Val(M)), slice_tuple(t,Val(M+1), Val(N))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
55 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
56
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
57 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
58 split_tuple(t::Tuple{...},::Val{M},::Val{K}) where {N,M,K}
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
59
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
60 Same as `split_tuple(t::NTuple{N},::Val{M})` but splits the tuple in three parts. With the first
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
61 two parts having lenght `M` and `K`.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
62 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
63 function split_tuple(t::NTuple{N,Any},::Val{M},::Val{K}) where {N,M,K}
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
64 p1, tail = split_tuple(t, Val(M))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
65 p2, p3 = split_tuple(tail, Val(K))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66 return p1,p2,p3
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
68
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
69 # TBD Are the above defs even needed? Can the below one be used without problems?
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
70
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
71 """
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
72 split_tuple(t, szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
73
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
74 Split the tuple `t` into a set of tuples of the sizes given in `szs`.
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
75 `sum(szs)` should equal `lenght(t)`.
1226
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
76
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
77 E.g
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
78 ```julia
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
79 split_tuple((1,2,3,4,5,6), (3,1,2)) -> (1,2,3),(4,),(5,6)
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
80 ```
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
81 """
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
82 function split_tuple(t, szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
83 if length(t) != sum(szs; init=0)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
84 throw(ArgumentError("length(t) must equal sum(szs)"))
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
85 end
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
86
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
87 rs = sizes_to_ranges(szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
88 return map(r->t[r], rs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
89 end
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
90
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
91 function sizes_to_ranges(szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
92 cum_szs = cumsum((0, szs...))
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
93 return ntuple(i->cum_szs[i]+1:cum_szs[i+1], length(szs))
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
94 end
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
95
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
96 concatenate_tuples(t::Tuple,ts::Vararg{Tuple}) = (t..., concatenate_tuples(ts...)...)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
97 concatenate_tuples(t::Tuple) = t
997
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
98
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
99
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
100 """
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
101 left_pad_tuple(t, val, N)
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
102
1215
07c213167f7c Fix typos in docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1094
diff changeset
103 Left pad the tuple `t` to length `N` using the value `val`.
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
104 """
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
105 function left_pad_tuple(t, val, N)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
106 if N < length(t)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
107 throw(DomainError(N, "Can't pad tuple of length $(length(t)) to $N elements"))
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
108 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
109
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
110 padding = ntuple(i->val, N-length(t))
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
111 return (padding..., t...)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
112 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
113
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
114 """
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
115 right_pad_tuple(t, val, N)
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
116
1215
07c213167f7c Fix typos in docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1094
diff changeset
117 Right pad the tuple `t` to length `N` using the value `val`.
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
118 """
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
119 function right_pad_tuple(t, val, N)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
120 if N < length(t)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
121 throw(DomainError(N, "Can't pad tuple of length $(length(t)) to $N elements"))
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
122 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
123
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
124 padding = ntuple(i->val, N-length(t))
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
125 return (t..., padding...)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
126 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
127