OsqpEigen::Settings class

settings class is a wrapper of the OSQP OSQPSettings struct.

All the setter methods refer to this particular kind of optimizer. Here you can find further information.

Constructors, destructors, conversion operators

Settings()
Constructor.
~Settings()
Deconstructor.

Public functions

void resetDefaultSettings()
Reset the default settings for the optimization problem.
void setRho(const double rho)
Set the ADMM step rho.
void setSigma(const double sigma)
Set the ADMM step sigma.
void setScaling(const int scaling)
Set the heuristic data scaling iterations.
void setAdaptiveRho(const bool isRhoStepSizeAdactive)
Set if the rho step size adaptive feature is active.
void setAdaptiveRhoInterval(const int rhoInterval)
Set the number of iterations between rho adaptations rho.
void setAdaptiveRhoTolerance(const double adaptiveRhoTolerance)
Set the tolerance for adapting rho.
void setAdaptiveRhoFraction(const double adaptiveRhoFraction)
Set the interval for adapting rho (fraction of the setup time).
void setMaxIteraction(const int maxIteration)
Set the max number of iterations.
void setMaxIteration(const int maxIteration)
Set the max number of iterations.
void setAbsoluteTolerance(const double absoluteTolerance)
Set the absolute convergence tolerance.
void setRelativeTolerance(const double relativeTolerance)
Set the relative convergence tolerance.
void setPrimalInfeasibilityTollerance(const double primalInfeasibilityTolerance)
Set the primal infeasibility tolerance.
void setPrimalInfeasibilityTolerance(const double primalInfeasibilityTolerance)
Set the primal infeasibility tolerance.
void setDualInfeasibilityTollerance(const double dualInfeasibilityTolerance)
Set the dual infeasibility tolerance.
void setDualInfeasibilityTolerance(const double dualInfeasibilityTolerance)
Set the dual infeasibility tolerance.
void setAlpha(const double alpha)
Set the relaxation parameter.
void setLinearSystemSolver(const int linsysSolver)
Set linear solver.
void setDelta(const double delta)
Set the relaxation parameter for polish.
void setPolish(const bool polish)
Set if the polish feature is active.
void setPolishRefineIter(const int polishRefineIter)
Set the iterative refinement steps in polish.
void setVerbosity(const bool isVerbose)
Set the Verbose mode.
void setScaledTerimination(const bool scaledTermination)
Set the scaled termination criteria.
void setCheckTermination(const int checkTermination)
Set check termination interval.
void setWarmStart(const bool warmStart)
Set warm start.
void setTimeLimit(const double timeLimit)
Set the maximum number of seconds allowed to solve the problem.
auto getSettings() const -> OSQPSettings*const &
Get a pointer to Settings struct.

Function documentation

void OsqpEigen::Settings::setRho(const double rho)

Set the ADMM step rho.

Parameters
rho a ADMM step constant.

void OsqpEigen::Settings::setSigma(const double sigma)

Set the ADMM step sigma.

Parameters
sigma a ADMM step constant.

void OsqpEigen::Settings::setScaling(const int scaling)

Set the heuristic data scaling iterations.

Parameters
scaling is the heuristic data scaling iteration.

If 0, scaling disabled.

void OsqpEigen::Settings::setAdaptiveRho(const bool isRhoStepSizeAdactive)

Set if the rho step size adaptive feature is active.

Parameters
isRhoStepSizeAdactive if True the feature is active.

void OsqpEigen::Settings::setAdaptiveRhoInterval(const int rhoInterval)

Set the number of iterations between rho adaptations rho.

Parameters
rhoInterval number of iterations.

If 0, it is automatic.

void OsqpEigen::Settings::setAdaptiveRhoTolerance(const double adaptiveRhoTolerance)

Set the tolerance for adapting rho.

Parameters
adaptiveRhoTolerance is the tolerance.

The new rho has to be X times larger or 1/X times smaller than the current one to trigger a new factorization.

void OsqpEigen::Settings::setAdaptiveRhoFraction(const double adaptiveRhoFraction)

Set the interval for adapting rho (fraction of the setup time).

Parameters
adaptiveRhoFraction interval of the adapting rho.

void OsqpEigen::Settings::setMaxIteraction(const int maxIteration)

Set the max number of iterations.

Parameters
maxIteration max number of iteration

void OsqpEigen::Settings::setMaxIteration(const int maxIteration)

Set the max number of iterations.

Parameters
maxIteration max number of iteration

void OsqpEigen::Settings::setAbsoluteTolerance(const double absoluteTolerance)

Set the absolute convergence tolerance.

Parameters
absoluteTolerance absolute tolerance of the solver.

void OsqpEigen::Settings::setRelativeTolerance(const double relativeTolerance)

Set the relative convergence tolerance.

Parameters
relativeTolerance relative tolerance of the solver.

void OsqpEigen::Settings::setPrimalInfeasibilityTollerance(const double primalInfeasibilityTolerance)

Set the primal infeasibility tolerance.

Parameters
primalInfeasibilityTolerance tolerance of the primal variables.

void OsqpEigen::Settings::setPrimalInfeasibilityTolerance(const double primalInfeasibilityTolerance)

Set the primal infeasibility tolerance.

Parameters
primalInfeasibilityTolerance tolerance of the primal variables.

void OsqpEigen::Settings::setDualInfeasibilityTollerance(const double dualInfeasibilityTolerance)

Set the dual infeasibility tolerance.

Parameters
dualInfeasibilityTolerance tolerance of the dual variables.

void OsqpEigen::Settings::setDualInfeasibilityTolerance(const double dualInfeasibilityTolerance)

Set the dual infeasibility tolerance.

Parameters
dualInfeasibilityTolerance tolerance of the dual variables.

void OsqpEigen::Settings::setAlpha(const double alpha)

Set the relaxation parameter.

Parameters
alpha is the relaxation parameter.

void OsqpEigen::Settings::setLinearSystemSolver(const int linsysSolver)

Set linear solver.

Parameters
linsysSolver is the name of the solver

void OsqpEigen::Settings::setDelta(const double delta)

Set the relaxation parameter for polish.

Parameters
delta is the relaxation parameter.

void OsqpEigen::Settings::setPolish(const bool polish)

Set if the polish feature is active.

Parameters
polish if True the feature is active.

void OsqpEigen::Settings::setPolishRefineIter(const int polishRefineIter)

Set the iterative refinement steps in polish.

Parameters
polishRefineIter iterative refinement step.

void OsqpEigen::Settings::setVerbosity(const bool isVerbose)

Set the Verbose mode.

Parameters
isVerbose if true the verbose mode is activate.

void OsqpEigen::Settings::setScaledTerimination(const bool scaledTermination)

Set the scaled termination criteria.

Parameters
scaledTermination if true the scaled termination criteria is used.

void OsqpEigen::Settings::setCheckTermination(const int checkTermination)

Set check termination interval.

Parameters
checkTermination if 0 the termination checking is disabled.

If 0, termination checking is disabled.

void OsqpEigen::Settings::setWarmStart(const bool warmStart)

Set warm start.

Parameters
warmStart if true the warm start is set.

void OsqpEigen::Settings::setTimeLimit(const double timeLimit)

Set the maximum number of seconds allowed to solve the problem.

Parameters
timeLimit is the time limit in seconds. If 0, then disabled.

OSQPSettings*const & OsqpEigen::Settings::getSettings() const

Get a pointer to Settings struct.

Returns a const pointer to OSQPSettings struct.