options.hpp

Go to the documentation of this file.

// Copyright (c) Sleipnir contributors
 
#pragma once
 
#include <chrono>
#include <limits>
 
#include "sleipnir/util/symbol_exports.hpp"
 
namespace slp {
 
/// Solver options.
struct SLEIPNIR_DLLEXPORT Options {
  /// The solver will stop once the error is below this tolerance.
  double tolerance = 1e-8;
 
  /// The maximum number of solver iterations before returning a solution.
  int max_iterations = 5000;
 
  /// The maximum elapsed wall clock time before returning a solution.
  std::chrono::duration<double> timeout{
      std::numeric_limits<double>::infinity()};
 
  /// 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.
  bool feasible_ipm = false;
 
  /// Enables diagnostic output.
  ///
  /// See https://sleipnirgroup.github.io/Sleipnir/md_usage.html#output for more
  /// information.
  bool diagnostics = false;
};
 
}  // namespace slp