Document Si track extension - first batch
This MR contains the initial work towards cleaning up and documenting the combinatorial silicon track extension - including the SiTrackMaker_xk
, SiCombinatorialTrackFinder_xk
, SiTrajectory_xk
, SiTrajectoryElement_xk
.
The changes attempt to make the code more readable for newcomers and document the logic in a more accessible way to users studying the code, while preserving the elegance of the original implementation. No performance changes are expected.
As the classes are tightly coupled, they can only be documented together. As a result, there is a large number of changed lines throughout the affected classes, even though the vast majority of changes are just formatting, renaming, and comments.
Given that I have reached 1400 lines of changes, with a related growth in the risk of merge conflicts (already had one), I am containing the progress so far within this MR, and will follow up in another.
Adding @sroe, @npetters, @sswatman and @zschilla
Also adding @jsandesa - do any of my changes clash with developments you are working on?
Merge request reports
Activity
- Resolved by Johannes Junggeburth
Adding @ncalace who is working on the same class, maybe some of the notes so far are of use to her!
added 256 commits
-
71d442fc...0aa0493e - 254 commits from branch
master
- aaca650c - Merge tag 'nightly/master/2020-10-15T2101' into docTrackMaker
- 582a02a9 - doc
-
71d442fc...0aa0493e - 254 commits from branch
added 224 commits
-
582a02a9...0f978791 - 222 commits from branch
master
- 13d155ad - Merge remote-tracking branch 'upstream/master' into docTrackMaker
- 1f35bb29 - start doc of combi track finder
-
582a02a9...0f978791 - 222 commits from branch
added 2 commits
added 2 commits
- Resolved by Johannes Junggeburth
added 108 commits
-
a0de6226...f754aacc - 106 commits from branch
master
- 465d0ec1 - more doc
- bbf51cb3 - Merge remote-tracking branch 'upstream/master' into docTrackMaker
-
a0de6226...f754aacc - 106 commits from branch