Mercurial > repos > public > sbplib_julia

annotate src/LazyTensors/tuple_manipulation.jl @ 1215:07c213167f7c feature/dissipation_operators

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix typos in docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 07 Feb 2023 21:40:42 +0100
parents 672610322206
children 5bfb182e24dc
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
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 # 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
30 # See:
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31 # https://github.com/JuliaLang/julia/issues/34884
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 # https://github.com/JuliaLang/julia/issues/30386
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 slice_tuple(t, Val(l), Val(u))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36 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
37 Equivalent to `t[l:u]` but type stable.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 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
40 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
41 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
42
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 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
45
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
46 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
47 E.g
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
48 ```julia
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
49 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
50 ```
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 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
53 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
54 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
55
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 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
58
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
59 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
60 two parts having lenght `M` and `K`.
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
61 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
62 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
63 p1, tail = split_tuple(t, Val(M))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
64 p2, p3 = split_tuple(tail, Val(K))
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
65 return p1,p2,p3
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66 end
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
68
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
69 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
70 flatten_tuple(t)
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
71
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
72 Takes a nested tuple and flattens the whole structure
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
73 """
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
74 flatten_tuple(t::NTuple{N, Number} where N) = t
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
75 flatten_tuple(t::Tuple) = ((flatten_tuple.(t)...)...,) # simplify?
20c376dffe84 Move tuple functions to their own file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
76 flatten_tuple(ts::Vararg) = flatten_tuple(ts)
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
77
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
78 """
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
79 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
80
1215
07c213167f7c Fix typos in docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1094
diff changeset
81 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
82 """
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
83 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
84 if N < length(t)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
85 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
86 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
87
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
88 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
89 return (padding..., t...)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
90 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
91
1094
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
92 """
672610322206 Add docs for left_pad_tuple and right_pad_tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 1087
diff changeset
93 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
94
1215
07c213167f7c Fix typos in docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1094
diff changeset
95 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
96 """
1031
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
97 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
98 if N < length(t)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
99 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
100 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
101
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
102 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
103 return (t..., padding...)
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
104 end
0905cec43d2e Add left and right pad functions for tuple
Jonatan Werpers <jonatan@werpers.com>
parents: 997
diff changeset
105