SolverStatus.hpp

Go to the documentation of this file.

// Copyright (c) Sleipnir contributors
 
#pragma once
 
#include "sleipnir/autodiff/ExpressionType.hpp"
#include "sleipnir/optimization/SolverExitCondition.hpp"
#include "sleipnir/util/SymbolExports.hpp"
 
namespace sleipnir {
 
/**
 * Return value of OptimizationProblem::Solve() containing the cost function and
 * constraint types and solver's exit condition.
 */
struct SLEIPNIR_DLLEXPORT SolverStatus {
  /// The cost function type detected by the solver.
  ExpressionType costFunctionType = ExpressionType::kNone;
 
  /// The equality constraint type detected by the solver.
  ExpressionType equalityConstraintType = ExpressionType::kNone;
 
  /// The inequality constraint type detected by the solver.
  ExpressionType inequalityConstraintType = ExpressionType::kNone;
 
  /// The solver's exit condition.
  SolverExitCondition exitCondition = SolverExitCondition::kSuccess;
 
  /// The solution's cost.
  double cost = 0.0;
};
 
}  // namespace sleipnir