gams::GAMSEquation Class Reference

#include <gamsequation.h>

Inheritance diagram for gams::GAMSEquation:
gams::GAMSSymbol

Public Member Functions

 GAMSEquation ()
 Standard constructor. More...
 
 GAMSEquation (const GAMSSymbol &other)
 
 ~GAMSEquation ()
 Destructor. More...
 
GAMSSymbolIter< GAMSEquationbegin ()
 
GAMSSymbolIter< GAMSEquationend ()
 
GAMSEquationoperator= (const GAMSEquation &other)
 
GAMSEquationRecord firstRecord (const std::vector< std::string > &slice)
 
GAMSEquationRecord firstRecord ()
 
GAMSEquationRecord firstRecord (const std::string &key1)
 
GAMSEquationRecord firstRecord (const std::string &key1, const std::string &key2)
 
GAMSEquationRecord firstRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSEquationRecord lastRecord (const std::vector< std::string > &slice)
 
GAMSEquationRecord lastRecord ()
 
GAMSEquationRecord lastRecord (const std::string &key1)
 
GAMSEquationRecord lastRecord (const std::string &key1, const std::string &key2)
 
GAMSEquationRecord lastRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSEquationRecord addRecord (const std::vector< std::string > &keys)
 
GAMSEquationRecord addRecord ()
 
GAMSEquationRecord addRecord (const std::string &key1)
 
GAMSEquationRecord addRecord (const std::string &key1, const std::string &key2)
 
GAMSEquationRecord addRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSEquationRecord findRecord (const std::vector< std::string > &keys)
 
GAMSEquationRecord findRecord ()
 
GAMSEquationRecord findRecord (const std::string &key1)
 
GAMSEquationRecord findRecord (const std::string &key1, const std::string &key2)
 
GAMSEquationRecord findRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSEquationRecord mergeRecord (const std::vector< std::string > &keys)
 
GAMSEquationRecord mergeRecord ()
 
GAMSEquationRecord mergeRecord (const std::string &key1)
 
GAMSEquationRecord mergeRecord (const std::string &key1, const std::string &key2)
 
GAMSEquationRecord mergeRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSEnum::EquType equType ()
 Retrieve subtype of Equation (E: Equal, G: Greater, L: Less, N: No specification, X: External defined, C: Conic). More...
 
- Public Member Functions inherited from gams::GAMSSymbol
 GAMSSymbol ()
 Standard constructor. More...
 
 GAMSSymbol (const GAMSSymbol &symbol)
 
virtual ~GAMSSymbol ()
 Destructor. More...
 
GAMSSymbol operator= (const GAMSSymbol &other)
 
bool operator!= (const GAMSSymbol &other) const
 
bool operator== (const GAMSSymbol &other) const
 
bool isValid () const
 
GAMSSymbolIter< GAMSSymbolbegin ()
 
GAMSSymbolIter< GAMSSymbolend ()
 
GAMSSymbolRecord addRecord (const std::vector< std::string > &keys)
 
GAMSSymbolRecord addRecord ()
 
GAMSSymbolRecord addRecord (const std::string &key1)
 
GAMSSymbolRecord addRecord (const std::string &key1, const std::string &key2)
 
GAMSSymbolRecord addRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
void deleteRecord (const std::vector< std::string > &keys)
 
bool clear ()
 
std::vector< GAMSDomaindomains ()
 
bool checkDomains ()
 
std::vector< GAMSSymbolDomainViolationgetSymbolDVs (int maxViol=0)
 
GAMSSymbolRecord firstRecord (const std::vector< std::string > &slice)
 
GAMSSymbolRecord firstRecord ()
 
GAMSSymbolRecord firstRecord (const std::string &key1)
 
GAMSSymbolRecord firstRecord (const std::string &key1, const std::string &key2)
 
GAMSSymbolRecord firstRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSSymbolRecord lastRecord (const std::vector< std::string > &slice)
 
GAMSSymbolRecord lastRecord ()
 
GAMSSymbolRecord lastRecord (const std::string &key1)
 
GAMSSymbolRecord lastRecord (const std::string &key1, const std::string &key2)
 
GAMSSymbolRecord lastRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSSymbolRecord findRecord (const std::vector< std::string > &keys)
 
GAMSSymbolRecord findRecord ()
 
GAMSSymbolRecord findRecord (const std::string &key1)
 
GAMSSymbolRecord findRecord (const std::string &key1, const std::string &key2)
 
GAMSSymbolRecord findRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
GAMSSymbolRecord mergeRecord (const std::vector< std::string > &keys)
 
GAMSSymbolRecord mergeRecord ()
 
GAMSSymbolRecord mergeRecord (const std::string &key1)
 
GAMSSymbolRecord mergeRecord (const std::string &key1, const std::string &key2)
 
GAMSSymbolRecord mergeRecord (const std::string &key1, const std::string &key2, const std::string &key3)
 
