Mercurial > repos > public > sbplib_julia

annotate src/LazyTensors/tuple_manipulation.jl @ 2015:5c2448d6a201 feature/grids/geometry_functions tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Structure tests a bit more
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 09 May 2025 15:57:38 +0200
parents d7bc11053951
children
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 """
1229
8f4259fbd39c Simplify split_index
Jonatan Werpers <jonatan@werpers.com>
parents: 1228
diff changeset
2 split_index(dim_before, dim_view, dim_index, dim_after, I...)
997
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.
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1231
diff changeset
6 E.g.
1230
723a583cef96 Improve examples for split_index and split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1229
diff changeset
7 ```julia-repl
723a583cef96 Improve examples for split_index and split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1229
diff changeset
8 julia> LazyTensors.split_index(1, 3, 2, 1, (1,2,3,4)...)
723a583cef96 Improve examples for split_index and split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1229
diff changeset
9 ((1, Colon(), Colon(), Colon(), 4), (2, 3))
997
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
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 `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
13 how many elements are extracted from the middle.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14 `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
15
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16 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
17
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18 The returned values satisfy
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 * `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
20 * `length(I_middle) == dim_index`
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 """
1229
8f4259fbd39c Simplify split_index
Jonatan Werpers <jonatan@werpers.com>
parents: 1228
diff changeset
22 function split_index(dim_before, dim_view, dim_index, dim_after, I...)
8f4259fbd39c Simplify split_index
Jonatan Werpers <jonatan@werpers.com>
parents: 1228
diff changeset
23 @inline
8f4259fbd39c Simplify split_index
Jonatan Werpers <jonatan@werpers.com>
parents: 1228
diff changeset
24 I_before, I_middle, I_after = split_tuple(I, (dim_before, dim_index, dim_after))
997
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 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
27
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 return view_index, I_middle
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
31
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
32 """
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
33 split_tuple(t, szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
34
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
35 Split the tuple `t` into a set of tuples of the sizes given in `szs`.
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1231
diff changeset
36 `sum(szs)` should equal `length(t)`.
1226
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
37
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
38 E.g
1230
723a583cef96 Improve examples for split_index and split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1229
diff changeset
39 ```julia-repl
723a583cef96 Improve examples for split_index and split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1229
diff changeset
40 julia> LazyTensors.split_tuple((1,2,3,4,5,6), (3,1,2))
723a583cef96 Improve examples for split_index and split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1229
diff changeset
41 ((1, 2, 3), (4,), (5, 6))
1226
ea5b4fca85e0 Add an example in the docstring to split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1225
diff changeset
42 ```
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
43 """
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
44 function split_tuple(t, szs)
1228
73f262a0a384 Add @inline to definition of split_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1227
diff changeset
45 @inline
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
46 if length(t) != sum(szs; init=0)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
47 throw(ArgumentError("length(t) must equal sum(szs)"))
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
48 end
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
49
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
50 rs = sizes_to_ranges(szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
51 return map(r->t[r], rs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
52 end
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
53
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
54 function sizes_to_ranges(szs)
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
55 cum_szs = cumsum((0, szs...))
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
56 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
57 end
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
58
1231
de6a9635f293 Add docstring for concatenate_tuples
Jonatan Werpers <jonatan@werpers.com>
parents: 1230
diff changeset
59
de6a9635f293 Add docstring for concatenate_tuples
Jonatan Werpers <jonatan@werpers.com>
parents: 1230
diff changeset
60 """
de6a9635f293 Add docstring for concatenate_tuples
Jonatan Werpers <jonatan@werpers.com>
parents: 1230
diff changeset
61 concatenate_tuples(t...)
de6a9635f293 Add docstring for concatenate_tuples
Jonatan Werpers <jonatan@werpers.com>
parents: 1230
diff changeset
62
de6a9635f293 Add docstring for concatenate_tuples
Jonatan Werpers <jonatan@werpers.com>
parents: 1230
diff changeset
63 Concatenate tuples.
de6a9635f293 Add docstring for concatenate_tuples
Jonatan Werpers <jonatan@werpers.com>
parents: 1230
diff changeset
64 """
1223
5bfb182e24dc Start adding simpler code
Jonatan Werpers <jonatan@werpers.com>
parents: 1215
diff changeset
65 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
66 concatenate_tuples(t::Tuple) = t
997
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
68
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
69 """
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
70 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
71
1215
07c213167f7c Fix typos in docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1094
diff changeset
72 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
73 """
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
74 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
75 if N < length(t)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
76 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
77 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
78
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
79 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
80 return (padding..., t...)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
81 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
82
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
83 """
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
84 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
85
1215
07c213167f7c Fix typos in docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1094
diff changeset
86 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
87 """
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
88 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
89 if N < length(t)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
90 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
91 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
92
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
93 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
94 return (t..., padding...)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
95 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
96