Function GMP::Instance::GetOptionValue(GMP, OptionName)

GMP::Instance::GetOptionValue

The function GMP::Instance::GetOptionValue returns the value of a solver specific option corresponding to a generated mathematical program as set with the procedure GMP::Instance::SetOptionValue.

This procedure can also be used to retrieve the current option value of certain Solvers General options (see below).

GMP::Instance::GetOptionValue(
     GMP,            ! (input) a generated mathematical program
     OptionName      ! (input) a scalar string expression
     )

Arguments

GMP

An element in AllGeneratedMathematicalPrograms.

OptionName

A string expression holding the name of the option.

Return Value

In case of success, the function returns the current option value. Otherwise it returns UNDF.

Note

• If the procedure GMP::Instance::SetOptionValue has not been called then this function will fail and return UNDF (unless the option is a Solvers General option).

• Options for which strings are displayed in the AIMMS Options dialog box, are also represented by numerical (integer) values. To obtain the corresponding option keywords, you can use the functions OptionGetString and OptionGetKeywords.

• This function can also be used to retrieve the current option value of the following Solvers General options:

  • Cutoff

  • Iteration Limit

  • Maximal Number of Domain Errors

  • Maximal Number of Integer Solutions

  • MIP Absolute Optimality Tolerance

  • MIP Relative Optimality Tolerance

  • Solver Workspace

  • Time Limit

See also

• The routines GMP::Instance::SetOptionValue, GMP::SolverSession::GetOptionValue, GMP::SolverSession::SetOptionValue, OptionGetString and OptionGetKeywords.