en_Opt_Status.hpp File Reference

#include "typedefs.hpp"

Include dependency graph for en_Opt_Status.hpp:

Go to the source code of this file.

Namespaces
namespace	belfem
	USER GUIDES:
namespace	belfem::opt

Enumerations
enum class	belfem::opt::Status {   belfem::opt::SUCCESS = 0 , belfem::opt::STOPVAL_REACHED = 1 , belfem::opt::FTOL_REACHED = 2 , belfem::opt::XTOL_REACHED = 3 ,   belfem::opt::MAXEVAL_REACHED = 4 , belfem::opt::MAXTIME_REACHED = 5 , belfem::opt::FAILURE = 6 , belfem::opt::INVALID_ARGS = 7 ,   belfem::opt::OUT_OF_MEMORY = 8 , belfem::opt::ROUNDOFF_LIMITED = 9 , belfem::opt::FORCED_STOP = 10 }
	outcome of an optimization run. More...

Functions
bool	belfem::opt::is_success (const Status aStatus)
	true if the status corresponds to a converged / usable result
bool	belfem::opt::is_usable (const Status aStatus)
	true if the returned design point is usable, even when the solver did not terminate on a clean convergence criterion.
string	belfem::opt::error_message (const Status aStatus)
	human-readable explanation of an optimizer status, suitable for a BELFEM_ERROR message when is_usable() is false.