Procedure GMP::Column::Freeze(GMP, column, value)

GMP::Column::Freeze

The procedure GMP::Column::Freeze freezes a column in a generated mathematical program at the given value.

GMP::Column::Freeze(
     GMP,            ! (input) a generated mathematical program
     column,         ! (input) a scalar reference or column number
     value           ! (input) a numerical expression
     )

Arguments

GMP

An element in AllGeneratedMathematicalPrograms.

column

A scalar reference to an existing column in the matrix or an element in the set Integers in the range \(\{ 0 .. n-1 \}\) where \(n\) is the number of columns in the matrix.

value

The new value that should be used to freeze the column value.

Return Value

The procedure returns 1 on success, and 0 otherwise.

Note

  • Use GMP::Column::FreezeMulti or GMP::Column::FreezeRaw if many columns have to be frozen, because that will be more efficient.

  • The column remains visible in the constraint listing and math program inspector. In addition, it will be retained in solver maintained copies of the generated math program.

  • Use GMP::Column::Unfreeze to undo the freezing.

  • During a call to procedure GMP::Column::Freeze AIMMS stores the upper and lower bound of the column before the procedure was called. This information is used when procedure GMP::Column::Unfreeze is called thereafter. This information is not copied by the function GMP::Instance::Copy.

See also