Function GMP::Row::GetRelaxationOnly(GMP, row)

GMP::Row::GetRelaxationOnly

The function GMP::Row::GetRelaxationOnly returns 1 for a row in a generated mathematical program if it has been marked as being a relaxation-only row; otherwise it returns 0.

GMP::Row::GetRelaxationOnly(
     GMP,            ! (input) a generated mathematical program
     row             ! (input) a scalar reference or row number
     )

Arguments

GMP

An element in AllGeneratedMathematicalPrograms.

row

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

Return Value

The function returns 1 if the row is a relaxation-only row, and 0 otherwise.

Note

A row is marked as being a relaxation-only row if the procedure GMP::Row::SetRelaxationOnly has been called before or if the RelaxationOnly suffix has been set to 1 for the corresponding constraint.

See also

The procedure GMP::Row::SetRelaxationOnly. The RelaxationOnly suffix is explained in full detail in Constraint Suffices for Global Optimization of the Language Reference.