MOOCHO Version of the Day
Functions
Helper function for ExampleNLPFirstOrder

Functions

MoochoPack::MoochoSolver::ESolutionStatus NLPInterfacePack::ExampleNLPFirstOrderRun (const VectorSpace &vec_space, value_type xo, bool has_bounds, bool dep_bounded, std::ostream *console_out, std::ostream *error_out, bool throw_solve_exception=false, std::ostream *algo_out=NULL, std::ostream *summary_out=NULL, std::ostream *journal_out=NULL)
 Function accepts a VectorSpace object and then uses it to define an example NLP and run MoochoPack::MoochoSolver on it.

Function Documentation

MoochoPack::MoochoSolver::ESolutionStatus NLPInterfacePack::ExampleNLPFirstOrderRun ( const VectorSpace &  vec_space,
value_type  xo,
bool  has_bounds,
bool  dep_bounded,
std::ostream *  console_out,
std::ostream *  error_out,
bool  throw_solve_exception = false,
std::ostream *  algo_out = NULL,
std::ostream *  summary_out = NULL,
std::ostream *  journal_out = NULL 
)

Function accepts a VectorSpace object and then uses it to define an example NLP and run MoochoPack::MoochoSolver on it.

Parameters:
vec_space[in] The vector space object used to create all of the needed vector spaces and vectors. This vector space and the vectors it creates will get a though testing.
xo[in] The initial starting point for unknown variables (before they are forced in bounds).
has_bounds[in] If true, then the NLP will have bounds on the variables.
dep_bounded[in] (valid only if has_bounds == true) If true, then the dependent variables will be bounded, if false the independent variables will be bounded.
console_out[in/out] If != NULL then *console_out gets the output.
error_out[in/out] If != NULL then *eout gets minimal summary output.
throw_solve_exception[in] If true then solver will not throw exception (but other code may).
algo_out[in/out] If != NULL then it gets algo outptut, otherwise goes to 'MoochoAlgo.out'
summary_out[in/out] If != NULL then it gets summary outptut, otherwise goes to 'MoochoSummary.out'
journal_out[in/out] If != NULL then it gets journal outptut, otherwise goes to 'MoochoJournal.out'
Returns:
Returns the return value from MoochoPack::rsqp_mama_jama_solve() (see this function for most of the documentation).

Definition at line 52 of file NLPInterfacePack_ExampleNLPFirstOrderRun.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends