slp::Options< Scalar > Struct Template Reference

#include </home/runner/work/Sleipnir/Sleipnir/include/sleipnir/optimization/solver/options.hpp>

Public Attributes
Scalar	tolerance = Scalar(1e-8)
	The solver will stop once the error is below this tolerance.
int	max_iterations = 5000
	The maximum number of solver iterations before returning a solution.
std::chrono::duration< double >	timeout
	The maximum elapsed wall clock time before returning a solution.
bool	feasible_ipm = false
bool	diagnostics = false

Detailed Description

template<typename Scalar>
struct slp::Options< Scalar >

Solver options.

Template Parameters

Scalar

Scalar type.

Member Data Documentation

diagnostics

template<typename Scalar >

bool slp::Options< Scalar >::diagnostics = false

Enables diagnostic output.

See https://sleipnirgroup.github.io/Sleipnir/md_usage.html#output for more information.

feasible_ipm

template<typename Scalar >

bool slp::Options< Scalar >::feasible_ipm = false

Enables the feasible interior-point method.

When the inequality constraints are all feasible, step sizes are reduced when necessary to prevent them becoming infeasible again. This is useful when parts of the problem are ill-conditioned in infeasible regions (e.g., square root of a negative value). This can slow or prevent progress toward a solution though, so only enable it if necessary.

timeout

template<typename Scalar >

std::chrono::duration<double> slp::Options< Scalar >::timeout

Initial value:

{
      std::numeric_limits<double>::infinity()}

The maximum elapsed wall clock time before returning a solution.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/Sleipnir/Sleipnir/include/sleipnir/optimization/solver/options.hpp