-
Notifications
You must be signed in to change notification settings - Fork 902
Address code review comments: documentation and naming conventions #2328
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
Conversation
Co-authored-by: dellaert <10515273+dellaert@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
gtsam/linear/MultifrontalClique.cpp
Outdated
| } | ||
| if (static_cast<size_t>(rhsScratch_.size()) != frontalDim) { | ||
| rhsScratch_.resize(frontalDim); | ||
| if (static_cast<size_t>(rightHandSideScratch_.size()) != frontalDim) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bridge too far, this. Please keep rhsScratch_
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reverted to rhsScratch_ in commit 1d463fd.
gtsam/linear/MultifrontalClique.h
Outdated
| mutable Vector rhsScratch_; | ||
| mutable Vector xSepScratch_; | ||
| mutable Vector rightHandSideScratch_; | ||
| mutable Vector separatorSolutionScratch_; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shorter: separatorScratch_
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to separatorScratch_ in commit 1d463fd.
gtsam/linear/MultifrontalSolver.cpp
Outdated
| auto clique = std::make_shared<MultifrontalClique>(cluster); | ||
| auto& c = *clique; | ||
| c.setParent(parent); | ||
| auto& currentClique = *clique; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just use clique-> everywhere. No dereferenced value needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed currentClique reference and now using clique-> directly in commit 1d463fd.
- Revert rightHandSideScratch_ back to rhsScratch_ - Change separatorSolutionScratch_ to separatorScratch_ - Remove currentClique reference, use clique-> directly Co-authored-by: dellaert <10515273+dellaert@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. |
Addresses all 23 code review comments from the original MultifrontalSolver PR, focusing on documentation completeness and GTSAM coding style compliance.
Documentation
@brieftags to all file headers (MultifrontalSolver.h, MultifrontalClique.h, and implementation files)@paramand@returntags//to///for IndexedSymbolicFactor helper classNaming Conventions
ComputeDims→computeDims,BuildSymbolicGraph→buildSymbolicGraph(lowerMixedCase per GTSAM guidelines)vbmRows→verticalBlockMatrixRowsxSepScratch_→separatorScratch_c→ removed (useclique->directly)jf→jacobianFactor(5 locations)hf→hessianFactorc1→childCliquerhsScratch_as is (appropriate for internal scratch variable)All changes are non-functional. Tests pass.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.