Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

methods to create a problem that SCIP should solve

This module summarizes the main methods needed to create a problem for SCIP, and access its most important members:

  • Declaring, adding, accessing, and changing variables of the problem
  • Declaring, adding, accessing, and changing constraints of the problem
  • Creating, adding, accessing, changing, and checking of solutions to the problem
Note
These core methods are not sufficient to create constraints of a certain type that is provided by the default plugins of SCIP. An example would be the creation of a linear constraint for which the methods provided by the linear constraint handler must be used. Such methods are provided by the default plugins of SCIP and can be found in the Plugin API of SCIP.

public methods to query linear constraint classification statistics

Modules

 SCIP
 methods to manipulate a SCIP object
 
 Global Problem
 methods to create, read and modify a global problem together with its callbacks
 
 Problem Variables
 public methods for problem variables
 
 Problem Constraints
 Public methods for constraints.
 
 Primal Solution
 methods to create and change primal solutions of SCIP
 
 Problem Copies
 methods to copy problems between a source and a target SCIP
 

Functions

SCIP_EXPORT SCIP_RETCODE SCIPlinConsStatsCreate (SCIP *scip, SCIP_LINCONSSTATS **linconsstats)
 
SCIP_EXPORT void SCIPlinConsStatsFree (SCIP *scip, SCIP_LINCONSSTATS **linconsstats)
 
SCIP_EXPORT void SCIPlinConsStatsReset (SCIP_LINCONSSTATS *linconsstats)
 
SCIP_EXPORT int SCIPlinConsStatsGetTypeCount (SCIP_LINCONSSTATS *linconsstats, SCIP_LINCONSTYPE linconstype)
 
SCIP_EXPORT int SCIPlinConsStatsGetSum (SCIP_LINCONSSTATS *linconsstats)
 
SCIP_EXPORT void SCIPlinConsStatsIncTypeCount (SCIP_LINCONSSTATS *linconsstats, SCIP_LINCONSTYPE linconstype, int increment)
 
SCIP_EXPORT void SCIPprintLinConsStats (SCIP *scip, FILE *file, SCIP_LINCONSSTATS *linconsstats)
 

Function Documentation

◆ SCIPlinConsStatsCreate()

SCIP_EXPORT SCIP_RETCODE SCIPlinConsStatsCreate ( SCIP scip,
SCIP_LINCONSSTATS **  linconsstats 
)

create linear constraint statistics

Parameters
scipscip data structure
linconsstatspointer to linear constraint classification statistics

Definition at line 7914 of file cons.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPallocBlockMemory, and SCIPlinConsStatsFree().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPconshdlrsResetPropagationStatus().

◆ SCIPlinConsStatsFree()

SCIP_EXPORT void SCIPlinConsStatsFree ( SCIP scip,
SCIP_LINCONSSTATS **  linconsstats 
)

free linear constraint statistics

Parameters
scipscip data structure
linconsstatspointer to linear constraint classification statistics

Definition at line 7927 of file cons.c.

References NULL, SCIPfreeBlockMemory, and SCIPlinConsStatsReset().

Referenced by SCIP_DECL_DIALOGEXEC(), and SCIPlinConsStatsCreate().

◆ SCIPlinConsStatsReset()

SCIP_EXPORT void SCIPlinConsStatsReset ( SCIP_LINCONSSTATS linconsstats)

resets linear constraint statistics

Parameters
linconsstatslinear constraint classification statistics

Definition at line 7939 of file cons.c.

References BMSclearMemoryArray, SCIP_NLINCONSTYPES, and SCIPlinConsStatsGetTypeCount().

Referenced by SCIPlinConsStatsFree().

◆ SCIPlinConsStatsGetTypeCount()

SCIP_EXPORT int SCIPlinConsStatsGetTypeCount ( SCIP_LINCONSSTATS linconsstats,
SCIP_LINCONSTYPE  linconstype 
)

returns the number of occurrences of a specific type of linear constraint

Parameters
linconsstatslinear constraint classification statistics
linconstypelinear constraint type

Definition at line 7948 of file cons.c.

References SCIP_LinConsStats::counter, NULL, SCIP_NLINCONSTYPES, and SCIPlinConsStatsGetSum().

Referenced by SCIPlinConsStatsReset(), and SCIPprintLinConsStats().

◆ SCIPlinConsStatsGetSum()

SCIP_EXPORT int SCIPlinConsStatsGetSum ( SCIP_LINCONSSTATS linconsstats)

returns the total number of classified constraints

Parameters
linconsstatslinear constraint classification statistics

Definition at line 7961 of file cons.c.

References NULL, SCIPlinConsStatsIncTypeCount(), and SCIP_LinConsStats::sum.

Referenced by SCIPlinConsStatsGetTypeCount(), and SCIPprintLinConsStats().

◆ SCIPlinConsStatsIncTypeCount()

SCIP_EXPORT void SCIPlinConsStatsIncTypeCount ( SCIP_LINCONSSTATS linconsstats,
SCIP_LINCONSTYPE  linconstype,
int  increment 
)

increases the number of occurrences of a specific type of linear constraint

Parameters
linconsstatslinear constraint classification statistics
linconstypelinear constraint type
incrementpositive increment

Definition at line 7971 of file cons.c.

References SCIP_LinConsStats::counter, NULL, SCIP_NLINCONSTYPES, SCIPprintLinConsStats(), and SCIP_LinConsStats::sum.

Referenced by SCIPlinConsStatsGetSum().

◆ SCIPprintLinConsStats()