Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

miscellaneous methods for linear constraints

Author
Jakob Witzig
Ambros Gleixner
Stephen J. Maher

Definition in file misc_linear.c.

#include <assert.h>
#include <string.h>
#include "scip/def.h"
#include "scip/scip.h"
#include "scip/pub_misc_linear.h"
#include "scip/cons_setppc.h"
#include "scip/scipdefplugins.h"

Go to the source code of this file.

Functions

SCIP_Real SCIPconsGetRhs (SCIP *scip, SCIP_CONS *cons, SCIP_Bool *success)
 
SCIP_Real SCIPconsGetLhs (SCIP *scip, SCIP_CONS *cons, SCIP_Bool *success)
 
SCIP_RETCODE SCIPgetConsVals (SCIP *scip, SCIP_CONS *cons, SCIP_Real *vals, int varssize, SCIP_Bool *success)
 
void SCIPconsGetDualfarkas (SCIP *scip, SCIP_CONS *cons, SCIP_Real *dualfarkas, SCIP_Bool *success)
 
void SCIPconsGetDualsol (SCIP *scip, SCIP_CONS *cons, SCIP_Real *dualsol, SCIP_Bool *success)
 
SCIP_ROWSCIPconsGetRow (SCIP *scip, SCIP_CONS *cons)
 
SCIP_RETCODE SCIPconsAddCoef (SCIP *scip, SCIP_CONS *cons, SCIP_VAR *var, SCIP_Real val)
 

Function Documentation

◆ SCIPconsGetRhs()

SCIP_Real SCIPconsGetRhs ( SCIP scip,
SCIP_CONS cons,
SCIP_Bool success 
)

returns the right-hand side of an arbitrary SCIP constraint that can be represented as a single linear constraint

Note
The success pointer indicates if the individual contraint handler was able to return the involved values
Parameters
scipSCIP data structure
consconstraint for which right-hand side is queried
successpointer to store whether a valid right-hand side was returned

Definition at line 39 of file misc_linear.c.

References FALSE, NULL, SCIP_INVALID, SCIP_Real, SCIP_SETPPCTYPE_COVERING, SCIP_SETPPCTYPE_PACKING, SCIP_SETPPCTYPE_PARTITIONING, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPgetCapacityKnapsack(), SCIPgetRhsLinear(), SCIPgetRhsVarbound(), SCIPgetTypeSetppc(), SCIPinfinity(), SCIPwarningMessage(), and TRUE.

Referenced by addSlackVars().

◆ SCIPconsGetLhs()

SCIP_Real SCIPconsGetLhs ( SCIP scip,
SCIP_CONS cons,
SCIP_Bool success 
)

returns the left-hand side of an arbitrary SCIP constraint that can be represented as a single linear constraint

Note
The success pointer indicates if the individual contraint handler was able to return the involved values
Parameters
scipSCIP data structure
consconstraint to get left-hand side for
successpointer to store whether a valid left-hand side was returned

Definition at line 103 of file misc_linear.c.

References FALSE, NULL, SCIP_INVALID, SCIP_Real, SCIP_SETPPCTYPE_COVERING, SCIP_SETPPCTYPE_PACKING, SCIP_SETPPCTYPE_PARTITIONING, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPgetLhsLinear(), SCIPgetLhsVarbound(), SCIPgetTypeSetppc(), SCIPinfinity(), SCIPwarningMessage(), and TRUE.

Referenced by addSlackVars().

◆ SCIPgetConsVals()

SCIP_RETCODE SCIPgetConsVals ( SCIP scip,
SCIP_CONS cons,
SCIP_Real vals,
int  varssize,
SCIP_Bool success 
)

returns the value array of an arbitrary SCIP constraint that can be represented as a single linear constraint

Returns
SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
Note
The success pointer indicates if the individual contraint handler was able to return the involved values
Parameters
scipSCIP data structure
consconstraint for which the coefficients are wanted
valsarray to store the coefficients of the constraint
varssizeavailable slots in vals array needed to check if the array is large enough
successpointer to store whether the coefficients are successfully copied

Definition at line 170 of file misc_linear.c.

References FALSE, NULL, SCIP_CALL, SCIP_Longint, SCIP_OKAY, SCIP_Real, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPgetConsNVars(), SCIPgetValsLinear(), SCIPgetVbdcoefVarbound(), SCIPgetWeightsKnapsack(), SCIPgetWeightsSOS1(), SCIPgetWeightsSOS2(), SCIPwarningMessage(), and TRUE.

◆ SCIPconsGetDualfarkas()

void SCIPconsGetDualfarkas ( SCIP scip,
SCIP_CONS cons,
SCIP_Real dualfarkas,
SCIP_Bool success 
)

returns the dual farkas sol of an arbitrary SCIP constraint that can be represented as a single linear constraint

Note
The success pointer indicates if the individual contraint handler was able to return the dual farkas solution
Parameters
scipSCIP data structure
consconstraint to get the dual farkas solution for
dualfarkaspointer to store the dual farkas solution
successpointer to store whether the dual farkas solution is successfully returned

Definition at line 292 of file misc_linear.c.

References FALSE, NULL, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPgetDualfarkasKnapsack(), SCIPgetDualfarkasLinear(), SCIPgetDualfarkasLogicor(), SCIPgetDualfarkasSetppc(), SCIPgetDualfarkasVarbound(), SCIPwarningMessage(), and TRUE.

◆ SCIPconsGetDualsol()

void SCIPconsGetDualsol ( SCIP scip,
SCIP_CONS cons,
SCIP_Real dualsol,
SCIP_Bool success 
)

returns the dual sol of an arbitrary SCIP constraint that can be represented as a single linear constraint

Note
The success pointer indicates if the individual contraint handler was able to return the dual solution
Parameters
scipSCIP data structure
consconstraint to get the dual solution for
dualsolpointer to store the dual solution
successpointer to store whether the dual solution is successfully returned

Definition at line 348 of file misc_linear.c.

References FALSE, NULL, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPgetDualsolKnapsack(), SCIPgetDualsolLinear(), SCIPgetDualsolLogicor(), SCIPgetDualsolSetppc(), SCIPgetDualsolVarbound(), SCIPwarningMessage(), and TRUE.

◆ SCIPconsGetRow()

SCIP_ROW* SCIPconsGetRow ( SCIP scip,
SCIP_CONS cons 
)

returns the row of an arbitrary SCIP constraint that can be represented as a single linear constraint or NULL of no row is awailable

Parameters
scipSCIP data structure
consconstraint for which row is queried

Definition at line 403 of file misc_linear.c.

References NULL, SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPgetRowKnapsack(), SCIPgetRowLinear(), SCIPgetRowLogicor(), SCIPgetRowSetppc(), SCIPgetRowVarbound(), and SCIPwarningMessage().

◆ SCIPconsAddCoef()

SCIP_RETCODE SCIPconsAddCoef ( SCIP scip,
SCIP_CONS cons,
SCIP_VAR var,
SCIP_Real  val 
)

adds the given variable to the input constraint. If the constraint is setppc or logicor the value is ignored. If the constraint is knapsack, then the value is converted to an int. A warning is passed if the SCIP_Real is not an integer. TODO: Allow val to be a pointer.

Parameters
scipSCIP data structure
consconstraint for which row is queried
varvariable of the constraint entry
valthe coefficient of the constraint entry

Definition at line 451 of file misc_linear.c.

References NULL, SCIP_CALL, SCIP_ERROR, SCIP_Longint, SCIP_OKAY, SCIPaddCoefKnapsack(), SCIPaddCoefLinear(), SCIPaddCoefLogicor(), SCIPaddCoefSetppc(), SCIPconsGetHdlr(), SCIPconshdlrGetName(), SCIPerrorMessage, and SCIPisIntegral().

Referenced by addSlackVars().