comparison TODO.md @ 914:a9d776400251 feature/variable_derivatives

Clean up TODO.md
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 18 Feb 2022 07:18:38 +0100
parents e6d8fd5e8268
children f885e1de6dc4
comparison
equal deleted inserted replaced
913:cad3a9f82009 914:a9d776400251
1 # TODO 1 # TODO
2 2
3 ## Skämskudde 3
4 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide 4 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide
5 - [ ] Skriv tester
6
7 ## Coding
8 - [ ] Add new Laplace operator to DiffOps, probably named WaveEqOp(?!!?) 5 - [ ] Add new Laplace operator to DiffOps, probably named WaveEqOp(?!!?)
9 - [ ] Create a struct that bundles the necessary Tensor operators for solving the wave equation. 6 - [ ] Create a struct that bundles the necessary Tensor operators for solving the wave equation.
10 - [ ] Add a quick and simple way of running all tests for all subpackages.
11 - [ ] Replace getindex hack for flattening tuples with flatten_tuple. (eg. `getindex.(range_size.(L.D2),1)`) 7 - [ ] Replace getindex hack for flattening tuples with flatten_tuple. (eg. `getindex.(range_size.(L.D2),1)`)
12 - [ ] Use `@inferred` in a lot of tests. 8 - [ ] Use `@inferred` in a lot of tests.
9 - [ ] Replace `@inferred` tests with a benchmark suite that automatically tests for regressions.
13 - [ ] Make sure we are setting tolerances in tests in a consistent way 10 - [ ] Make sure we are setting tolerances in tests in a consistent way
14 - [ ] Add check for correct domain sizes to lazy tensor operations using SizeMismatch 11 - [ ] Add check for correct domain sizes to lazy tensor operations using SizeMismatch
15 - [ ] Write down some coding guideline or checklist for code conventions. For example i,j,... for indices and I for multi-index 12 - [ ] Write down some coding guideline or checklist for code conventions. For example i,j,... for indices and I for multi-index
16 - [ ] Add boundschecking in TensorMappingApplication 13 - [ ] Add boundschecking in TensorMappingApplication
17 - [ ] Start renaming things in LazyTensors 14 - [ ] Start renaming things in LazyTensors
21 3. [ ] Fix the rest of the library 18 3. [ ] Fix the rest of the library
22 Should getregion also work for getregion(::Colon,...) 19 Should getregion also work for getregion(::Colon,...)
23 - [ ] Add possibility to create tensor mapping application with `()`, e.g `D1(v) <=> D1*v`? 20 - [ ] Add possibility to create tensor mapping application with `()`, e.g `D1(v) <=> D1*v`?
24 - [ ] Add custom pretty printing to LazyTensors/SbpOperators to enhance readability of e.g error messages. 21 - [ ] Add custom pretty printing to LazyTensors/SbpOperators to enhance readability of e.g error messages.
25 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing) 22 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing)
26 - [ ] Gå igenom alla typ parametrar och kolla om de är motiverade. Både i signaturer och typer, tex D i VariableSecondDerivative 23 - [ ] Samla noggrannhets- och SBP-ness-tester för alla operatorer på ett ställe
27 24
28 ## Repo
29 - [ ] Rename repo to Sbplib.jl
30 25
31 # Wrap up tasks 26 - [ ] Gå igenom alla typ parametrar och kolla om de är motiverade. Både i signaturer och typer, tex D i VariableSecondDerivative. Kan vi använda promote istället?
32 - [ ] Kolla att vi har @inbounds och @propagate_inbounds på rätt ställen 27 - [ ] Kolla att vi har @inbounds och @propagate_inbounds på rätt ställen
33 - [ ] Kolla att vi gör boundschecks överallt och att de är markerade med @boundscheck 28 - [ ] Kolla att vi gör boundschecks överallt och att de är markerade med @boundscheck
34 - [ ] Kolla att vi har @inline på rätt ställen 29 - [ ] Kolla att vi har @inline på rätt ställen
35 - [ ] Profilera 30 - [ ] Profilera