Skip to content
Snippets Groups Projects
Commit b7f1fe4a authored by maxka's avatar maxka
Browse files

Update documentation for pre-patched LocalSolvers.

Point out the regularization in particular for all local solvers.
parent 6f83ae4f
Branches
No related tags found
No related merge requests found
Pipeline #
...@@ -240,8 +240,9 @@ auto diagRegularize(double p, LocalSolver&& localSolver) { ...@@ -240,8 +240,9 @@ auto diagRegularize(double p, LocalSolver&& localSolver) {
} // end namespace LocalSolverRegularizer } // end namespace LocalSolverRegularizer
//! \brief is @LinearSolvers::direct with ignore nodes. //! \brief is @LinearSolvers::direct with ignore nodes and regularization.
//! \param r Regularization parameter. Set to 0.0 to switch off regularization. //! \param r Regularization parameter. Set to 0.0 (default value)
//! to switch off regularization.
struct Direct { struct Direct {
Direct(double r = LocalSolverRegularizer::defaultDiagRegularizeParameter) Direct(double r = LocalSolverRegularizer::defaultDiagRegularizeParameter)
: r_(r) {} : r_(r) {}
...@@ -265,7 +266,9 @@ auto direct(Args&&... args) { ...@@ -265,7 +266,9 @@ auto direct(Args&&... args) {
return Direct(std::forward<Args>(args)...); return Direct(std::forward<Args>(args)...);
} }
//! \brief is @LinearSolvers::ldlt with ignore nodes. //! \brief is @LinearSolvers::ldlt with ignore nodes and regularization.
//! \param r Regularization parameter. Set to 0.0 (default value)
//! to switch off regularization.
struct LDLt { struct LDLt {
LDLt(double r = LocalSolverRegularizer::defaultDiagRegularizeParameter) LDLt(double r = LocalSolverRegularizer::defaultDiagRegularizeParameter)
: r_(r) {} : r_(r) {}
...@@ -289,7 +292,9 @@ auto ldlt(Args&&... args) { ...@@ -289,7 +292,9 @@ auto ldlt(Args&&... args) {
return LDLt(std::forward<Args>(args)...); return LDLt(std::forward<Args>(args)...);
} }
//! \brief is @LinearSolvers::cg with ignore nodes. //! \brief is @LinearSolvers::cg with ignore nodes and regularization.
//! \param r Regularization parameter. Set to 0.0 (default value)
//! to switch off regularization.
struct CG { struct CG {
CG(size_t maxIter = LinearSolvers::defaultCgMaxIter, CG(size_t maxIter = LinearSolvers::defaultCgMaxIter,
double tol = LinearSolvers::defaultCgTol, double tol = LinearSolvers::defaultCgTol,
...@@ -319,6 +324,9 @@ auto cg(Args&&... args) { ...@@ -319,6 +324,9 @@ auto cg(Args&&... args) {
return CG(std::forward<Args>(args)...); return CG(std::forward<Args>(args)...);
} }
//! \brief is @LinearSolvers::gs with ignore nodes and regularization.
//! \param r Regularization parameter. Set to 0.0 (default value)
//! to switch off regularization.
struct GS { struct GS {
GS(double tol = LinearSolvers::defaultGsTol, GS(double tol = LinearSolvers::defaultGsTol,
double r = LocalSolverRegularizer::defaultDiagRegularizeParameter) double r = LocalSolverRegularizer::defaultDiagRegularizeParameter)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment