Scippy

SCIP

Solving Constraint Integer Programs

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

Detailed Description

C++ wrapper for propagators.

This class defines the interface for propagators 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 objprop.h.

#include <objprop.h>

Public Member Functions

 ObjProp (SCIP *scip, const char *name, const char *desc, int priority, int freq, SCIP_Bool delay, unsigned int timingmask, int presolpriority, int presolmaxrounds, SCIP_Bool presoltiming)
 
virtual ~ObjProp ()
 
virtual SCIP_DECL_PROPFREE (scip_free)
 
virtual SCIP_DECL_PROPINIT (scip_init)
 
virtual SCIP_DECL_PROPEXIT (scip_exit)
 
virtual SCIP_DECL_PROPINITPRE (scip_initpre)
 
virtual SCIP_DECL_PROPEXITPRE (scip_exitpre)
 
virtual SCIP_DECL_PROPINITSOL (scip_initsol)
 
virtual SCIP_DECL_PROPEXITSOL (scip_exitsol)
 
virtual SCIP_DECL_PROPPRESOL (scip_presol)
 
virtual SCIP_DECL_PROPEXEC (scip_exec)=0
 
virtual SCIP_DECL_PROPRESPROP (scip_resprop)
 
- 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_freq_
 
const SCIP_Bool scip_delay_
 
const unsigned int scip_timingmask_
 
const int scip_presol_priority_
 
const int scip_presol_maxrounds_
 
const SCIP_Bool scip_presol_timing_
 

Constructor & Destructor Documentation

scip::ObjProp::ObjProp ( SCIP *  scip,
const char *  name,
const char *  desc,
int  priority,
int  freq,
SCIP_Bool  delay,
unsigned int  timingmask,
int  presolpriority,
int  presolmaxrounds,
SCIP_Bool  presoltiming 
)
inline

default constructor

Parameters
scipSCIP data structure
namename of propagator
descdescription of propagator
prioritypriority of the propagator
freqfrequency for calling propagator
delayshould propagator be delayed, if other propagators found reductions?
timingmaskpositions in the node solving loop where propagator should be executed
presolprioritypresolving priority of the propagator (>= 0: before, < 0: after constraint handlers)
presolmaxroundsmaximal number of presolving rounds the propagator participates in (-1: no limit)
presoltimingtiming mask of the propagator's presolving method

Definition at line 80 of file objprop.h.

References scip_, SCIP_CALL_ABORT, scip_desc_, scip_name_, and SCIPduplicateMemoryArray.

virtual scip::ObjProp::~ObjProp ( )
inlinevirtual

destructor

Definition at line 109 of file objprop.h.

References scip_, scip_desc_, scip_name_, and SCIPfreeMemoryArray.

Member Function Documentation

virtual scip::ObjProp::SCIP_DECL_PROPFREE ( scip_free  )
inlinevirtual

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

See Also
SCIP_DECL_PROPFREE(x) in type_prop.h

Definition at line 121 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPINIT ( scip_init  )
inlinevirtual

initialization method of propagator (called after problem was transformed)

See Also
SCIP_DECL_PROPINIT(x) in type_prop.h

Definition at line 130 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPEXIT ( scip_exit  )
inlinevirtual

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

See Also
SCIP_DECL_PROPEXIT(x) in type_prop.h

Definition at line 139 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPINITPRE ( scip_initpre  )
inlinevirtual

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

See Also
SCIP_DECL_PROPINITPRE(x) in type_prop.h

Definition at line 148 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPEXITPRE ( scip_exitpre  )
inlinevirtual

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

See Also
SCIP_DECL_PROPEXITPRE(x) in type_prop.h

Definition at line 157 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPINITSOL ( scip_initsol  )
inlinevirtual

solving process initialization method of propagator (called when branch and bound process is about to begin)

See Also
SCIP_DECL_PROPINITSOL(x) in type_prop.h

Definition at line 166 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPEXITSOL ( scip_exitsol  )
inlinevirtual

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

See Also
SCIP_DECL_PROPEXITSOL(x) in type_prop.h

Definition at line 175 of file objprop.h.

References SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPPRESOL ( scip_presol  )
inlinevirtual

presolving method of propagator

See Also
SCIP_DECL_PROPPRESOL(x) in type_prop.h

Definition at line 184 of file objprop.h.

References NULL, SCIP_DIDNOTRUN, and SCIP_OKAY.

virtual scip::ObjProp::SCIP_DECL_PROPEXEC ( scip_exec  )
pure virtual

execution method of propagator

See Also
SCIP_DECL_PROPEXEC(x) in type_prop.h
virtual scip::ObjProp::SCIP_DECL_PROPRESPROP ( scip_resprop  )
inlinevirtual

propagation conflict resolving method of propagator

See Also
SCIP_DECL_PROPRESPROP(x) in type_prop.h

Definition at line 201 of file objprop.h.

References NULL, SCIP_DIDNOTFIND, and SCIP_OKAY.

Field Documentation

SCIP* scip::ObjProp::scip_

SCIP data structure

Definition at line 49 of file objprop.h.

Referenced by ObjProp(), and ~ObjProp().

char* scip::ObjProp::scip_name_

name of the propagator

Definition at line 52 of file objprop.h.

Referenced by ObjProp(), and ~ObjProp().

char* scip::ObjProp::scip_desc_

description of the propagator

Definition at line 55 of file objprop.h.

Referenced by ObjProp(), and ~ObjProp().

const int scip::ObjProp::scip_priority_

default priority of the propagator

Definition at line 58 of file objprop.h.

const int scip::ObjProp::scip_freq_

frequency for calling propagator

Definition at line 61 of file objprop.h.

const SCIP_Bool scip::ObjProp::scip_delay_

should propagator be delayed, if other propagators found reductions?

Definition at line 64 of file objprop.h.

const unsigned int scip::ObjProp::scip_timingmask_

positions in the node solving loop where propagator should be executed

Definition at line 67 of file objprop.h.

const int scip::ObjProp::scip_presol_priority_

default presolving priority of the propagator

Definition at line 70 of file objprop.h.

const int scip::ObjProp::scip_presol_maxrounds_

frequency for calling propagator timing mask of the propagator's presolving method

Definition at line 73 of file objprop.h.

const SCIP_Bool scip::ObjProp::scip_presol_timing_

Definition at line 76 of file objprop.h.