exit_status.hpp

// Copyright (c) Sleipnir contributors
 
#pragma once
 
#include <stdint.h>
 
#include <string_view>
 
#include "sleipnir/util/symbol_exports.hpp"
 
namespace slp {
 
enum class ExitStatus : int8_t {
  SUCCESS = 0,
  SOLVED_TO_ACCEPTABLE_TOLERANCE = 1,
  CALLBACK_REQUESTED_STOP = 2,
  TOO_FEW_DOFS = -1,
  LOCALLY_INFEASIBLE = -2,
  FACTORIZATION_FAILED = -3,
  LINE_SEARCH_FAILED = -4,
  NONFINITE_INITIAL_COST_OR_CONSTRAINTS = -5,
  DIVERGING_ITERATES = -6,
  MAX_ITERATIONS_EXCEEDED = -7,
  TIMEOUT = -8
};
 
SLEIPNIR_DLLEXPORT constexpr std::string_view ToMessage(
    const ExitStatus& exit_status) {
  using enum ExitStatus;
 
  switch (exit_status) {
    case SUCCESS:
      return "solved to desired tolerance";
    case SOLVED_TO_ACCEPTABLE_TOLERANCE:
      return "solved to acceptable tolerance";
    case CALLBACK_REQUESTED_STOP:
      return "callback requested stop";
    case TOO_FEW_DOFS:
      return "problem has too few degrees of freedom";
    case LOCALLY_INFEASIBLE:
      return "problem is locally infeasible";
    case FACTORIZATION_FAILED:
      return "linear system factorization failed";
    case LINE_SEARCH_FAILED:
      return "backtracking line search failed, and the problem isn't locally "
             "infeasible";
    case NONFINITE_INITIAL_COST_OR_CONSTRAINTS:
      return "solver encountered nonfinite initial cost or constraints and "
             "gave up";
    case DIVERGING_ITERATES:
      return "solver encountered diverging primal iterates xₖ and/or sₖ and "
             "gave up";
    case MAX_ITERATIONS_EXCEEDED:
      return "solution returned after maximum iterations exceeded";
    case TIMEOUT:
      return "solution returned after maximum wall clock time exceeded";
    default:
      return "unknown";
  }
}
 
}  // namespace slp