Skip to content

Add LU solver documentation #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 34 commits into from
Mar 20, 2025
Merged

Add LU solver documentation #890

merged 34 commits into from
Mar 20, 2025

Conversation

mgovers
Copy link
Member

@mgovers mgovers commented Feb 7, 2025

  • Add LU solver documentation
    • Rationale
    • Implementation

@mgovers mgovers added the documentation Improvements or additions to documentation label Feb 7, 2025
@mgovers mgovers changed the base branch from main to feature/grid-graphs-with-tikz February 7, 2025 10:45
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers force-pushed the feature/lu-solver-documentation branch from 78c6fe8 to 794e15e Compare February 7, 2025 10:48
@mgovers mgovers changed the base branch from feature/grid-graphs-with-tikz to main February 7, 2025 10:48
@mgovers mgovers self-assigned this Feb 10, 2025
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers
Copy link
Member Author

mgovers commented Feb 13, 2025

@TonyXiang8787 this is ready for a first review round. I will spend some time tomorrow on going through all the documentation from start to finish myself as well to check if the structure still makes sense, but some feedback would be nice as well at this stage.

mgovers and others added 3 commits February 14, 2025 08:32
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers force-pushed the feature/lu-solver-documentation branch from 53051da to f2551a8 Compare February 14, 2025 10:03
mgovers and others added 5 commits February 17, 2025 14:16
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers marked this pull request as ready for review February 27, 2025 17:21
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Copy link
Contributor

@Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo left a comment

Choose a reason for hiding this comment

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

Up until Block-sparse LU-factorization

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Copy link
Contributor

@Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo left a comment

Choose a reason for hiding this comment

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

Up to Pivot perturbation

@TonyXiang8787
Copy link
Member

@mgovers I have resolved all my previous comments. But I think I made a mistake to propose using mathbb for matrix symbol. What I meant is actually mathbf. We usually use mathbb for set notations.

Copy link
Contributor

@Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo left a comment

Choose a reason for hiding this comment

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

This is my final sprint in this review. I will try and go over the comments from my previous reviews but I believe if there is a matter opinion difference, you can proceed by resolving mine. If I made a factual mistake in certain comment, you can also resolve them directly.

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers
Copy link
Member Author

mgovers commented Mar 19, 2025

@mgovers I have resolved all my previous comments. But I think I made a mistake to propose using mathbb for matrix symbol. What I meant is actually mathbf. We usually use mathbb for set notations.

While a very small change, I believe it makes the difference between matrices and vectors almost disappear, and even more so for vectors of matrices. E.g.:

image
vs
image

what do you propose?

@figueroa1395
Copy link
Contributor

@mgovers I have resolved all my previous comments. But I think I made a mistake to propose using mathbb for matrix symbol. What I meant is actually mathbf. We usually use mathbb for set notations.

While a very small change, I believe it makes the difference between matrices and vectors almost disappear, and even more so for vectors of matrices. E.g.:

image vs image

what do you propose?

Even though you have a point, I find the new "font" more aesthetic and easier on the eyes. That is probably subjective, but I would keep the new version.

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers
Copy link
Member Author

mgovers commented Mar 19, 2025

@mgovers I have resolved all my previous comments. But I think I made a mistake to propose using mathbb for matrix symbol. What I meant is actually mathbf. We usually use mathbb for set notations.

While a very small change, I believe it makes the difference between matrices and vectors almost disappear, and even more so for vectors of matrices. E.g.:
image vs image
what do you propose?

Even though you have a point, I find the new "font" more aesthetic and easier on the eyes. That is probably subjective, but I would keep the new version.

cfr. this and offline discussion with tony: \boldsymbol for vectors, \mathbf for matrices. Block-vectors are also matrices and therefore are also represented as \mathbf

@mgovers
Copy link
Member Author

mgovers commented Mar 20, 2025

Since all other comments are resolved, I will now do the git mv cfr.
#890 (comment)

mgovers and others added 2 commits March 20, 2025 11:34
@mgovers
Copy link
Member Author

mgovers commented Mar 20, 2025

IT'S HAPPENING

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers added this pull request to the merge queue Mar 20, 2025
Merged via the queue into main with commit 86e4188 Mar 20, 2025
28 checks passed
@mgovers mgovers deleted the feature/lu-solver-documentation branch March 20, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants