# Ipopt::AmplSuffixHandler Class Reference

`#include <AmplTNLP.hpp>`

Inheritance diagram for Ipopt::AmplSuffixHandler:
[legend]

List of all members.

## 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 Index * | GetIntegerSuffixValues (std::string suffix_string, Suffix_Source source) const
const Number * | GetNumberSuffixValues (std::string suffix_string, Suffix_Source source) const
std::vector< Index > | GetIntegerSuffixValues (Index n, std::string suffix_string, Suffix_Source source) const
std::vector< Number > | GetNumberSuffixValues (Index n, std::string suffix_string, Suffix_Source source) 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 &)
| Overloaded Equals 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 27 of file AmplTNLP.hpp.

## Member Enumeration Documentation

enum Ipopt::AmplSuffixHandler::Suffix_Type

Enumerator:

  Index_Type |
  Number_Type |

Definition at line 34 of file AmplTNLP.hpp.

enum Ipopt::AmplSuffixHandler::Suffix_Source

Enumerator:

  Variable_Source |
  Constraint_Source |
  Objective_Source |
  Problem_Source |

Definition at line 40 of file AmplTNLP.hpp.

## Constructor & Destructor Documentation

Ipopt::AmplSuffixHandler::AmplSuffixHandler | ( |  | ) |

Ipopt::AmplSuffixHandler::~AmplSuffixHandler | ( |  | ) |

Ipopt::AmplSuffixHandler::AmplSuffixHandler | ( | const AmplSuffixHandler & |  | ) | `[private]`

Default Constructor.

Copy Constructor

## Member Function Documentation

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

Definition at line 48 of file AmplTNLP.hpp.

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

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

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

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

void Ipopt::AmplSuffixHandler::operator= | ( | const AmplSuffixHandler & |  | ) | `[private]`

Overloaded Equals Operator.

void Ipopt::AmplSuffixHandler::PrepareAmplForSuffixes | ( | ASL_pfgh * | asl | ) | `[private]`

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

## Friends And Related Function Documentation

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_pfgh* Ipopt::AmplSuffixHandler::asl_`[mutable, private]`

Definition at line 83 of file AmplTNLP.hpp.

SufDecl* Ipopt::AmplSuffixHandler::suftab_`[private]`

Definition at line 85 of file AmplTNLP.hpp.

std::vector<std::string> Ipopt::AmplSuffixHandler::suffix_ids_`[private]`

Definition at line 87 of file AmplTNLP.hpp.

std::vector<Suffix_Type> Ipopt::AmplSuffixHandler::suffix_types_`[private]`

Definition at line 88 of file AmplTNLP.hpp.

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:

- src/Apps/AmplSolver/AmplTNLP.hpp

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines