Ipopt Documentation  
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:


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,

Public Member Functions

 AmplOptionsList ()
 Default Constructor. More...
 ~AmplOptionsList ()
 Destructor. More...
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. More...
Index NumberOfAmplOptions ()
 Number of AMPL Options. More...
void * Keywords (const SmartPtr< OptionsList > &options, SmartPtr< const Journalist > jnlst, void **nerror)
 ASL keywords list for the stored options. More...
- 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. More...
void operator= (const AmplOptionsList &)
 Default Assignment Operator. More...

Private Attributes

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

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


this is for AMPL's internal wantsol callback


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 ( )

Default Constructor.

Definition at line 232 of file AmplTNLP.hpp.

◆ ~AmplOptionsList()

Ipopt::AmplOptionsList::~AmplOptionsList ( )


◆ AmplOptionsList() [2/2]

Ipopt::AmplOptionsList::AmplOptionsList ( const AmplOptionsList )

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 

Adding a new AMPL Option.

Definition at line 241 of file AmplTNLP.hpp.

◆ NumberOfAmplOptions()

Index Ipopt::AmplOptionsList::NumberOfAmplOptions ( )

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 )

Default Assignment Operator.

◆ MakeValidLatexString()

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

◆ PrintLatex()

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

◆ PrintDoxygen()

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

Member Data Documentation

◆ ampl_options_map_

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

map for storing registered AMPL options

Definition at line 303 of file AmplTNLP.hpp.

◆ keywds_

void* Ipopt::AmplOptionsList::keywds_

pointer to the keywords

Definition at line 309 of file AmplTNLP.hpp.

◆ nkeywds_

Index Ipopt::AmplOptionsList::nkeywds_

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: