ct::optcon::NlpSolverSettings Class Reference

Contains the NLP solver settings. More...

#include <NlpSolverSettings.h>

Public Member Functions
	NlpSolverSettings ()
	Default constructor, set default settings. More...
void	print ()
	Prints out settings. More...
bool	parametersOk () const
	Checks whether to settings are filled with meaningful values. More...
void	load (const std::string &filename, bool verbose=true, const std::string &ns="solver")
	Loads the settings from a .info file. More...

Public Attributes
NlpSolverType	solverType_
bool	useGeneratedCostGradient_
bool	useGeneratedConstraintJacobian_
SnoptSettings	snoptSettings_
IpoptSettings	ipoptSettings_

Detailed Description

Contains the NLP solver settings.

Constructor & Destructor Documentation

NlpSolverSettings()

ct::optcon::NlpSolverSettings::NlpSolverSettings ( )

inline

Default constructor, set default settings.

Member Function Documentation

print()

void ct::optcon::NlpSolverSettings::print ( )

inline

Prints out settings.

References ct::optcon::IPOPT, ct::optcon::SnoptSettings::print(), ct::optcon::IpoptSettings::print(), and ct::optcon::SNOPT.

Referenced by ct::optcon::DmsSettings::print().

parametersOk()

bool ct::optcon::NlpSolverSettings::parametersOk ( ) const

inline

Checks whether to settings are filled with meaningful values.

Returns

Returns true of the parameters are ok

References ct::optcon::IPOPT, ct::optcon::SnoptSettings::parametersOk(), ct::optcon::IpoptSettings::parametersOk(), and ct::optcon::SNOPT.

Referenced by ct::optcon::DmsSettings::parametersOk().

load()

void ct::optcon::NlpSolverSettings::load ( const std::string &  filename, bool  verbose = true, const std::string &  ns = "solver"  )

inline

Loads the settings from a .info file.

Parameters

[in]	filename	The filename
[in]	verbose	True if parameters to be printed out
[in]	ns	The namespace in the .info fil

References ct::optcon::IPOPT, ct::optcon::SnoptSettings::load(), ct::optcon::IpoptSettings::load(), ct::optcon::SNOPT, and ct::optcon::example::verbose.

Referenced by ct::optcon::DmsSettings::load().

Member Data Documentation

solverType_

NlpSolverType ct::optcon::NlpSolverSettings::solverType_

Examples:

DMS.cpp, and oscDMSTest.cpp.

Referenced by ct::optcon::example::OscDms::getIpoptSolution(), ct::optcon::example::OscDms::getSnoptSolution(), main(), and ct::optcon::example::TEST().

useGeneratedCostGradient_

bool ct::optcon::NlpSolverSettings::useGeneratedCostGradient_

useGeneratedConstraintJacobian_

bool ct::optcon::NlpSolverSettings::useGeneratedConstraintJacobian_

snoptSettings_

SnoptSettings ct::optcon::NlpSolverSettings::snoptSettings_

ipoptSettings_

IpoptSettings ct::optcon::NlpSolverSettings::ipoptSettings_

Referenced by main().

---

The documentation for this class was generated from the following file:

• /home/gim2rng/ct_devel_ws/src/control-toolbox/ct_optcon/include/ct/optcon/nlp/solver/NlpSolverSettings.h