Mercurial > repos > public > sbplib_julia

comparison TODO.md @ 1050:396278072f18

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some notes and clean up TODO.md a little bit
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 23 Mar 2022 13:09:31 +0100
parents 6b94663f4376
children eeecdf135912 6567e38b05ca
comparison
equal deleted inserted replaced
1043:c16116e403e2 1050:396278072f18
1 # TODO 1 # TODO
2 2
3 ## Skämskudde
4 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide
5 - [ ] Skriv tester
6 3
7 ## Coding 4 ## Coding
5 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide
8 - [ ] Add new Laplace operator to DiffOps, probably named WaveEqOp(?!!?) 6 - [ ] Add new Laplace operator to DiffOps, probably named WaveEqOp(?!!?)
9 - [ ] Create a struct that bundles the necessary Tensor operators for solving the wave equation. 7 - [ ] Create a struct that bundles the necessary Tensor operators for solving the wave equation.
10 - [ ] Replace getindex hack for flattening tuples with flatten_tuple. (eg. `getindex.(range_size.(L.D2),1)`) 8 - [ ] Replace getindex hack for flattening tuples with flatten_tuple. (eg. `getindex.(range_size.(L.D2),1)`)
11 - [ ] Use `@inferred` in a lot of tests. 9 - [ ] Use `@inferred` in a lot of tests.
10 - [ ] Replace `@inferred` tests with a benchmark suite that automatically tests for regressions.
12 - [ ] Make sure we are setting tolerances in tests in a consistent way 11 - [ ] Make sure we are setting tolerances in tests in a consistent way
13 - [ ] 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
14 - [ ] Clean up RegionIndices 13 - [ ] Clean up RegionIndices
15 1. [ ] Write tests for how things should work 14 1. [ ] Write tests for how things should work
16 2. [ ] Update RegionIndices accordingly 15 2. [ ] Update RegionIndices accordingly
17 3. [ ] Fix the rest of the library 16 3. [ ] Fix the rest of the library
18 Should getregion also work for getregion(::Colon,...) 17 Should getregion also work for getregion(::Colon,...)
19 - [ ] Add possibility to create tensor mapping application with `()`, e.g `D1(v) <=> D1*v`? 18 - [ ] Add possibility to create tensor mapping application with `()`, e.g `D1(v) <=> D1*v`?
20 - [ ] Add custom pretty printing to LazyTensors/SbpOperators to enhance readability of e.g error messages. 19 - [ ] Add custom pretty printing to LazyTensors/SbpOperators to enhance readability of e.g error messages.
21 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing) 20 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing)
21 - [ ] Samla noggrannhets- och SBP-ness-tester för alla operatorer på ett ställe
22 - [ ] Move export statements to top of each module 22 - [ ] Move export statements to top of each module
23 23
24 ## Repo
25 - [ ] Rename repo to Sbplib.jl
26 24
27 # Wrap up tasks 25 - [ ] 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?
28 - [ ] Kolla att vi har @inbounds och @propagate_inbounds på rätt ställen 26 - [ ] Kolla att vi har @inbounds och @propagate_inbounds på rätt ställen
29 - [ ] Kolla att vi gör boundschecks överallt och att de är markerade med @boundscheck 27 - [ ] Kolla att vi gör boundschecks överallt och att de är markerade med @boundscheck
30 - [ ] Kolla att vi har @inline på rätt ställen 28 - [ ] Kolla att vi har @inline på rätt ställen
31 - [ ] Profilera 29 - [ ] Profilera