Initializing help system before first use

# getbasis

Purpose
Returns the current basis into the user's data arrays.
Synopsis
`getbasis(prob, rowstat = TRUE, colstat = TRUE)`
Arguments

prob | The current problem.
rowstat | Flag to indicate whether the output list should contain rowstat.
colstat | Flag to indicate whether the output list should contain colstat.

Return value
A list with the following elements:

rowstat
  Integer array of length ORIGINALROWS containing the basis status of the slack, surplus or artificial variable associated with each row. The status will be one of:
  _BASISSTATUS_NONBASIC_LOWER (0)
    slack, surplus or artificial is non-basic at lower bound;
  _BASISSTATUS_BASIC (1)
    slack, surplus or artificial is basic;
  _BASISSTATUS_NONBASIC_UPPER (2)
    slack or surplus is non-basic at upper bound.
  _BASISSTATUS_SUPERBASIC (3)
    slack or surplus is super-basic.
colstat
  Integer array of length ORIGINALCOLS containing the basis status of the columns in the constraint matrix. The status will be one of:
  _BASISSTATUS_NONBASIC_LOWER (0)
    variable is non-basic at lower bound, or superbasic at zero if the variable has no lower bound;
  _BASISSTATUS_BASIC (1)
    variable is basic;
  _BASISSTATUS_NONBASIC_UPPER (2)
    variable is non-basic at upper bound;
  _BASISSTATUS_SUPERBASIC (3)
    variable is super-basic.

Parent Topic R interface reference manual

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.