void copySymbol (const GAMSSymbol &target)
 
gams::GAMSDatabasedatabase () const
 Get GAMSDatabase containing the GAMSSymbol. More...
 
std::string text () const
 Get explanatory text of GAMSSymbol. More...
 
std::string & name () const
 Get GAMSSymbol name. More...
 
int dim () const
 Get GAMSSymbol dimension. More...
 
int numberRecords () const
 Retrieve the number of records of the GAMSSymbol. More...
 
LogId logID ()
 
GAMSEnum::SymbolType type () const
 Get the symbol type. More...
 

Detailed Description

This is the representation of an equation symbol in GAMS. It exists in a GAMSDatabase and contains GAMSEquationRecords which one can iterate through.

Definition at line 36 of file gamsequation.h.

Constructor & Destructor Documentation

◆ GAMSEquation() [1/2]

gams::GAMSEquation::GAMSEquation ( )
inline

Standard constructor.

Definition at line 43 of file gamsequation.h.

◆ GAMSEquation() [2/2]

gams::GAMSEquation::GAMSEquation ( const GAMSSymbol other)

Constructor

Parameters
otherA GAMSSymbol used as data source.

◆ ~GAMSEquation()

gams::GAMSEquation::~GAMSEquation ( )

Destructor.

Member Function Documentation

◆ addRecord() [1/5]

GAMSEquationRecord gams::GAMSEquation::addRecord ( const std::vector< std::string > &  keys)

Add record to GAMSEquation.

Parameters
keysVector of keys.
Returns
Instance of GAMSEquationRecord.

◆ addRecord() [2/5]

GAMSEquationRecord gams::GAMSEquation::addRecord ( )

Add record to GAMSEquation.

Returns
Instance of GAMSEquationRecord.

◆ addRecord() [3/5]

GAMSEquationRecord gams::GAMSEquation::addRecord ( const std::string &  key1)

Add record to GAMSEquation.

Parameters
key1Key for first index position.
Returns
Instance of GAMSEquationRecord.

◆ addRecord() [4/5]

GAMSEquationRecord gams::GAMSEquation::addRecord ( const std::string &  key1,
const std::string &  key2 
)

Add record to GAMSEquation.

Parameters
key1Key for first index position.
key2Key for second index position.
Returns
Instance of GAMSEquationRecord.

◆ addRecord() [5/5]

GAMSEquationRecord gams::GAMSEquation::addRecord ( const std::string &  key1,
const std::string &  key2,
const std::string &  key3 
)

Add record to GAMSEquation.

Parameters
key1Key for first index position.
key2Key for second index position.
key3Key for third index position.
Returns
Instance of GAMSEquationRecord.

◆ begin()

GAMSSymbolIter<GAMSEquation> gams::GAMSEquation::begin ( )

Interator to the begining.

Returns
Iterator to the first GAMSEquation.

◆ end()

GAMSSymbolIter<GAMSEquation> gams::GAMSEquation::end ( )

Iterator to end.

Returns
Iterator to the element following the last GAMSEquation.

◆ equType()

GAMSEnum::EquType gams::GAMSEquation::equType ( )

Retrieve subtype of Equation (E: Equal, G: Greater, L: Less, N: No specification, X: External defined, C: Conic).

◆ findRecord() [1/5]

GAMSEquationRecord gams::GAMSEquation::findRecord ( const std::vector< std::string > &  keys)

Find record in GAMSEquation.

Parameters
keysVector of keys.
Returns
Instance of GAMSEquationRecord.

◆ findRecord() [2/5]

GAMSEquationRecord gams::GAMSEquation::findRecord ( )

Find record in GAMSEquation.

Returns
Instance of GAMSEquationRecord.

◆ findRecord() [3/5]

GAMSEquationRecord gams::GAMSEquation::findRecord ( const std::string &  key1)

Find record in GAMSEquation.

Parameters
key1Key for first index position.
Returns
Instance of GAMSEquationRecord.

◆ findRecord() [4/5]

GAMSEquationRecord gams::GAMSEquation::findRecord ( const std::string &  key1,
const std::string &  key2 
)

Find record in GAMSEquation.

Parameters
key1Key for first index position.
key2key for second index position.
Returns
Instance of GAMSEquationRecord.

◆ findRecord() [5/5]

GAMSEquationRecord gams::GAMSEquation::findRecord ( const std::string &  key1,
const std::string &  key2,
const std::string &  key3 
)

Find record in GAMSEquation.

Parameters
key1Key for first index position.
key2Key for second index position.
key3Key for third index position.
Returns
Instance of GAMSEquationRecord.

◆ firstRecord() [1/5]

GAMSEquationRecord gams::GAMSEquation::firstRecord ( const std::vector< std::string > &  slice)

Retrieve the first record in GAMSEquation that meets the slice criteria.

Parameters
sliceDefine filter for elements whose record should be retrieved.
Returns
Instance of GAMSEquationRecord.

◆ firstRecord() [2/5]

GAMSEquationRecord gams::GAMSEquation::firstRecord ( )

Retrieve first record in GAMSEquation.

Returns
Instance of GAMSEquationRecord.

◆ firstRecord() [3/5]

GAMSEquationRecord gams::GAMSEquation::firstRecord ( const std::string &  key1)

Retrieve first record in GAMSEquation that meets the slice criteria.

Parameters
key1Slicing criteria for first index position.
Returns
Instance of GAMSEquationRecord.

◆ firstRecord() [4/5]

GAMSEquationRecord gams::GAMSEquation::firstRecord ( const std::string &  key1,
const std::string &  key2 
)

Retrieve first record in GAMSEquation that meets the slice criteria.

Parameters
key1Slicing criteria for first index position.
key2Slicing criteria for second index position.
Returns
Instance of GAMSEquationRecord.

◆ firstRecord() [5/5]

GAMSEquationRecord gams::GAMSEquation::firstRecord ( const std::string &  key1,
const std::string &  key2,
const std::string &  key3 
)

Retrieve first record in GAMSEquation that meets the slice criteria.

Parameters
key1Slicing criteria for first index position.
key2Slicing criteria for second index position.
key3Slicing criteria for third index position.
Returns
Instance of GAMSEquationRecord.

◆ lastRecord() [1/5]

GAMSEquationRecord gams::GAMSEquation::lastRecord ( const std::vector< std::string > &  slice)

Retrieve a slice of the last record in GAMSEquation.

Parameters
sliceDefine filter for elements whose record should be retrieved.
Returns
Instance of GAMSEquationRecord.

◆ lastRecord() [2/5]

GAMSEquationRecord gams::GAMSEquation::lastRecord ( )

Retrieve last record in GAMSEquation.

Returns
Instance of GAMSEquationRecord.

◆ lastRecord() [3/5]

GAMSEquationRecord gams::GAMSEquation::lastRecord ( const std::string &  key1)

Retrieve last record in GAMSEquation.

Parameters
key1Slicing criteria for first index position.
Returns
Instance of GAMSEquationRecord.

◆ lastRecord() [4/5]

GAMSEquationRecord gams::GAMSEquation::lastRecord ( const std::string &  key1,
const std::string &  key2 
)

Retrieve last record in GAMSEquation.

Parameters
key1Slicing criteria for first index position.
key2Slicing criteria for second index position.
Returns
Instance of GAMSEquationRecord.

◆ lastRecord() [5/5]

GAMSEquationRecord gams::GAMSEquation::lastRecord ( const std::string &  key1,
const std::string &  key2,
const std::string &  key3 
)

Retrieve last record in GAMSEquation.

Parameters
key1Slicing criteria for first index position.
key2Slicing criteria for second index position.
key3Slicing criteria for third index position.
Returns
Instance of GAMSEquationRecord.

◆ mergeRecord() [1/5]

GAMSEquationRecord gams::GAMSEquation::mergeRecord ( const std::vector< std::string > &  keys)

Finds record in GAMSEquation if it exists; otherwise add it.

Parameters
keysList of keys.
Returns
Instance of found or added GAMSEquationRecord.

◆ mergeRecord() [2/5]

GAMSEquationRecord gams::GAMSEquation::mergeRecord ( )

Finds record in GAMSEquation if it exists, adds it if not

Returns
Instance of found or added GAMSEquationRecord.

◆ mergeRecord() [3/5]

GAMSEquationRecord gams::GAMSEquation::mergeRecord ( const std::string &  key1)

Finds record in GAMSEquation if it exists; otherwise add it.

Parameters
key1Key for first index position.
Returns
Instance of found or added GAMSEquationRecord.

◆ mergeRecord() [4/5]

GAMSEquationRecord gams::GAMSEquation::mergeRecord ( const std::string &  key1,
const std::string &  key2 
)

Finds record in GAMSEquation if it exists; otherwise add it.

Parameters
key1Key for first index position.
key2key for second index position.
Returns
Instance of found or added GAMSEquationRecord.

◆ mergeRecord() [5/5]

GAMSEquationRecord gams::GAMSEquation::mergeRecord ( const std::string &  key1,
const std::string &  key2,
const std::string &  key3 
)

Finds record in GAMSEquation if it exists; otherwise add it.

Parameters
key1Key for first index position.
key2Key for second index position.
key3Key for third index position.
Returns
Instance of found or added GAMSEquationRecord

◆ operator=()

GAMSEquation& gams::GAMSEquation::operator= ( const GAMSEquation other)

Assigns a GAMSEquation.

Parameters
otherAnother GAMSEquation used as data source.
Returns
Returns the assigned GAMSCheckpoint (*this).