Scippy

SCIP

Solving Constraint Integer Programs

Macros | Typedefs | Enumerations
type_prob.h File Reference
Public API of SCIP » Core API » Type Definitions

Detailed Description

type definitions for storing and manipulating the main problem

Author
Tobias Achterberg

Definition in file type_prob.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"

Go to the source code of this file.

Macros

#define SCIP_DECL_PROBDELORIG(x)   SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA** probdata)
 
#define SCIP_DECL_PROBTRANS(x)   SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA* sourcedata, SCIP_PROBDATA** targetdata)
 
#define SCIP_DECL_PROBDELTRANS(x)   SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA** probdata)
 
#define SCIP_DECL_PROBINITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA* probdata)
 
#define SCIP_DECL_PROBEXITSOL(x)   SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA* probdata, SCIP_Bool restart)
 
#define SCIP_DECL_PROBCOPY(x)
 

Typedefs

typedef enum SCIP_Objsense SCIP_OBJSENSE
 
typedef struct SCIP_Prob SCIP_PROB
 
typedef struct SCIP_ProbData SCIP_PROBDATA
 

Enumerations

enum  SCIP_Objsense {
  SCIP_OBJSENSE_MAXIMIZE = -1 ,
  SCIP_OBJSENSE_MINIMIZE = +1
}
 

Macro Definition Documentation

◆ SCIP_DECL_PROBDELORIG

#define SCIP_DECL_PROBDELORIG (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA** probdata)

frees user data of original problem (called when the original problem is freed)

This method should free the user data of the original problem.

input:

  • scip : SCIP main data structure
  • probdata : pointer to the user problem data to free

Definition at line 64 of file type_prob.h.

◆ SCIP_DECL_PROBTRANS

#define SCIP_DECL_PROBTRANS (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA* sourcedata, SCIP_PROBDATA** targetdata)

creates user data of transformed problem by transforming the original user problem data (called after problem was transformed)

Because the original problem and the user data of the original problem should not be modified during the solving process, a transformed problem is created as a copy of the original problem. If the user problem data is never modified during the solving process anyways, it is enough to simple copy the user data's pointer. This is the default implementation, which is used when a NULL is given as PROBTRANS method. If the user data may be modified during the solving process (e.g. during preprocessing), the PROBTRANS method must be given and has to copy the user problem data to a different memory location.

input:

  • scip : SCIP main data structure
  • sourcedata : source problem data to transform
  • targetdata : pointer to store created transformed problem data

Definition at line 83 of file type_prob.h.

◆ SCIP_DECL_PROBDELTRANS

#define SCIP_DECL_PROBDELTRANS (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA** probdata)

frees user data of transformed problem (called when the transformed problem is freed)

This method has to be implemented, if the PROBTRANS method is not a simple pointer copy operation like in the default PROBTRANS implementation. It should free the user data of the transformed problem, that was created in the PROBTRANS method.

input:

  • scip : SCIP main data structure
  • probdata : pointer to the user problem data to free

Definition at line 95 of file type_prob.h.

◆ SCIP_DECL_PROBINITSOL

#define SCIP_DECL_PROBINITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA* probdata)

solving process initialization method of transformed data (called before the branch and bound process begins)

This method is called before the branch and bound process begins and can be used to initialize user problem data that depends for example on the number of active problem variables, because these are now fixed.

input:

  • scip : SCIP main data structure
  • probdata : user problem data

Definition at line 106 of file type_prob.h.

◆ SCIP_DECL_PROBEXITSOL

#define SCIP_DECL_PROBEXITSOL (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_PROBDATA* probdata, SCIP_Bool restart)

solving process deinitialization method of transformed data (called before the branch and bound data is freed)

This method is called before the branch and bound data is freed and should be used to free all data that was allocated in the solving process initialization method. The user has to make sure, that all LP rows associated to the transformed user problem data are released.

input:

  • scip : SCIP main data structure
  • probdata : user problem data
  • restart : was this exit solve call triggered by a restart?

Definition at line 119 of file type_prob.h.

◆ SCIP_DECL_PROBCOPY

#define SCIP_DECL_PROBCOPY (   x)
Value:
SCIP_RETCODE x (SCIP* scip, SCIP* sourcescip, SCIP_PROBDATA* sourcedata, \
SCIP_HASHMAP* varmap, SCIP_HASHMAP* consmap, SCIP_PROBDATA** targetdata, SCIP_Bool original, \
SCIP_Bool global, SCIP_RESULT* result)
x
SCIP_VAR ** x
Definition: circlepacking.c:63
SCIP_Bool
#define SCIP_Bool
Definition: def.h:91
SCIP_HashMap
Definition: struct_misc.h:138
SCIP_PROBDATA
struct SCIP_ProbData SCIP_PROBDATA
Definition: type_prob.h:53
SCIP_RESULT
enum SCIP_Result SCIP_RESULT
Definition: type_result.h:61
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63

copies user data of source SCIP for the target SCIP

This method should copy the problem data of the source SCIP and create a target problem data for (target) SCIP. Implementing this callback is optional. If the copying process was successful the target SCIP gets this problem data assigned. In case the result pointer is set to SCIP_DIDNOTRUN the target SCIP will have no problem data at all.

The variable map and the constraint map can be used via the function SCIPgetVarCopy() and SCIPgetConsCopy(), respectively, to get for certain variables and constraints of the source SCIP the counter parts in the target SCIP. You should be very carefully in using these two methods since they could lead to an infinite loop due to recursion.

input:

  • scip : target SCIP data structure
  • sourcescip : source SCIP main data structure
  • sourcedata : source user problem data
  • varmap, : a hashmap which stores the mapping of source variables to corresponding target variables
  • consmap, : a hashmap which stores the mapping of source constraints to corresponding target constraints
  • targetdata : pointer to the target user problem data to create
  • original : copy original or transformed problem?
  • global : create a global or a local copy?

output:

  • result : pointer to store the result of the call

possible return values for *result:

  • SCIP_DIDNOTRUN : the copying process was not performed
  • SCIP_SUCCESS : the copying process was successfully performed

Definition at line 150 of file type_prob.h.

Typedef Documentation

◆ SCIP_OBJSENSE

typedef enum SCIP_Objsense SCIP_OBJSENSE

Definition at line 50 of file type_prob.h.

◆ SCIP_PROB

typedef struct SCIP_Prob SCIP_PROB

main problem to solve

Definition at line 52 of file type_prob.h.

◆ SCIP_PROBDATA

typedef struct SCIP_ProbData SCIP_PROBDATA

user problem data set by the reader

Definition at line 53 of file type_prob.h.

Enumeration Type Documentation

◆ SCIP_Objsense

enum SCIP_Objsense

objective sense: minimization or maximization

Enumerator
SCIP_OBJSENSE_MAXIMIZE 

maximization of objective function

SCIP_OBJSENSE_MINIMIZE 

minimization of objective function (the default)

Definition at line 45 of file type_prob.h.