Skip to content

Conversation

@julianlitz
Copy link
Collaborator

Merge Request - GuideLine Checklist

Guideline to check code before resolve WIP and approval, respectively.
As many checkboxes as possible should be ticked.

Checks by code author:

Always to be checked:

  • There is at least one issue associated with the pull request.
  • New code adheres with the coding guidelines
  • No large data files have been added to the repository. Maximum size for files should be of the order of KB not MB. In particular avoid adding of pdf, word, or other files that cannot be change-tracked correctly by git.

If functions were changed or functionality was added:

  • Tests for new functionality has been added
  • A local test was succesful

If new functionality was added:

  • There is appropriate documentation of your work. (use doxygen style comments)

If new third party software is used:

  • Did you pay attention to its license? Please remember to add it to the wiki after successful merging.

If new mathematical methods or epidemiological terms are used:

  • Are new methods referenced? Did you provide further documentation?

Checks by code reviewer(s):

  • Is the code clean of development artifacts e.g., unnecessary comments, prints, ...
  • The ticket goals for each associated issue are reached or problems are clearly addressed (i.e., a new issue was introduced).
  • There are appropriate unit tests and they pass.
  • The git history is clean and linearized for the merge request. All reviewers should squash commits and write a simple and meaningful commit message.
  • Coverage report for new code is acceptable.
  • No large data files have been added to the repository. Maximum size for files should be of the order of KB not MB. In particular avoid adding of pdf, word, or other files that cannot be change-tracked correctly by git.

@codecov
Copy link

codecov bot commented Jan 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.86%. Comparing base (cd68b81) to head (086d0c0).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #152      +/-   ##
==========================================
+ Coverage   88.67%   88.86%   +0.18%     
==========================================
  Files          87       87              
  Lines        4982     4931      -51     
==========================================
- Hits         4418     4382      -36     
+ Misses        564      549      -15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines -334 to -345
/* ---------------------------------------------------------- */
/* Based on Cholesky Decomposition: A = L * D * L^T
*
* This function performs Cholesky decomposition on a
* symmetric tridiagonal matrix, factorizing it into
* a lower triangular matrix (L) and a diagonal matrix (D).
*
* By storing the decomposition, this approach enhances
* efficiency for repeated solutions, as matrix factorizations
* need not be recalculated each time.
* ---------------------------------------------------------- */

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing all the documentation seems like a bad idea

Comment on lines -406 to -425
/*
* This algorithm implements the Tridiagonal Matrix Algorithm (TDMA) for solving
* symmetric tridiagonal systems of equations, specifically designed to handle
* cyclic boundary conditions. The implementation is based on principles outlined
* in the following resource:
* https://en.wikipedia.org/wiki/Tridiagonal_matrix_algorithm.
*/

template <typename T>
void SymmetricTridiagonalSolver<T>::solveSymmetricCyclicTridiagonal(T* x, T* u, T* scratch)
{
/* ---------------------------------------------------------- */
/* Cholesky Decomposition: A = L * D * L^T
* This step factorizes the tridiagonal matrix into lower
* triangular (L) and diagonal (D) matrices. While this
* approach may be slightly less stable, it can offer improved
* performance for repeated solves due to the factorization
* being stored internally.
* ---------------------------------------------------------- */

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants