Ipopt  3.11.9
Public Types | Public Member Functions | List of all members
Ipopt::AmplSuffixHandler Class Reference

#include <AmplTNLP.hpp>

+ Inheritance diagram for Ipopt::AmplSuffixHandler:

Public Types

enum  Suffix_Type { Index_Type , Number_Type }
 
enum  Suffix_Source { Variable_Source , Constraint_Source , Objective_Source , Problem_Source }
 

Public Member Functions

 AmplSuffixHandler ()
 
 ~AmplSuffixHandler ()
 
void AddAvailableSuffix (std::string suffix_string, Suffix_Source source, Suffix_Type type)
 
const IndexGetIntegerSuffixValues (std::string suffix_string, Suffix_Source source) const
 
const NumberGetNumberSuffixValues (std::string suffix_string, Suffix_Source source) const
 
std::vector< IndexGetIntegerSuffixValues (Index n, std::string suffix_string, Suffix_Source source) const
 
std::vector< NumberGetNumberSuffixValues (Index n, std::string suffix_string, Suffix_Source source) const
 
- 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
 

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.

ASL_pfgh * asl_
 
SufDecl * suftab_
 
std::vector< std::string > suffix_ids_
 
std::vector< Suffix_Typesuffix_types_
 
std::vector< Suffix_Sourcesuffix_sources_
 
class AmplTNLP
 Method called by AmplTNLP to retrieve the suffixes from asl. More...
 
 AmplSuffixHandler (const AmplSuffixHandler &)
 Default Constructor. More...
 
void operator= (const AmplSuffixHandler &)
 Overloaded Equals Operator. More...
 
void PrepareAmplForSuffixes (ASL_pfgh *asl)
 Method called by AmplTNLP to prepare the asl for the suffixes. More...
 

Detailed Description

Definition at line 27 of file AmplTNLP.hpp.

Member Enumeration Documentation

◆ Suffix_Type

Enumerator
Index_Type 
Number_Type 

Definition at line 34 of file AmplTNLP.hpp.

◆ Suffix_Source

Enumerator
Variable_Source 
Constraint_Source 
Objective_Source 
Problem_Source 

Definition at line 40 of file AmplTNLP.hpp.

Constructor & Destructor Documentation

◆ AmplSuffixHandler() [1/2]

Ipopt::AmplSuffixHandler::AmplSuffixHandler ( )

◆ ~AmplSuffixHandler()

Ipopt::AmplSuffixHandler::~AmplSuffixHandler ( )

◆ AmplSuffixHandler() [2/2]

Ipopt::AmplSuffixHandler::AmplSuffixHandler ( const AmplSuffixHandler )
private

Default Constructor.

Copy Constructor

Member Function Documentation

◆ AddAvailableSuffix()

void Ipopt::AmplSuffixHandler::AddAvailableSuffix ( std::string  suffix_string,
Suffix_Source  source,
Suffix_Type  type 
)
inline

Definition at line 48 of file AmplTNLP.hpp.

◆ GetIntegerSuffixValues() [1/2]

const Index* Ipopt::AmplSuffixHandler::GetIntegerSuffixValues ( std::string  suffix_string,
Suffix_Source  source 
) const

◆ GetNumberSuffixValues() [1/2]

const Number* Ipopt::AmplSuffixHandler::GetNumberSuffixValues ( std::string  suffix_string,
Suffix_Source  source 
) const

◆ GetIntegerSuffixValues() [2/2]

std::vector<Index> Ipopt::AmplSuffixHandler::GetIntegerSuffixValues ( Index  n,
std::string  suffix_string,
Suffix_Source  source 
) const

◆ GetNumberSuffixValues() [2/2]

std::vector<Number> Ipopt::AmplSuffixHandler::GetNumberSuffixValues ( Index  n,
std::string  suffix_string,
Suffix_Source  source 
) const

◆ operator=()

void Ipopt::AmplSuffixHandler::operator= ( const AmplSuffixHandler )
private

Overloaded Equals Operator.

◆ PrepareAmplForSuffixes()

void Ipopt::AmplSuffixHandler::PrepareAmplForSuffixes ( ASL_pfgh *  asl)
private

Method called by AmplTNLP to prepare the asl for the suffixes.

Friends And Related Function Documentation

◆ AmplTNLP

friend class AmplTNLP
friend

Method called by AmplTNLP to retrieve the suffixes from asl.

Definition at line 97 of file AmplTNLP.hpp.

Member Data Documentation

◆ asl_

ASL_pfgh* Ipopt::AmplSuffixHandler::asl_
mutableprivate

Definition at line 83 of file AmplTNLP.hpp.

◆ suftab_

SufDecl* Ipopt::AmplSuffixHandler::suftab_
private

Definition at line 85 of file AmplTNLP.hpp.

◆ suffix_ids_

std::vector<std::string> Ipopt::AmplSuffixHandler::suffix_ids_
private

Definition at line 87 of file AmplTNLP.hpp.

◆ suffix_types_

std::vector<Suffix_Type> Ipopt::AmplSuffixHandler::suffix_types_
private

Definition at line 88 of file AmplTNLP.hpp.

◆ suffix_sources_

std::vector<Suffix_Source> Ipopt::AmplSuffixHandler::suffix_sources_
private

Definition at line 89 of file AmplTNLP.hpp.


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