Ipopt::AmplOptionsList Class Reference

Class for storing a number of AMPL options that should be registered to the AMPL Solver library interface. More...

#include <AmplTNLP.hpp>

Inheritance diagram for Ipopt::AmplOptionsList:

Classes
class	AmplOption
	Ampl Option class containing name, type and description for an AMPL option. More...
class	PrivatInfo

Public Types
enum	AmplOptionType {   String_Option , Number_Option , Integer_Option , WS_Option ,   HaltOnError_Option }

Public Member Functions
	AmplOptionsList ()
	Default Constructor.
	~AmplOptionsList ()
	Destructor.
void	AddAmplOption (const std::string &ampl_option_name, const std::string &ipopt_option_name, AmplOptionsList::AmplOptionType type, const std::string &description)
	Adding a new AMPL Option.
Index	NumberOfAmplOptions ()
	Number of AMPL Options.
void *	Keywords (const SmartPtr< OptionsList > &options, SmartPtr< const Journalist > jnlst, void **nerror)
	ASL keywords list for the stored options.
Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()
virtual	~ReferencedObject ()
Index	ReferenceCount () const
void	AddRef (const Referencer *referencer) const
void	ReleaseRef (const Referencer *referencer) const

Private Member Functions
void	MakeValidLatexString (std::string source, std::string &dest) const
void	PrintLatex (SmartPtr< const Journalist > jnlst)
void	PrintDoxygen (SmartPtr< const Journalist > jnlst)
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	AmplOptionsList (const AmplOptionsList &)
	Default Constructor.
void	operator= (const AmplOptionsList &)
	Default Assignment Operator.

Private Attributes
std::map< std::string, SmartPtr< const AmplOption > >	ampl_options_map_
	map for storing registered AMPL options
void *	keywds_
	pointer to the keywords
Index	nkeywds_
	Number of entries stored in keywds_.

Detailed Description

Class for storing a number of AMPL options that should be registered to the AMPL Solver library interface.

Definition at line 126 of file AmplTNLP.hpp.

Member Enumeration Documentation

AmplOptionType

enum Ipopt::AmplOptionsList::AmplOptionType

Enumerator
String_Option
Number_Option
Integer_Option
WS_Option	this is for AMPL's internal wantsol callback
HaltOnError_Option	this is for our setting of the nerror_ member

Definition at line 129 of file AmplTNLP.hpp.

Constructor & Destructor Documentation

AmplOptionsList() [1/2]

Ipopt::AmplOptionsList::AmplOptionsList ( )

inline

Default Constructor.

Definition at line 232 of file AmplTNLP.hpp.

~AmplOptionsList()

Ipopt::AmplOptionsList::~AmplOptionsList

(

)

Destructor.

AmplOptionsList() [2/2]

Ipopt::AmplOptionsList::AmplOptionsList ( const AmplOptionsList &  )

private

Default Constructor.

Copy Constructor

Member Function Documentation

AddAmplOption()

void Ipopt::AmplOptionsList::AddAmplOption ( const std::string &  ampl_option_name, const std::string &  ipopt_option_name, AmplOptionsList::AmplOptionType  type, const std::string &  description  )

inline

Adding a new AMPL Option.

Definition at line 241 of file AmplTNLP.hpp.

NumberOfAmplOptions()

Index Ipopt::AmplOptionsList::NumberOfAmplOptions ( )

inline

Number of AMPL Options.

Definition at line 253 of file AmplTNLP.hpp.

Keywords()

void * Ipopt::AmplOptionsList::Keywords	(	const SmartPtr< OptionsList > &	options,
		SmartPtr< const Journalist >	jnlst,
		void **	nerror
	)

ASL keywords list for the stored options.

operator=()

void Ipopt::AmplOptionsList::operator= ( const AmplOptionsList &  )

private

Default Assignment Operator.

MakeValidLatexString()

void Ipopt::AmplOptionsList::MakeValidLatexString ( std::string  source, std::string &  dest  ) const

private

PrintLatex()

void Ipopt::AmplOptionsList::PrintLatex ( SmartPtr< const Journalist >  jnlst )

private

PrintDoxygen()

void Ipopt::AmplOptionsList::PrintDoxygen ( SmartPtr< const Journalist >  jnlst )

private

Member Data Documentation

ampl_options_map_

std::map<std::string, SmartPtr<const AmplOption> > Ipopt::AmplOptionsList::ampl_options_map_

private

map for storing registered AMPL options

Definition at line 303 of file AmplTNLP.hpp.

keywds_

void* Ipopt::AmplOptionsList::keywds_

private

pointer to the keywords

Definition at line 309 of file AmplTNLP.hpp.

nkeywds_

Index Ipopt::AmplOptionsList::nkeywds_

private

Number of entries stored in keywds_.

Definition at line 312 of file AmplTNLP.hpp.

---

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

• src/Apps/AmplSolver/AmplTNLP.hpp