annotate TODO.md @ 1041:6b94663f4376 refactor/lazy_tensors

Remove a bunch of todos
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 22 Mar 2022 14:27:03 +0100
parents 7fc8df5157a7
children 3bb94ce74697 396278072f18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
102
f99320a459ef Add TODO file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 # TODO
f99320a459ef Add TODO file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
3 ## Skämskudde
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
4 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
5 - [ ] Skriv tester
102
f99320a459ef Add TODO file
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
7 ## Coding
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
8 - [ ] Add new Laplace operator to DiffOps, probably named WaveEqOp(?!!?)
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
9 - [ ] Create a struct that bundles the necessary Tensor operators for solving the wave equation.
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
10 - [ ] Replace getindex hack for flattening tuples with flatten_tuple. (eg. `getindex.(range_size.(L.D2),1)`)
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 332
diff changeset
11 - [ ] Use `@inferred` in a lot of tests.
427
1c41f4fd3e61 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 379
diff changeset
12 - [ ] Make sure we are setting tolerances in tests in a consistent way
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
13 - [ ] Write down some coding guideline or checklist for code conventions. For example i,j,... for indices and I for multi-index
606
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
14 - [ ] Clean up RegionIndices
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
15 1. [ ] Write tests for how things should work
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
16 2. [ ] Update RegionIndices accordingly
8f9b3eac128a Add a bunch of stuff to TODO.md and Notes.md
Jonatan Werpers <jonatan@werpers.com>
parents: 549
diff changeset
17 3. [ ] Fix the rest of the library
626
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
18 Should getregion also work for getregion(::Colon,...)
8581610da4f1 Add comment for work on RegionIndices and fix typos
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 606
diff changeset
19 - [ ] Add possibility to create tensor mapping application with `()`, e.g `D1(v) <=> D1*v`?
656
1c3378b26466 Add todo on pretty printing
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 653
diff changeset
20 - [ ] Add custom pretty printing to LazyTensors/SbpOperators to enhance readability of e.g error messages.
1c3378b26466 Add todo on pretty printing
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 653
diff changeset
21 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing)
963
52a0ebad0778 Review: Address review comment on placement of exports. Export statements should be placed at the top of the module file. Add todo.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 656
diff changeset
22 - [ ] Move export statements to top of each module
119
8e52a66225d0 Add some Todos
Jonatan Werpers <jonatan@werpers.com>
parents: 102
diff changeset
23
379
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 332
diff changeset
24 ## Repo
de4746d6d126 Add some notes and todos
Jonatan Werpers <jonatan@werpers.com>
parents: 332
diff changeset
25 - [ ] Rename repo to Sbplib.jl
297
dfadc0bafbbd Fix some formatting errors in TODO.md
Jonatan Werpers <jonatan@werpers.com>
parents: 295
diff changeset
26
320
d705b397aa33 Clean up Notes.md and TODO.md
Jonatan Werpers <jonatan@werpers.com>
parents: 319
diff changeset
27 # Wrap up tasks
294
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
28 - [ ] Kolla att vi har @inbounds och @propagate_inbounds på rätt ställen
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
29 - [ ] Kolla att vi gör boundschecks överallt och att de är markerade med @boundscheck
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
30 - [ ] Kolla att vi har @inline på rätt ställen
9c12d9eb38fd Clean up TODO.txt
Jonatan Werpers <jonatan@werpers.com>
parents: 284
diff changeset
31 - [ ] Profilera