Scippy

SCIP

Solving Constraint Integer Programs

Public Member Functions | Data Fields
scip::ObjPresol Class Referenceabstract

Detailed Description

C++ wrapper for presolvers.

This class defines the interface for presolvers implemented in C++. Note that there is a pure virtual function (this function has to be implemented). This function is: scip_exec().

Definition at line 43 of file objpresol.h.

#include <objpresol.h>

Public Member Functions

 ObjPresol (SCIP *scip, const char *name, const char *desc, int priority, int maxrounds, SCIP_Bool timing)
 
virtual ~ObjPresol ()
 
virtual SCIP_DECL_PRESOLFREE (scip_free)
 
virtual SCIP_DECL_PRESOLINIT (scip_init)
 
virtual SCIP_DECL_PRESOLEXIT (scip_exit)
 
virtual SCIP_DECL_PRESOLINITPRE (scip_initpre)
 
virtual SCIP_DECL_PRESOLEXITPRE (scip_exitpre)
 
virtual SCIP_DECL_PRESOLEXEC (scip_exec)=0
 
- Public Member Functions inherited from scip::ObjCloneable
virtual ~ObjCloneable ()
 
virtual SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
 
virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)
 

Data Fields

SCIP * scip_
 
char * scip_name_
 
char * scip_desc_
 
const int scip_priority_
 
const int scip_maxrounds_
 
const unsigned int scip_timing_
 

Constructor & Destructor Documentation

scip::ObjPresol::ObjPresol ( SCIP *  scip,
const char *  name,
const char *  desc,
int  priority,
int  maxrounds,
SCIP_Bool  timing 
)
inline

default constructor

Parameters
scipSCIP data structure
namename of presolver
descdescription of presolver
prioritypriority of the presolver
maxroundsmaximal number of presolving rounds the presolver participates in (-1: no limit)
timingtiming mask of the presolver

Definition at line 67 of file objpresol.h.

References SCIP_CALL_ABORT, and SCIPduplicateMemoryArray.

virtual scip::ObjPresol::~ObjPresol ( )
inlinevirtual

destructor

Definition at line 88 of file objpresol.h.

References SCIPfreeMemoryArray.

Member Function Documentation

virtual scip::ObjPresol::SCIP_DECL_PRESOLFREE ( scip_free  )
inlinevirtual

destructor of presolver to free user data (called when SCIP is exiting)

See also
SCIP_DECL_PRESOLFREE(x) in type_prop.h

Definition at line 100 of file objpresol.h.

References SCIP_OKAY.

virtual scip::ObjPresol::SCIP_DECL_PRESOLINIT ( scip_init  )
inlinevirtual

initialization method of presolver (called after problem was transformed)

See also
SCIP_DECL_PRESOLINIT(x) in type_prop.h

Definition at line 109 of file objpresol.h.

References SCIP_OKAY.

virtual scip::ObjPresol::SCIP_DECL_PRESOLEXIT ( scip_exit  )
inlinevirtual

deinitialization method of presolver (called before transformed problem is freed)

See also
SCIP_DECL_PRESOLEXIT(x) in type_prop.h

Definition at line 118 of file objpresol.h.

References SCIP_OKAY.

virtual scip::ObjPresol::SCIP_DECL_PRESOLINITPRE ( scip_initpre  )
inlinevirtual

presolving initialization method of presolver (called when presolving is about to begin)

See also
SCIP_DECL_PRESOLINITPRE(x) in type_prop.h

Definition at line 127 of file objpresol.h.

References SCIP_OKAY.

virtual scip::ObjPresol::SCIP_DECL_PRESOLEXITPRE ( scip_exitpre  )
inlinevirtual

presolving deinitialization method of presolver (called after presolving has been finished)

See also
SCIP_DECL_PRESOLEXITPRE(x) in type_prop.h

Definition at line 136 of file objpresol.h.

References SCIP_Bool, SCIP_DECL_PRESOLEXEC(), SCIP_OKAY, SCIPfindObjPresol(), SCIPgetObjPresol(), and SCIPincludeObjPresol().

virtual scip::ObjPresol::SCIP_DECL_PRESOLEXEC ( scip_exec  )
pure virtual

execution method of presolver

See also
SCIP_DECL_PRESOLEXEC(x) in type_prop.h

Referenced by SCIP_DECL_PRESOLEXITPRE().

Field Documentation

SCIP* scip::ObjPresol::scip_

SCIP data structure

Definition at line 49 of file objpresol.h.

char* scip::ObjPresol::scip_name_

name of the presolver

Definition at line 52 of file objpresol.h.

Referenced by SCIPincludeObjPresol().

char* scip::ObjPresol::scip_desc_

description of the presolver

Definition at line 55 of file objpresol.h.

Referenced by SCIPincludeObjPresol().

const int scip::ObjPresol::scip_priority_

default priority of the presolver

Definition at line 58 of file objpresol.h.

Referenced by SCIPincludeObjPresol().

const int scip::ObjPresol::scip_maxrounds_

default maximal number of presolving rounds the presolver participates in (-1: no limit) timing mask of the presolver

Definition at line 61 of file objpresol.h.

Referenced by SCIPincludeObjPresol().

const unsigned int scip::ObjPresol::scip_timing_

Definition at line 64 of file objpresol.h.

Referenced by SCIPincludeObjPresol().