Function GMP::Column::GetStatus(GMP, column)

GMP::Column::GetStatus

The function GMP::Column::GetStatus returns the status of a column in the matrix of a generated mathematical program.

GMP::Column::GetStatus(
     GMP,            ! (input) a generated mathematical program
     column          ! (input) a scalar reference or column number
     )

Arguments

GMP

An element in AllGeneratedMathematicalPrograms.

column

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

Return Value

An element in the predefined set AllRowColumnStatuses. The set AllRowColumnStatuses contains the following elements:

  • Active,

  • Deactivated,

  • Deleted,

  • NotGenerated,

  • PresolveDeleted.

Note

  • This function will return ‘PresolveDeleted‘ only if the generated mathematical program has been created with GMP::Instance::CreatePresolved. Status ‘PresolveDeleted‘ means that the column was generated for the original generated mathematical program but deleted when the presolved mathematical program was created.

  • Status ‘Deactivated‘ is not possible for columns.