- Procedure GMP::Solution::SendToModelSelection(GMP, solution, Identifiers, Suffices)¶
GMP::Solution::SendToModelSelection¶
The procedure GMP::Solution::SendToModelSelection initializes a part
of the model identifiers with the values in the solution from the
solution repository of a generated mathematical program.
GMP::Solution::SendToModelSelection(
GMP, ! (input) a generated mathematical program
solution, ! (input) a solution
Identifiers, ! (input) a set expression
Suffices, ! (input) a set expression
[merge], ! (optional, default 0) a scalar value
[evalInline] ! (optional, default 1) a scalar binary value
)
Arguments¶
- GMP
An element in
AllGeneratedMathematicalPrograms.- solution
An integer scalar reference to a solution.
- Identifiers
A subset of the predefined set
AllVariablesConstraints, containing the set of all variables and constraints for which the values have to be changed into those of solution.- Suffices
A subset of the predefined set
AllSuffixNames, containing the set of suffixes for which the values of Identifiers have to be changed into those of solution.- merge
A scalar value to indicate whether the values of the variables and constraints in the math program should be replaced by (value 0) or merged with (value 1 or 2) the solution.
- evalInline
A scalar binary value to indicate whether the level values of inline variables (if any) in the mathematical program should be evaluated (value 1) or not (value 0).
Return Value¶
The procedure returns 1 on success, or 0 otherwise.
Note
If the subset Identifiers contains a variable or constraint that is not part of the generated mathematical program, then that variable or constaint will be ingnored and its data will not change.
If the subset Suffices contains a suffix other than ‘Level’, ‘Basic’, ‘ReducedCost’, ‘ShadowPrice’, ‘SmallestCoefficient’, ‘NominalCoefficient’, ‘LargestCoefficient’, ‘SmallestValue’, ‘LargestValue’, ‘SmallestRightHandSide’, ‘NominalRightHandSide’, ‘LargestRightHandSide’, ‘SmallestShadowPrice’ and ‘LargestShadowPrice’, then that suffix will be ingnored and its data will not change.
A solution vector in the solution repository only contains solution data for the generated columns and rows of the GMP. Hence, no solution data is stored in the solution repository for columns and rows that were not generated.
By default the values of the variables in the Variables set of the mathematical program will be emptied for all index tuples before sending the solution values to the variables. If the argument merge is set to 1 or 2 then only values of columns (i.e., individual variables) present in the GMP will be replaced. (The same holds for the constraints.) Note that setting merge to 1 or 2 has no impact on scalar variables (and constraints).
The difference between values 1 and 2 for argument merge only affects the objective variable. With value 1 the level value of the objective variable will be increased by the level value for the corresponding column in the solution. With value 2 the level value of the objective variable will be replaced by the level value for the corresponding column in the solution.
With the argument merge set to 1, if the level value of the objective variable equals NA, or if the level value for the corresponding column in the solution equals NA, then the level value of the objective variable will remain or be set to NA.