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 (const std::string &suffix_string, Suffix_Source source, Suffix_Type type)
const int *	GetIntegerSuffixValues (const std::string &suffix_string, Suffix_Source source) const
const Number *	GetNumberSuffixValues (const std::string &suffix_string, Suffix_Source source) const
std::vector< int >	GetIntegerSuffixValues (Index n, const std::string &suffix_string, Suffix_Source source) const
std::vector< Number >	GetNumberSuffixValues (Index n, const 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

Private Member Functions
void	PrepareAmplForSuffixes (ASL_pfgh *asl)
	Method called by AmplTNLP to prepare the asl for the suffixes.
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.
	AmplSuffixHandler (const AmplSuffixHandler &)
	Default Constructor.
void	operator= (const AmplSuffixHandler &)
	Default Assignment Operator.

Private Attributes
ASL_pfgh *	asl_
SufDecl *	suftab_
std::vector< std::string >	suffix_ids_
std::vector< Suffix_Type >	suffix_types_
std::vector< Suffix_Source >	suffix_sources_

Friends
class	AmplTNLP
	Method called by AmplTNLP to retrieve the suffixes from asl.

Detailed Description

Definition at line 26 of file AmplTNLP.hpp.

Member Enumeration Documentation

Suffix_Type

enum Ipopt::AmplSuffixHandler::Suffix_Type

Enumerator
Index_Type
Number_Type

Definition at line 33 of file AmplTNLP.hpp.

Suffix_Source

enum Ipopt::AmplSuffixHandler::Suffix_Source

Enumerator
Variable_Source
Constraint_Source
Objective_Source
Problem_Source

Definition at line 39 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 ( const std::string &  suffix_string, Suffix_Source  source, Suffix_Type  type  )

inline

Definition at line 47 of file AmplTNLP.hpp.

GetIntegerSuffixValues() [1/2]

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

GetNumberSuffixValues() [1/2]

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

GetIntegerSuffixValues() [2/2]

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

GetNumberSuffixValues() [2/2]

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

operator=()

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

private

Default Assignment Operator.

PrepareAmplForSuffixes()

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

private

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

Friends And Related Symbol Documentation

AmplTNLP

friend class AmplTNLP

friend

Method called by AmplTNLP to retrieve the suffixes from asl.

Definition at line 120 of file AmplTNLP.hpp.

Member Data Documentation

asl_

ASL_pfgh* Ipopt::AmplSuffixHandler::asl_

mutableprivate

Definition at line 105 of file AmplTNLP.hpp.

suftab_

SufDecl* Ipopt::AmplSuffixHandler::suftab_

private

Definition at line 107 of file AmplTNLP.hpp.

suffix_ids_

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

private

Definition at line 109 of file AmplTNLP.hpp.

suffix_types_

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

private

Definition at line 110 of file AmplTNLP.hpp.

suffix_sources_

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

private

Definition at line 111 of file AmplTNLP.hpp.

---

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

• src/Apps/AmplSolver/AmplTNLP.hpp