comparison TODO.md @ 1854:654a2b7e6824 tooling/benchmarks

Merge default
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 11 Jan 2025 10:19:47 +0100
parents fe058a0ebd97
children
comparison
equal deleted inserted replaced
1378:2b5480e2d4bf 1854:654a2b7e6824
2 2
3 ## Organization 3 ## Organization
4 - [ ] Split up Notes.md in several files 4 - [ ] Split up Notes.md in several files
5 5
6 ## Coding 6 ## Coding
7 - [ ] Ändra namn på variabler och funktioner så att det följer style-guide
8 - [ ] 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 - [ ] Use `@inferred` in a lot of tests.
11 - [ ] 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 8 - [ ] 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 9 - [ ] 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 10 - [ ] Clean up RegionIndices
15 1. [ ] Write tests for how things should work 11 1. [ ] Write tests for how things should work
16 2. [ ] Update RegionIndices accordingly 12 2. [ ] Update RegionIndices accordingly
17 3. [ ] Fix the rest of the library 13 3. [ ] Fix the rest of the library
18 Should getregion also work for getregion(::Colon,...) 14 Should getregion also work for getregion(::Colon,...)
19 - [ ] 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. 15 - [ ] 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) 16 See (https://docs.julialang.org/en/v1/manual/types/#man-custom-pretty-printing)
22 - [ ] Samla noggrannhets- och SBP-ness-tester för alla operatorer på ett ställe 17 - [ ] Samla noggrannhets- och SBP-ness-tester för alla operatorer på ett ställe
23 - [ ] Move export statements to top of each module 18 - [ ] Move export statements to top of each module
19 - [ ] Implement apply_transpose for
20 - [ ] ElementwiseTensorOperation
21 - [ ] VolumeOperator
22 - [ ] Laplace
24 23
25 24
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? 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?
27 - [ ] 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
28 - [ ] 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
29 - [ ] Kolla att vi har @inline på rätt ställen 28 - [ ] Kolla att vi har @inline på rätt ställen
30 - [ ] Profilera 29 - [ ] Profilera
31 30
31 - [ ] Keep a lookout for allowing dependencies of package extensions (https://github.com/JuliaLang/Pkg.jl/issues/3641) This should be used to simplify the matrix extensions so that you don't have to load Tokens which is only used internally to the extension
32 32
33 ### Grids 33 ### Grids
34 34
35 - [ ] Multiblock grids 35 - [ ] Multiblock grids
36 - [ ] Periodic grids 36 - [ ] Periodic grids
37 - [ ] Grids with modified boundary closures 37 - [ ] Grids with modified boundary closures
38 - [ ] Support indexing with `:`.
38 39
39 40
40 ### Benchmarks 41 ### Benchmarks
41 - [ ] Benchmarks for all grid indexing (focused on allocation) 42 - [ ] Benchmarks for all grid indexing (focused on allocation)
42 - [ ] Benchmarks for indexing of lazy grid functions 43 - [ ] Benchmarks for indexing of lazy grid functions