Detailed Description

LP interface for Gurobi.

Author: Marc Pfetsch; Tobias Achterberg; Michael Winkler

This LPI only works with Gurobi versions >= 7.0.2.

Definition in file lpi_grb.c.

#include <assert.h>
#include <string.h>
#include "gurobi_c.h"
#include "lpi/lpi.h"
#include "scip/pub_message.h"
#include "scip/pub_misc_sort.h"
#include "tinycthread/tinycthread.h"

Go to the source code of this file.

Data Structures
struct	SCIP_LPi
struct	SCIP_LPiState
struct	SCIP_LPiNorms

Macros
#define	SCIP_REUSEENV
#define	CHECK_ZERO(messagehdlr, x)
#define	CHECK_ZERO_STAR(messagehdlr, x)
#define	SVECTOR GRBsvec
#define	SCIP_DUALPACKETSIZE (sizeof(SCIP_DUALPACKET)*4)
#define	COLS_PER_PACKET SCIP_DUALPACKETSIZE
#define	ROWS_PER_PACKET SCIP_DUALPACKETSIZE
#define	GRB_REFACTORMAXITERS 50
#define	NUMINTPARAM 6
#define	NUMDBLPARAM 7

Functions
static SCIP_RETCODE	ensureSidechgMem (SCIP_LPI *lpi, int num)
static SCIP_RETCODE	ensureValMem (SCIP_LPI *lpi, int num)
static SCIP_RETCODE	ensureCstatMem (SCIP_LPI *lpi, int num)
static SCIP_RETCODE	ensureRstatMem (SCIP_LPI *lpi, int num)
static SCIP_RETCODE	ensureRngrowmapMem (SCIP_LPI *lpi, int num)
static SCIP_RETCODE	ensureRngrowsMem (SCIP_LPI *lpi, int num)
static SCIP_RETCODE	getBase (SCIP_LPI lpi, SCIP_Bool success)
static SCIP_RETCODE	setBase (SCIP_LPI *lpi)
static int	colpacketNum (int ncols)
static int	rowpacketNum (int nrows)
static void	SCIPencodeDualBitNeg (const int inp, SCIP_DUALPACKET out, int count)
static void	SCIPdecodeDualBitNeg (const SCIP_DUALPACKET inp, int out, int count)
static void	lpistatePack (SCIP_LPISTATE lpistate, const int cstat, const int *rstat)
static void	lpistateUnpack (const SCIP_LPISTATE lpistate, int cstat, int *rstat)
static SCIP_RETCODE	lpistateCreate (SCIP_LPISTATE *lpistate, BMS_BLKMEM blkmem, int ncols, int nrows, int nrngrows)
static void	lpistateFree (SCIP_LPISTATE *lpistate, BMS_BLKMEM blkmem)
static SCIP_RETCODE	getParameterValues (SCIP_LPI lpi, GRBPARAM grbparam)
static SCIP_RETCODE	checkParameterValues (SCIP_LPI *lpi)
static SCIP_RETCODE	setParameterValues (SCIP_LPI lpi, GRBPARAM grbparam)
static void	copyParameterValues (GRBPARAM dest, const GRBPARAM source)
static SCIP_RETCODE	getIntParam (SCIP_LPI lpi, const char param, int *p)
static SCIP_RETCODE	setIntParam (SCIP_LPI lpi, const char param, int parval)
static SCIP_RETCODE	getDblParam (SCIP_LPI lpi, const char param, double *p)
static SCIP_RETCODE	setDblParam (SCIP_LPI lpi, const char param, double parval)
static void	invalidateSolution (SCIP_LPI *lpi)
static SCIP_RETCODE	convertSides (SCIP_LPI lpi, int nrows, const SCIP_Real lhs, const SCIP_Real rhs, int rngcount)
static SCIP_RETCODE	reconvertSides (SCIP_LPI lpi, int firstrow, int lastrow, SCIP_Real lhs, SCIP_Real *rhs)
static SCIP_RETCODE	restoreLPData (SCIP_LPI *lpi)
static void	checkRangeInfo (SCIP_LPI *lpi)
static SCIP_RETCODE	addRangeVars (SCIP_LPI *lpi)
static SCIP_RETCODE	delRangeVars (SCIP_LPI *lpi)
static void	clearRangeInfo (SCIP_LPI *lpi)
static SCIP_RETCODE	addRangeInfo (SCIP_LPI *lpi, int rngcount, int firstrow)
Miscellaneous Methods
const char *	SCIPlpiGetSolverName (void)
const char *	SCIPlpiGetSolverDesc (void)
void *	SCIPlpiGetSolverPointer (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiSetIntegralityInformation (SCIP_LPI lpi, int ncols, int intInfo)
SCIP_Bool	SCIPlpiHasPrimalSolve (void)
SCIP_Bool	SCIPlpiHasDualSolve (void)
SCIP_Bool	SCIPlpiHasBarrierSolve (void)
LPI Creation and Destruction Methods
SCIP_RETCODE	SCIPlpiCreate (SCIP_LPI *lpi, SCIP_MESSAGEHDLR messagehdlr, const char *name, SCIP_OBJSEN objsen)
SCIP_RETCODE	SCIPlpiFree (SCIP_LPI **lpi)
Modification Methods
SCIP_RETCODE	SCIPlpiLoadColLP (SCIP_LPI lpi, SCIP_OBJSEN objsen, int ncols, const SCIP_Real obj, const SCIP_Real lb, const SCIP_Real ub, char *colnames, int nrows, const SCIP_Real lhs, const SCIP_Real rhs, char rownames, int nnonz, const int beg, const int ind, const SCIP_Real val)
SCIP_RETCODE	SCIPlpiAddCols (SCIP_LPI lpi, int ncols, const SCIP_Real obj, const SCIP_Real lb, const SCIP_Real ub, char *colnames, int nnonz, const int beg, const int ind, const SCIP_Real val)
SCIP_RETCODE	SCIPlpiDelCols (SCIP_LPI *lpi, int firstcol, int lastcol)
SCIP_RETCODE	SCIPlpiDelColset (SCIP_LPI lpi, int dstat)
SCIP_RETCODE	SCIPlpiAddRows (SCIP_LPI lpi, int nrows, const SCIP_Real lhs, const SCIP_Real rhs, char rownames, int nnonz, const int beg, const int ind, const SCIP_Real val)
SCIP_RETCODE	SCIPlpiDelRows (SCIP_LPI *lpi, int firstrow, int lastrow)
SCIP_RETCODE	SCIPlpiDelRowset (SCIP_LPI lpi, int dstat)
SCIP_RETCODE	SCIPlpiClear (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiChgBounds (SCIP_LPI lpi, int ncols, const int ind, const SCIP_Real lb, const SCIP_Real ub)
SCIP_RETCODE	SCIPlpiChgSides (SCIP_LPI lpi, int nrows, const int ind, const SCIP_Real lhs, const SCIP_Real rhs)
SCIP_RETCODE	SCIPlpiChgCoef (SCIP_LPI *lpi, int row, int col, SCIP_Real newval)
SCIP_RETCODE	SCIPlpiChgObjsen (SCIP_LPI *lpi, SCIP_OBJSEN objsen)
SCIP_RETCODE	SCIPlpiChgObj (SCIP_LPI lpi, int ncols, const int ind, const SCIP_Real *obj)
SCIP_RETCODE	SCIPlpiScaleRow (SCIP_LPI *lpi, int row, SCIP_Real scaleval)
SCIP_RETCODE	SCIPlpiScaleCol (SCIP_LPI *lpi, int col, SCIP_Real scaleval)
Data Accessing Methods
SCIP_RETCODE	SCIPlpiGetNRows (SCIP_LPI lpi, int nrows)
SCIP_RETCODE	SCIPlpiGetNCols (SCIP_LPI lpi, int ncols)
SCIP_RETCODE	SCIPlpiGetNNonz (SCIP_LPI lpi, int nnonz)
SCIP_RETCODE	SCIPlpiGetCols (SCIP_LPI lpi, int firstcol, int lastcol, SCIP_Real lb, SCIP_Real ub, int nnonz, int beg, int ind, SCIP_Real *val)
SCIP_RETCODE	SCIPlpiGetRows (SCIP_LPI lpi, int firstrow, int lastrow, SCIP_Real lhs, SCIP_Real rhs, int nnonz, int beg, int ind, SCIP_Real *val)
SCIP_RETCODE	SCIPlpiGetColNames (SCIP_LPI lpi, int firstcol, int lastcol, char colnames, char namestorage, int namestoragesize, int *storageleft)
SCIP_RETCODE	SCIPlpiGetRowNames (SCIP_LPI lpi, int firstrow, int lastrow, char rownames, char namestorage, int namestoragesize, int *storageleft)
SCIP_RETCODE	SCIPlpiGetObjsen (SCIP_LPI lpi, SCIP_OBJSEN objsen)
SCIP_RETCODE	SCIPlpiGetObj (SCIP_LPI lpi, int firstcol, int lastcol, SCIP_Real vals)
SCIP_RETCODE	SCIPlpiGetBounds (SCIP_LPI lpi, int firstcol, int lastcol, SCIP_Real lbs, SCIP_Real *ubs)
SCIP_RETCODE	SCIPlpiGetSides (SCIP_LPI lpi, int firstrow, int lastrow, SCIP_Real lhss, SCIP_Real *rhss)
SCIP_RETCODE	SCIPlpiGetCoef (SCIP_LPI lpi, int row, int col, SCIP_Real val)
Solving Methods
SCIP_RETCODE	SCIPlpiSolvePrimal (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiSolveDual (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiSolveBarrier (SCIP_LPI *lpi, SCIP_Bool crossover)
SCIP_RETCODE	SCIPlpiStartStrongbranch (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiEndStrongbranch (SCIP_LPI *lpi)
static SCIP_RETCODE	lpiStrongbranch (SCIP_LPI lpi, int col, SCIP_Real psol, int itlim, SCIP_Real down, SCIP_Real up, SCIP_Bool downvalid, SCIP_Bool upvalid, int iter)
SCIP_RETCODE	SCIPlpiStrongbranchFrac (SCIP_LPI lpi, int col, SCIP_Real psol, int itlim, SCIP_Real down, SCIP_Real up, SCIP_Bool downvalid, SCIP_Bool upvalid, int iter)
SCIP_RETCODE	SCIPlpiStrongbranchesFrac (SCIP_LPI lpi, int cols, int ncols, SCIP_Real psols, int itlim, SCIP_Real down, SCIP_Real up, SCIP_Bool downvalid, SCIP_Bool upvalid, int iter)
SCIP_RETCODE	SCIPlpiStrongbranchInt (SCIP_LPI lpi, int col, SCIP_Real psol, int itlim, SCIP_Real down, SCIP_Real up, SCIP_Bool downvalid, SCIP_Bool upvalid, int iter)
SCIP_RETCODE	SCIPlpiStrongbranchesInt (SCIP_LPI lpi, int cols, int ncols, SCIP_Real psols, int itlim, SCIP_Real down, SCIP_Real up, SCIP_Bool downvalid, SCIP_Bool upvalid, int iter)
Solution Information Methods
SCIP_Bool	SCIPlpiWasSolved (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiGetSolFeasibility (SCIP_LPI lpi, SCIP_Bool primalfeasible, SCIP_Bool *dualfeasible)
SCIP_Bool	SCIPlpiExistsPrimalRay (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiHasPrimalRay (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsPrimalUnbounded (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsPrimalInfeasible (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsPrimalFeasible (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiExistsDualRay (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiHasDualRay (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsDualUnbounded (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsDualInfeasible (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsDualFeasible (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsOptimal (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsStable (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsObjlimExc (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsIterlimExc (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsTimelimExc (SCIP_LPI *lpi)
int	SCIPlpiGetInternalStatus (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiIgnoreInstability (SCIP_LPI lpi, SCIP_Bool success)
SCIP_RETCODE	SCIPlpiGetObjval (SCIP_LPI lpi, SCIP_Real objval)
SCIP_RETCODE	SCIPlpiGetSol (SCIP_LPI lpi, SCIP_Real objval, SCIP_Real primsol, SCIP_Real dualsol, SCIP_Real activity, SCIP_Real redcost)
SCIP_RETCODE	SCIPlpiGetPrimalRay (SCIP_LPI lpi, SCIP_Real ray)
SCIP_RETCODE	SCIPlpiGetDualfarkas (SCIP_LPI lpi, SCIP_Real dualfarkas)
SCIP_RETCODE	SCIPlpiGetIterations (SCIP_LPI lpi, int iterations)
SCIP_RETCODE	SCIPlpiGetRealSolQuality (SCIP_LPI lpi, SCIP_LPSOLQUALITY qualityindicator, SCIP_Real quality)
LP Basis Methods
SCIP_RETCODE	SCIPlpiGetBase (SCIP_LPI lpi, int cstat, int *rstat)
SCIP_RETCODE	SCIPlpiSetBase (SCIP_LPI lpi, const int cstat, const int *rstat)
SCIP_RETCODE	SCIPlpiGetBasisInd (SCIP_LPI lpi, int bind)
SCIP_RETCODE	SCIPlpiGetBInvRow (SCIP_LPI lpi, int r, SCIP_Real coef, int inds, int ninds)
SCIP_RETCODE	SCIPlpiGetBInvCol (SCIP_LPI lpi, int c, SCIP_Real coef, int inds, int ninds)
SCIP_RETCODE	SCIPlpiGetBInvARow (SCIP_LPI lpi, int r, const SCIP_Real binvrow, SCIP_Real coef, int inds, int *ninds)
SCIP_RETCODE	SCIPlpiGetBInvACol (SCIP_LPI lpi, int c, SCIP_Real coef, int inds, int ninds)
LP State Methods
SCIP_RETCODE	SCIPlpiGetState (SCIP_LPI lpi, BMS_BLKMEM blkmem, SCIP_LPISTATE **lpistate)
SCIP_RETCODE	SCIPlpiSetState (SCIP_LPI lpi, BMS_BLKMEM blkmem, const SCIP_LPISTATE *lpistate)
SCIP_RETCODE	SCIPlpiClearState (SCIP_LPI *lpi)
SCIP_RETCODE	SCIPlpiFreeState (SCIP_LPI lpi, BMS_BLKMEM blkmem, SCIP_LPISTATE **lpistate)
SCIP_Bool	SCIPlpiHasStateBasis (SCIP_LPI lpi, SCIP_LPISTATE lpistate)
SCIP_RETCODE	SCIPlpiReadState (SCIP_LPI lpi, const char fname)
SCIP_RETCODE	SCIPlpiWriteState (SCIP_LPI lpi, const char fname)
LP Pricing Norms Methods
SCIP_RETCODE	SCIPlpiGetNorms (SCIP_LPI lpi, BMS_BLKMEM blkmem, SCIP_LPINORMS **lpinorms)
SCIP_RETCODE	SCIPlpiSetNorms (SCIP_LPI lpi, BMS_BLKMEM blkmem, const SCIP_LPINORMS *lpinorms)
SCIP_RETCODE	SCIPlpiFreeNorms (SCIP_LPI lpi, BMS_BLKMEM blkmem, SCIP_LPINORMS **lpinorms)
Parameter Methods
SCIP_RETCODE	SCIPlpiGetIntpar (SCIP_LPI lpi, SCIP_LPPARAM type, int ival)
SCIP_RETCODE	SCIPlpiSetIntpar (SCIP_LPI *lpi, SCIP_LPPARAM type, int ival)
SCIP_RETCODE	SCIPlpiGetRealpar (SCIP_LPI lpi, SCIP_LPPARAM type, SCIP_Real dval)
SCIP_RETCODE	SCIPlpiSetRealpar (SCIP_LPI *lpi, SCIP_LPPARAM type, SCIP_Real dval)
SCIP_RETCODE	SCIPlpiInterrupt (SCIP_LPI *lpi, SCIP_Bool interrupt)
Numerical Methods
SCIP_Real	SCIPlpiInfinity (SCIP_LPI *lpi)
SCIP_Bool	SCIPlpiIsInfinity (SCIP_LPI *lpi, SCIP_Real val)
File Interface Methods
SCIP_RETCODE	SCIPlpiReadLP (SCIP_LPI lpi, const char fname)
SCIP_RETCODE	SCIPlpiWriteLP (SCIP_LPI lpi, const char fname)

Variables
static GRBenv *	reusegrbenv = NULL
static int	numlp = 0
static const char *	intparam [NUMINTPARAM]
static const char *	dblparam [NUMDBLPARAM]
static const double	dblparammin [NUMDBLPARAM]
static const char	grbname []

Macro Definition Documentation

◆ SCIP_REUSEENV

#define SCIP_REUSEENV

Definition at line 67 of file lpi_grb.c.

◆ CHECK_ZERO

#define CHECK_ZERO	(		messagehdlr,
			x )

Value:

   do { int _restat_;                   \
   if( (_restat_ = (x)) != 0 )                                       \
   {                                                                 \
      SCIPmessagePrintWarning((messagehdlr), "Gurobi error %d: %s\n", _restat_, GRBgeterrormsg(lpi->grbenv)); \
      return SCIP_LPERROR;                                           \
   }                                                                 \
} while(0)

Definition at line 71 of file lpi_grb.c.

◆ CHECK_ZERO_STAR

#define CHECK_ZERO_STAR	(		messagehdlr,
			x )

Value:

   do { int _restat_;              \
   if( (_restat_ = (x)) != 0 )                                       \
   {                                                                 \
      SCIPmessagePrintWarning((messagehdlr), "Gurobi error %d: %s\n", _restat_, GRBgeterrormsg((*lpi)->grbenv)); \
      return SCIP_LPERROR;                                           \
   }                                                                 \
} while(0)

Definition at line 80 of file lpi_grb.c.

Referenced by SCIPlpiCreate(), and SCIPlpiFree().

◆ SVECTOR

#define SVECTOR GRBsvec

Definition at line 89 of file lpi_grb.c.

Referenced by SCIPlpiGetBInvACol(), SCIPlpiGetBInvARow(), SCIPlpiGetBInvCol(), and SCIPlpiGetBInvRow().

◆ SCIP_DUALPACKETSIZE

#define SCIP_DUALPACKETSIZE (sizeof(SCIP_DUALPACKET)*4)

each entry needs two bits of information

Definition at line 93 of file lpi_grb.c.

◆ COLS_PER_PACKET

#define COLS_PER_PACKET SCIP_DUALPACKETSIZE

Definition at line 96 of file lpi_grb.c.

◆ ROWS_PER_PACKET

#define ROWS_PER_PACKET SCIP_DUALPACKETSIZE

Definition at line 98 of file lpi_grb.c.

◆ GRB_REFACTORMAXITERS

#define GRB_REFACTORMAXITERS 50

maximal number of iterations allowed for producing a refactorization of the basis

Definition at line 104 of file lpi_grb.c.

Referenced by restoreLPData().

◆ NUMINTPARAM

#define NUMINTPARAM 6

number of Gurobi integer parameters that can be changed

Definition at line 108 of file lpi_grb.c.

◆ NUMDBLPARAM

#define NUMDBLPARAM 7

number of Gurobi double parameters that can be changed

Definition at line 121 of file lpi_grb.c.

Typedef Documentation

◆ GRBPARAM

typedef struct GRBParam GRBPARAM

Definition at line 152 of file lpi_grb.c.

Function Documentation

◆ ensureSidechgMem()

SCIP_RETCODE ensureSidechgMem	(	SCIP_LPI *	lpi,
		int	num )

static

resizes senarray to have at least num entries

Parameters

lpi	LP interface structure
num	minimal number of entries in array

Definition at line 224 of file lpi_grb.c.

References assert(), BMSreallocMemoryArray, ensureSidechgMem(), MAX, NULL, SCIP_LPi::rhsarray, SCIP_LPi::rngarray, SCIP_LPi::rngidxarray, SCIP_ALLOC, SCIP_OKAY, SCIP_LPi::senarray, and SCIP_LPi::sidechgsize.

◆ ensureValMem()

SCIP_RETCODE ensureValMem	(	SCIP_LPI *	lpi,
		int	num )

static

resizes valarray and indarray to have at least num entries

Parameters

lpi	LP interface structure
num	minimal number of entries in array

Definition at line 249 of file lpi_grb.c.

References assert(), BMSreallocMemoryArray, ensureValMem(), SCIP_LPi::indarray, MAX, NULL, SCIP_ALLOC, SCIP_OKAY, SCIP_LPi::valarray, and SCIP_LPi::valsize.

◆ ensureCstatMem()

SCIP_RETCODE ensureCstatMem	(	SCIP_LPI *	lpi,
		int	num )

static

resizes cstat array to have at least num entries

Parameters

lpi	LP interface structure
num	minimal number of entries in array

Definition at line 272 of file lpi_grb.c.

References assert(), BMSreallocMemoryArray, SCIP_LPi::cstat, SCIP_LPi::cstatsize, ensureCstatMem(), MAX, NULL, SCIP_ALLOC, and SCIP_OKAY.

◆ ensureRstatMem()

SCIP_RETCODE ensureRstatMem	(	SCIP_LPI *	lpi,
		int	num )

static

resizes rstat array to have at least num entries

Parameters

lpi	LP interface structure
num	minimal number of entries in array

Definition at line 294 of file lpi_grb.c.

References assert(), BMSreallocMemoryArray, ensureRstatMem(), MAX, NULL, SCIP_LPi::rstat, SCIP_LPi::rstatsize, SCIP_ALLOC, and SCIP_OKAY.

◆ ensureRngrowmapMem()

SCIP_RETCODE ensureRngrowmapMem	(	SCIP_LPI *	lpi,
		int	num )

static

resizes rngrowmap array to have at least num entries

Parameters

lpi	LP interface structure
num	minimal number of entries in array

Definition at line 316 of file lpi_grb.c.

References assert(), BMSreallocMemoryArray, ensureRngrowmapMem(), MAX, NULL, r, SCIP_LPi::rngrowmap, SCIP_LPi::rngrowmapsize, SCIP_ALLOC, and SCIP_OKAY.

Referenced by addRangeInfo(), ensureRngrowmapMem(), SCIPlpiAddRows(), and SCIPlpiChgSides().

◆ ensureRngrowsMem()

SCIP_RETCODE ensureRngrowsMem	(	SCIP_LPI *	lpi,
		int	num )

static

resizes rngrows and rngvals arrays to have at least num entries

Parameters

lpi	LP interface structure
num	minimal number of entries in array

Definition at line 341 of file lpi_grb.c.

References assert(), BMSreallocMemoryArray, ensureRngrowsMem(), MAX, NULL, SCIP_LPi::rngrows, SCIP_LPi::rngrowssize, SCIP_LPi::rngvals, SCIP_ALLOC, and SCIP_OKAY.

Referenced by addRangeInfo(), ensureRngrowsMem(), and SCIPlpiChgSides().

◆ getBase()

SCIP_RETCODE getBase	(	SCIP_LPI *	lpi,
		SCIP_Bool *	success )

static

stores current basis in internal arrays of LPI data structure

Parameters

lpi	LP interface structure
success	whether basis information has successfully been obtained

Definition at line 364 of file lpi_grb.c.

References assert(), CHECK_ZERO, SCIP_LPi::cstat, ensureCstatMem(), ensureRstatMem(), FALSE, getBase(), SCIP_LPi::grbenv, SCIP_LPi::grbmodel, SCIP_LPi::messagehdlr, NULL, SCIP_LPi::rstat, SCIP_Bool, SCIP_CALL, SCIP_LPERROR, SCIP_OKAY, SCIPdebugMessage, SCIPerrorMessage, and TRUE.

◆ setBase()

SCIP_RETCODE setBase ( SCIP_LPI * lpi )

static

loads basis stored in internal arrays of LPI data structure into Gurobi

Parameters

lpi	LP interface structure

Definition at line 422 of file lpi_grb.c.

References assert(), CHECK_ZERO, SCIP_LPi::cstat, SCIP_LPi::grbmodel, SCIP_LPi::messagehdlr, NULL, SCIP_LPi::rstat, SCIP_OKAY, SCIPdebugMessage, and setBase().

◆ colpacketNum()

int colpacketNum ( int ncols )

static

returns the number of packets needed to store column packet information

Parameters

ncols number of columns to store

Definition at line 455 of file lpi_grb.c.

References colpacketNum(), and COLS_PER_PACKET.

◆ rowpacketNum()

int rowpacketNum ( int nrows )

static

returns the number of packets needed to store row packet information

Parameters

nrows number of rows to store

Definition at line 464 of file lpi_grb.c.

References rowpacketNum(), and ROWS_PER_PACKET.

◆ SCIPencodeDualBitNeg()

void SCIPencodeDualBitNeg	(	const int *	inp,
		SCIP_DUALPACKET *	out,
		int	count )

static

encode a negated dual bit vector into packed format

Parameters

inp	unpacked input vector
out	buffer to store the packed vector
count	number of elements

Definition at line 476 of file lpi_grb.c.

References assert(), i, NULL, SCIP_DUALPACKETSIZE, and SCIPencodeDualBitNeg().

Referenced by lpistatePack(), and SCIPencodeDualBitNeg().

◆ SCIPdecodeDualBitNeg()

void SCIPdecodeDualBitNeg	(	const SCIP_DUALPACKET *	inp,
		int *	out,
		int	count )

static

decode a packed dual bit vector into negated unpacked format

Parameters

inp	packed input vector
out	buffer to store unpacked vector
count	number of elements

Definition at line 547 of file lpi_grb.c.

References assert(), i, NULL, SCIP_DUALPACKETSIZE, and SCIPdecodeDualBitNeg().

Referenced by lpistateUnpack(), and SCIPdecodeDualBitNeg().

◆ lpistatePack()

void lpistatePack	(	SCIP_LPISTATE *	lpistate,
		const int *	cstat,
		const int *	rstat )

static

store row and column basis status in a packed LPi state object

Parameters

lpistate	pointer to LPi state data
cstat	basis status of columns in unpacked format
rstat	basis status of rows in unpacked format

Definition at line 623 of file lpi_grb.c.

References assert(), lpistatePack(), SCIP_LPiState::ncols, SCIP_LPiState::nrngrows, SCIP_LPiState::nrows, NULL, SCIP_LPiState::packcstat, SCIP_LPiState::packrstat, and SCIPencodeDualBitNeg().

◆ lpistateUnpack()

void lpistateUnpack	(	const SCIP_LPISTATE *	lpistate,
		int *	cstat,
		int *	rstat )

static

unpacks row and column basis status from a packed LPi state object

Parameters

lpistate	pointer to LPi state data
cstat	buffer for storing basis status of columns in unpacked format
rstat	buffer for storing basis status of rows in unpacked format

Definition at line 639 of file lpi_grb.c.

References assert(), lpistateUnpack(), SCIP_LPiState::ncols, SCIP_LPiState::nrngrows, SCIP_LPiState::nrows, NULL, SCIP_LPiState::packcstat, SCIP_LPiState::packrstat, and SCIPdecodeDualBitNeg().

◆ lpistateCreate()

SCIP_RETCODE lpistateCreate	(	SCIP_LPISTATE **	lpistate,
		BMS_BLKMEM *	blkmem,
		int	ncols,
		int	nrows,
		int	nrngrows )

static

creates LPi state information object

Parameters

lpistate	pointer to LPi state
blkmem	block memory
ncols	number of columns to store
nrows	number of rows to store
nrngrows	number of ranged rows

Definition at line 655 of file lpi_grb.c.

References assert(), BMSallocBlockMemory, BMSallocBlockMemoryArray, colpacketNum(), lpistateCreate(), NULL, rowpacketNum(), SCIP_ALLOC, and SCIP_OKAY.

◆ lpistateFree()

void lpistateFree	(	SCIP_LPISTATE **	lpistate,
		BMS_BLKMEM *	blkmem )

static

frees LPi state information

Parameters

lpistate	pointer to LPi state information (like basis information)
blkmem	block memory

Definition at line 677 of file lpi_grb.c.

References assert(), BMSfreeBlockMemory, BMSfreeBlockMemoryArrayNull, colpacketNum(), lpistateFree(), NULL, and rowpacketNum().

◆ getParameterValues()

SCIP_RETCODE getParameterValues	(	SCIP_LPI *	lpi,
		GRBPARAM *	grbparam )

static

gets all Gurobi parameters used in LPI

Parameters

lpi	LP interface structure
grbparam	Gurobi parameters

Definition at line 699 of file lpi_grb.c.

References assert(), CHECK_ZERO, dblparam, getParameterValues(), SCIP_LPi::grbenv, i, intparam, SCIP_LPi::messagehdlr, NULL, NUMDBLPARAM, NUMINTPARAM, SCIP_OKAY, and SCIPdebugMessage.

◆ checkParameterValues()

SCIP_RETCODE checkParameterValues ( SCIP_LPI * lpi )

static

in debug mode, checks validity of Gurobi parameters

Parameters

lpi	LP interface structure

Definition at line 726 of file lpi_grb.c.

References assert(), checkParameterValues(), SCIP_LPi::curparam, dblparammin, SCIP_CPXParam::dblparval, getParameterValues(), i, SCIP_CPXParam::intparval, MAX, NUMDBLPARAM, NUMINTPARAM, SCIP_CALL, and SCIP_OKAY.

◆ setParameterValues()

SCIP_RETCODE setParameterValues	(	SCIP_LPI *	lpi,
		GRBPARAM *	grbparam )

static

sets all Gurobi parameters used in LPI

Parameters

lpi	LP interface structure
grbparam	Gurobi parameters

Definition at line 746 of file lpi_grb.c.

References assert(), CHECK_ZERO, checkParameterValues(), SCIP_LPi::curparam, dblparam, dblparammin, SCIP_CPXParam::dblparval, SCIP_LPi::grbenv, i, intparam, SCIP_CPXParam::intparval, MAX, SCIP_LPi::messagehdlr, NULL, NUMDBLPARAM, NUMINTPARAM, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, and setParameterValues().

◆ copyParameterValues()

void copyParameterValues	(	GRBPARAM *	dest,
		const GRBPARAM *	source )

static

copies Gurobi parameters from source to dest

Parameters

dest	destination Gurobi parameters
source	original Gurobi parameters

Definition at line 787 of file lpi_grb.c.

References copyParameterValues(), i, NUMDBLPARAM, and NUMINTPARAM.

◆ getIntParam()

SCIP_RETCODE getIntParam	(	SCIP_LPI *	lpi,
		const char *	param,
		int *	p )

static

gets a single integer parameter value

Parameters

lpi	LP interface structure
param	parameter name
p	value of parameter

Definition at line 802 of file lpi_grb.c.

References assert(), getIntParam(), SCIP_LPi::grbparam, i, intparam, NULL, NUMINTPARAM, SCIP_LPERROR, SCIP_OKAY, and SCIPerrorMessage.

◆ setIntParam()

SCIP_RETCODE setIntParam	(	SCIP_LPI *	lpi,
		const char *	param,
		int	parval )

static

sets a single integer parameter value

Parameters

lpi	LP interface structure
param	parameter name
parval	value of parameter

Definition at line 827 of file lpi_grb.c.

References assert(), SCIP_LPi::grbparam, i, intparam, NULL, NUMINTPARAM, SCIP_LPERROR, SCIP_OKAY, SCIPerrorMessage, and setIntParam().

◆ getDblParam()

SCIP_RETCODE getDblParam	(	SCIP_LPI *	lpi,
		const char *	param,
		double *	p )

static

gets a single double parameter value

Parameters

lpi	LP interface structure
param	parameter name
p	value of parameter

Definition at line 852 of file lpi_grb.c.

References assert(), dblparam, getDblParam(), SCIP_LPi::grbparam, i, NULL, NUMDBLPARAM, SCIP_LPERROR, SCIP_OKAY, and SCIPerrorMessage.

◆ setDblParam()

SCIP_RETCODE setDblParam	(	SCIP_LPI *	lpi,
		const char *	param,
		double	parval )

static

sets a single double parameter value

Parameters

lpi	LP interface structure
param	parameter name
parval	value of parameter

Definition at line 877 of file lpi_grb.c.

References assert(), dblparam, SCIP_LPi::grbparam, i, NULL, NUMDBLPARAM, SCIP_LPERROR, SCIP_OKAY, SCIPerrorMessage, and setDblParam().

◆ invalidateSolution()

void invalidateSolution ( SCIP_LPI * lpi )

static

marks the current LP to be unsolved

Parameters

lpi	LP interface structure

Definition at line 902 of file lpi_grb.c.

References assert(), invalidateSolution(), NULL, and SCIP_LPi::solstat.

◆ convertSides()

SCIP_RETCODE convertSides	(	SCIP_LPI *	lpi,
		int	nrows,
		const SCIP_Real *	lhs,
		const SCIP_Real *	rhs,
		int *	rngcount )

static

converts SCIP's lhs/rhs pairs into Gurobi's sen/rhs

Parameters

lpi	LP interface structure
nrows	number of rows
lhs	left hand side vector
rhs	right hand side vector
rngcount	number of ranged rows found

Definition at line 912 of file lpi_grb.c.

References assert(), convertSides(), i, NULL, SCIP_LPi::rhsarray, SCIP_LPi::rngarray, SCIP_LPi::rngidxarray, SCIP_OKAY, SCIP_Real, and SCIP_LPi::senarray.

◆ reconvertSides()

SCIP_RETCODE reconvertSides	(	SCIP_LPI *	lpi,
		int	firstrow,
		int	lastrow,
		SCIP_Real *	lhs,
		SCIP_Real *	rhs )

static

converts Gurobi's sen/rhs pairs into SCIP's lhs/rhs pairs

Parameters

lpi	LP interface structure
firstrow	first row to get sides for
lastrow	last row to get sides for
lhs	buffer to store the left hand side vector, or NULL
rhs	buffer to store the right hand side vector, or NULL

Definition at line 970 of file lpi_grb.c.

References assert(), i, SCIP_LPi::nrngrows, NULL, reconvertSides(), SCIP_LPi::rhsarray, SCIP_LPi::rngrowmap, SCIP_LPi::rngvals, SCIP_CALL, SCIP_LPERROR, SCIP_OKAY, SCIP_Real, SCIPABORT, SCIPerrorMessage, SCIPlpiGetNRows(), and SCIP_LPi::senarray.

◆ restoreLPData()

SCIP_RETCODE restoreLPData ( SCIP_LPI * lpi )

static

after restoring old LP data, need to resolve the LP to be able to retrieve correct information

Parameters

lpi	LP interface structure

Definition at line 1040 of file lpi_grb.c.

References assert(), CHECK_ZERO, GRB_REFACTORMAXITERS, SCIP_LPi::grbenv, SCIP_LPi::grbmodel, SCIP_LPi::messagehdlr, NULL, restoreLPData(), SCIP_OKAY, and SCIPmessagePrintWarning().

◆ checkRangeInfo()

void checkRangeInfo ( SCIP_LPI * lpi )

static

verifies in debug mode that ranged row information is consistent

Parameters

lpi	LP interface structure

Definition at line 1072 of file lpi_grb.c.

References assert(), checkRangeInfo(), i, SCIP_LPi::nrngrows, NULL, SCIP_LPi::rngrowmap, SCIP_LPi::rngrowmapsize, SCIP_LPi::rngrows, SCIP_LPi::rngrowssize, SCIP_LPi::rngvals, SCIP_CALL_ABORT, and SCIPlpiGetNRows().

Referenced by checkRangeInfo(), SCIPlpiAddCols(), SCIPlpiAddRows(), SCIPlpiChgBounds(), SCIPlpiChgSides(), SCIPlpiClear(), SCIPlpiCreate(), SCIPlpiDelCols(), SCIPlpiDelColset(), SCIPlpiDelRows(), SCIPlpiDelRowset(), SCIPlpiLoadColLP(), SCIPlpiScaleCol(), SCIPlpiScaleRow(), SCIPlpiSolveBarrier(), SCIPlpiSolveDual(), SCIPlpiSolvePrimal(), SCIPlpiStrongbranchesFrac(), SCIPlpiStrongbranchesInt(), SCIPlpiStrongbranchFrac(), and SCIPlpiStrongbranchInt().

◆ addRangeVars()

SCIP_RETCODE addRangeVars ( SCIP_LPI * lpi )

static

adds range variables to Gurobi LP

Parameters

lpi	LP interface structure

Definition at line 1114 of file lpi_grb.c.

References addRangeVars(), assert(), CHECK_ZERO, SCIP_LPi::grbmodel, i, SCIP_LPi::messagehdlr, SCIP_LPi::nrngrows, NULL, SCIP_LPi::rngrowmap, SCIP_LPi::rngrows, SCIP_LPi::rngvals, SCIP_LPi::rngvarsadded, SCIP_OKAY, and TRUE.

Referenced by addRangeVars(), lpiStrongbranch(), SCIPlpiSolveBarrier(), SCIPlpiSolveDual(), SCIPlpiSolvePrimal(), and SCIPlpiWriteLP().

◆ delRangeVars()

SCIP_RETCODE delRangeVars ( SCIP_LPI * lpi )

static

deletes range variables from Gurobi LP

Parameters

lpi	LP interface structure

Definition at line 1145 of file lpi_grb.c.

References assert(), BMSallocMemoryArray, BMSfreeMemoryArray, CHECK_ZERO, delRangeVars(), FALSE, SCIP_LPi::grbmodel, i, SCIP_LPi::messagehdlr, SCIP_LPi::nrngrows, SCIP_LPi::rngvarsadded, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, and SCIPlpiGetNCols().

Referenced by addRangeInfo(), delRangeVars(), SCIPlpiAddCols(), SCIPlpiChgSides(), SCIPlpiDelRows(), SCIPlpiDelRowset(), and SCIPlpiWriteLP().

◆ clearRangeInfo()

void clearRangeInfo ( SCIP_LPI * lpi )

static

clear ranged row information

Parameters

lpi	LP interface structure

Definition at line 1175 of file lpi_grb.c.

References assert(), BMSfreeMemoryArrayNull, clearRangeInfo(), SCIP_LPi::nrngrows, SCIP_LPi::rngrowmap, SCIP_LPi::rngrowmapsize, SCIP_LPi::rngrows, SCIP_LPi::rngrowssize, SCIP_LPi::rngvals, and SCIP_LPi::rngvarsadded.

Referenced by clearRangeInfo(), SCIPlpiChgSides(), SCIPlpiClear(), SCIPlpiDelRows(), and SCIPlpiDelRowset().

◆ addRangeInfo()

SCIP_RETCODE addRangeInfo	(	SCIP_LPI *	lpi,
		int	rngcount,
		int	firstrow )

static

creates or updates maps for ranged rows after new rows have been added

Parameters

lpi	LP interface structure
rngcount	number of ranged rows added
firstrow	index of first row that was added

Definition at line 1192 of file lpi_grb.c.

References addRangeInfo(), assert(), delRangeVars(), ensureRngrowmapMem(), ensureRngrowsMem(), i, SCIP_LPi::nrngrows, NULL, r, SCIP_LPi::rngarray, SCIP_LPi::rngidxarray, SCIP_LPi::rngrowmap, SCIP_LPi::rngrows, SCIP_LPi::rngvals, SCIP_LPi::rngvarsadded, SCIP_CALL, SCIP_OKAY, SCIPlpiGetNCols(), and SCIPlpiGetNRows().

Referenced by addRangeInfo(), SCIPlpiAddRows(), and SCIPlpiLoadColLP().

Variable Documentation

◆ reusegrbenv

GRBenv* reusegrbenv = NULL

static

global Gurobi environment

Definition at line 65 of file lpi_grb.c.

Referenced by SCIPlpiCreate().

◆ numlp

int numlp = 0

static

number of open LP objects

Definition at line 66 of file lpi_grb.c.

Referenced by SCIPlpiCreate().

◆ intparam

const char* intparam[NUMINTPARAM]

static

Initial value:

                           =
{
   GRB_INT_PAR_SCALEFLAG,
   GRB_INT_PAR_PRESOLVE,
   GRB_INT_PAR_SIMPLEXPRICING,
   GRB_INT_PAR_OUTPUTFLAG,
   GRB_INT_PAR_THREADS,
   GRB_INT_PAR_SEED
}

Definition at line 110 of file lpi_grb.c.

◆ dblparam

const char* dblparam[NUMDBLPARAM]

static

Initial value:

                           =
{
   GRB_DBL_PAR_FEASIBILITYTOL,
   GRB_DBL_PAR_OPTIMALITYTOL,
   GRB_DBL_PAR_BARCONVTOL,
   GRB_DBL_PAR_CUTOFF,
   GRB_DBL_PAR_TIMELIMIT,
   GRB_DBL_PAR_ITERATIONLIMIT,
   GRB_DBL_PAR_MARKOWITZTOL
}

Definition at line 123 of file lpi_grb.c.

◆ dblparammin

const double dblparammin[NUMDBLPARAM]

static

Initial value:

                                =
{
   +1e-09,               
   +1e-09,               
   0.0,                  
   -GRB_INFINITY,        
   0,                    
   0,                    
   1e-04                 
}

minimal values for double parameters

Definition at line 135 of file lpi_grb.c.

◆ grbname

const char grbname[]

static

Initial value:

                       = {'G', 'u', 'r', 'o', 'b', 'i', ' ',
 
GRB_VERSION_MAJOR + '0',
 
'.', GRB_VERSION_MINOR + '0', '.', GRB_VERSION_TECHNICAL + '0', '\0'}

Definition at line 1255 of file lpi_grb.c.

Referenced by SCIPlpiGetSolverName().

Detailed Description

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

◆ SCIP_REUSEENV

◆ CHECK_ZERO

◆ CHECK_ZERO_STAR

◆ SVECTOR

◆ SCIP_DUALPACKETSIZE

◆ COLS_PER_PACKET

◆ ROWS_PER_PACKET

◆ GRB_REFACTORMAXITERS

◆ NUMINTPARAM

◆ NUMDBLPARAM

Typedef Documentation

◆ GRBPARAM

Function Documentation

◆ ensureSidechgMem()

◆ ensureValMem()

◆ ensureCstatMem()

◆ ensureRstatMem()

◆ ensureRngrowmapMem()

◆ ensureRngrowsMem()

◆ getBase()

◆ setBase()

◆ colpacketNum()

◆ rowpacketNum()

◆ SCIPencodeDualBitNeg()

◆ SCIPdecodeDualBitNeg()

◆ lpistatePack()

◆ lpistateUnpack()

◆ lpistateCreate()

◆ lpistateFree()

◆ getParameterValues()

◆ checkParameterValues()

◆ setParameterValues()

◆ copyParameterValues()

◆ getIntParam()

◆ setIntParam()

◆ getDblParam()

◆ setDblParam()

◆ invalidateSolution()

◆ convertSides()

◆ reconvertSides()

◆ restoreLPData()

◆ checkRangeInfo()

◆ addRangeVars()

◆ delRangeVars()

◆ clearRangeInfo()

◆ addRangeInfo()

Variable Documentation

◆ reusegrbenv

◆ numlp

◆ intparam

◆ dblparam

◆ dblparammin

◆ grbname