Scippy

SCIP

Solving Constraint Integer Programs

Functions
pub_prop.h File Reference
Public Methods

Detailed Description

public methods for propagators

Author
Tobias Achterberg

Definition in file pub_prop.h.

#include "scip/def.h"
#include "scip/type_misc.h"
#include "scip/type_prop.h"

Go to the source code of this file.

Functions

 SCIP_DECL_SORTPTRCOMP (SCIPpropComp)
 
 SCIP_DECL_SORTPTRCOMP (SCIPpropCompPresol)
 
 SCIP_DECL_SORTPTRCOMP (SCIPpropCompName)
 
SCIP_PROPDATA * SCIPpropGetData (SCIP_PROP *prop)
 
void SCIPpropSetData (SCIP_PROP *prop, SCIP_PROPDATA *propdata)
 
const char * SCIPpropGetName (SCIP_PROP *prop)
 
const char * SCIPpropGetDesc (SCIP_PROP *prop)
 
int SCIPpropGetPriority (SCIP_PROP *prop)
 
int SCIPpropGetPresolPriority (SCIP_PROP *prop)
 
int SCIPpropGetFreq (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetSetupTime (SCIP_PROP *prop)
 
void SCIPpropSetFreq (SCIP_PROP *prop, int freq)
 
SCIP_Real SCIPpropGetTime (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetStrongBranchPropTime (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetRespropTime (SCIP_PROP *prop)
 
SCIP_Real SCIPpropGetPresolTime (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNCalls (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNRespropCalls (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNCutoffs (SCIP_PROP *prop)
 
SCIP_Longint SCIPpropGetNDomredsFound (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropIsDelayed (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropIsPresolDelayed (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropWasDelayed (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropWasPresolDelayed (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropIsInitialized (SCIP_PROP *prop)
 
int SCIPpropGetNFixedVars (SCIP_PROP *prop)
 
int SCIPpropGetNAggrVars (SCIP_PROP *prop)
 
int SCIPpropGetNChgVarTypes (SCIP_PROP *prop)
 
int SCIPpropGetNChgBds (SCIP_PROP *prop)
 
int SCIPpropGetNAddHoles (SCIP_PROP *prop)
 
int SCIPpropGetNDelConss (SCIP_PROP *prop)
 
int SCIPpropGetNAddConss (SCIP_PROP *prop)
 
int SCIPpropGetNUpgdConss (SCIP_PROP *prop)
 
int SCIPpropGetNChgCoefs (SCIP_PROP *prop)
 
int SCIPpropGetNChgSides (SCIP_PROP *prop)
 
int SCIPpropGetNPresolCalls (SCIP_PROP *prop)
 
SCIP_PROPTIMING SCIPpropGetTimingmask (SCIP_PROP *prop)
 
SCIP_Bool SCIPpropDoesPresolve (SCIP_PROP *prop)
 
SCIP_PRESOLTIMING SCIPpropGetPresolTiming (SCIP_PROP *prop)
 
void SCIPpropSetPresolTiming (SCIP_PROP *prop, SCIP_PRESOLTIMING presoltiming)
 

Function Documentation

SCIP_DECL_SORTPTRCOMP ( SCIPpropComp  )

compares two propagators w. r. to their priority

Definition at line 43 of file prop.c.

SCIP_DECL_SORTPTRCOMP ( SCIPpropCompPresol  )

compares two propagators w. r. to their presolving priority

compares two propagators w. r. to their priority

Definition at line 49 of file prop.c.

SCIP_DECL_SORTPTRCOMP ( SCIPpropCompName  )

comparison method for sorting propagators w.r.t. to their name

Definition at line 55 of file prop.c.

References SCIPpropGetName().

SCIP_PROPDATA* SCIPpropGetData ( SCIP_PROP *  prop)

gets user data of propagator

Parameters
proppropagator

Definition at line 735 of file prop.c.

References NULL, and SCIP_Prop::propdata.

Referenced by applyGenVBounds(), initData(), propagateCutoffboundBinvar(), propagateCutoffboundBinvars(), propagateCutoffboundGlobally(), propagateVbounds(), SCIP_DECL_PROPCOPY(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPEXIT(), SCIP_DECL_PROPEXITPRE(), SCIP_DECL_PROPEXITSOL(), SCIP_DECL_PROPFREE(), SCIP_DECL_PROPINIT(), SCIP_DECL_PROPINITPRE(), SCIP_DECL_PROPINITSOL(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_PROPRESPROP(), SCIPfindObjProp(), SCIPgenVBoundAdd(), SCIPgetObjProp(), and SCIPisPropagatedVbounds().

void SCIPpropSetData ( SCIP_PROP *  prop,
SCIP_PROPDATA *  propdata 
)

sets user data of propagator; user has to free old data in advance!

Parameters
proppropagator
propdatanew propagator user data

Definition at line 745 of file prop.c.

References NULL, and SCIP_Prop::propdata.

Referenced by SCIP_DECL_PROPFREE().

const char* SCIPpropGetName ( SCIP_PROP *  prop)

gets name of propagator

Parameters
proppropagator

Definition at line 887 of file prop.c.

References SCIP_Prop::name, and NULL.

Referenced by applyProbing(), conflictAddBound(), conflictResolveBound(), paramsetSetPresolvingDefault(), paramsetSetPresolvingOff(), presolveRound(), printPresolverStatistics(), printPropagatorStatistics(), propagationRound(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_PROPCOPY(), SCIP_DECL_PROPEXEC(), SCIP_DECL_PROPPRESOL(), SCIP_DECL_SORTPTRCOMP(), SCIPboundchgApply(), SCIPgenVBoundAdd(), SCIPnodeAddBoundinfer(), SCIPnodeAddHoleinfer(), SCIPpropCopyInclude(), SCIPsetPropPresol(), SCIPsetSortSepas(), varAddLbchginfo(), and varAddUbchginfo().

const char* SCIPpropGetDesc ( SCIP_PROP *  prop)

gets description of propagator

Parameters
proppropagator

Definition at line 897 of file prop.c.

References SCIP_Prop::desc, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

int SCIPpropGetPriority ( SCIP_PROP *  prop)

gets priority of propagator

Parameters
proppropagator

Definition at line 907 of file prop.c.

References NULL, and SCIP_Prop::priority.

Referenced by propagationRound(), and SCIP_DECL_DIALOGEXEC().

int SCIPpropGetPresolPriority ( SCIP_PROP *  prop)

gets presolving priority of propagator

Parameters
proppropagator

Definition at line 917 of file prop.c.

References NULL, and SCIP_Prop::presolpriority.

Referenced by presolveRound(), and SCIP_DECL_DIALOGEXEC().

int SCIPpropGetFreq ( SCIP_PROP *  prop)

gets frequency of propagator

Parameters
proppropagator

Definition at line 955 of file prop.c.

References SCIP_Prop::freq, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIP_Real SCIPpropGetSetupTime ( SCIP_PROP *  prop)

gets time in seconds used for setting up this propagator for new stages

Parameters
proppropagator

Definition at line 980 of file prop.c.

References NULL, SCIPclockGetTime(), and SCIP_Prop::setuptime.

Referenced by printPresolverStatistics(), and printPropagatorStatistics().

void SCIPpropSetFreq ( SCIP_PROP *  prop,
int  freq 
)

sets frequency of propagator

Parameters
proppropagator
freqnew frequency of propagator

Definition at line 990 of file prop.c.

References SCIP_Prop::freq, and NULL.

SCIP_Real SCIPpropGetTime ( SCIP_PROP *  prop)

gets time in seconds used in this propagator

gets time in seconds used in this propagator for propagation

Parameters
proppropagator

Definition at line 1002 of file prop.c.

References NULL, SCIP_Prop::proptime, and SCIPclockGetTime().

Referenced by printPropagatorStatistics().

SCIP_Real SCIPpropGetStrongBranchPropTime ( SCIP_PROP *  prop)

gets time in seconds used in this propagator during strong branching

gets time in seconds used in this propagator for propagation during strong branching

Parameters
proppropagator

Definition at line 1012 of file prop.c.

References NULL, SCIP_Prop::sbproptime, and SCIPclockGetTime().

Referenced by printPropagatorStatistics().

SCIP_Real SCIPpropGetRespropTime ( SCIP_PROP *  prop)

gets time in seconds used in this propagator for resolve propagation

Parameters
proppropagator

Definition at line 1022 of file prop.c.

References NULL, SCIP_Prop::resproptime, and SCIPclockGetTime().

Referenced by printPropagatorStatistics().

SCIP_Real SCIPpropGetPresolTime ( SCIP_PROP *  prop)

gets time in seconds used in this propagator for presolving

Parameters
proppropagator

Definition at line 1032 of file prop.c.

References NULL, SCIP_Prop::presoltime, and SCIPclockGetTime().

Referenced by printPresolverStatistics(), and printPropagatorStatistics().

SCIP_Longint SCIPpropGetNCalls ( SCIP_PROP *  prop)

gets the total number of times, the propagator was called

Parameters
proppropagator

Definition at line 1042 of file prop.c.

References SCIP_Prop::ncalls, and NULL.

Referenced by printPropagatorStatistics().

SCIP_Longint SCIPpropGetNRespropCalls ( SCIP_PROP *  prop)

gets the total number of times, the propagator was called for resolving a propagation

Parameters
proppropagator

Definition at line 1052 of file prop.c.

References SCIP_Prop::nrespropcalls, and NULL.

Referenced by printPropagatorStatistics().

SCIP_Longint SCIPpropGetNCutoffs ( SCIP_PROP *  prop)

gets total number of times, this propagator detected a cutoff

Parameters
proppropagator

Definition at line 1062 of file prop.c.

References SCIP_Prop::ncutoffs, and NULL.

Referenced by printPropagatorStatistics().

SCIP_Longint SCIPpropGetNDomredsFound ( SCIP_PROP *  prop)

gets total number of domain reductions found by this propagator

Parameters
proppropagator

Definition at line 1072 of file prop.c.

References SCIP_Prop::ndomredsfound, and NULL.

Referenced by printPropagatorStatistics().

SCIP_Bool SCIPpropIsDelayed ( SCIP_PROP *  prop)

should propagator be delayed, if other propagators found reductions?

Parameters
proppropagator

Definition at line 1082 of file prop.c.

References SCIP_Prop::delay, and NULL.

Referenced by SCIP_DECL_DIALOGEXEC().

SCIP_Bool SCIPpropIsPresolDelayed ( SCIP_PROP *  prop)

should propagator be delayed during presolving, if other propagators found reductions?

Parameters
proppropagator
SCIP_Bool SCIPpropWasDelayed ( SCIP_PROP *  prop)

was propagator delayed at the last call?

Parameters
proppropagator

Definition at line 1092 of file prop.c.

References NULL, and SCIP_Prop::wasdelayed.

Referenced by propagationRound().

SCIP_Bool SCIPpropWasPresolDelayed ( SCIP_PROP *  prop)

was presolving of propagator delayed at the last call?

Parameters
proppropagator
SCIP_Bool SCIPpropIsInitialized ( SCIP_PROP *  prop)

is propagator initialized?

Parameters
proppropagator

Definition at line 1102 of file prop.c.

References SCIP_Prop::initialized, and NULL.

Referenced by SCIPsetFindSepa().

int SCIPpropGetNFixedVars ( SCIP_PROP *  prop)

gets number of variables fixed during presolving of propagator

Parameters
proppropagator

Definition at line 1112 of file prop.c.

References SCIP_Prop::nfixedvars, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNAggrVars ( SCIP_PROP *  prop)

gets number of variables aggregated during presolving of propagator

Parameters
proppropagator

Definition at line 1122 of file prop.c.

References SCIP_Prop::naggrvars, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNChgVarTypes ( SCIP_PROP *  prop)

gets number of variable types changed during presolving of propagator

Parameters
proppropagator

Definition at line 1132 of file prop.c.

References SCIP_Prop::nchgvartypes, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNChgBds ( SCIP_PROP *  prop)

gets number of bounds changed during presolving of propagator

Parameters
proppropagator

Definition at line 1142 of file prop.c.

References SCIP_Prop::nchgbds, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNAddHoles ( SCIP_PROP *  prop)

gets number of holes added to domains of variables during presolving of propagator

Parameters
proppropagator

Definition at line 1152 of file prop.c.

References SCIP_Prop::naddholes, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNDelConss ( SCIP_PROP *  prop)

gets number of constraints deleted during presolving of propagator

Parameters
proppropagator

Definition at line 1162 of file prop.c.

References SCIP_Prop::ndelconss, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNAddConss ( SCIP_PROP *  prop)

gets number of constraints added during presolving of propagator

Parameters
proppropagator

Definition at line 1172 of file prop.c.

References SCIP_Prop::naddconss, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNUpgdConss ( SCIP_PROP *  prop)

gets number of constraints upgraded during presolving of propagator

Parameters
proppropagator

Definition at line 1182 of file prop.c.

References NULL, and SCIP_Prop::nupgdconss.

int SCIPpropGetNChgCoefs ( SCIP_PROP *  prop)

gets number of coefficients changed during presolving of propagator

Parameters
proppropagator

Definition at line 1192 of file prop.c.

References SCIP_Prop::nchgcoefs, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNChgSides ( SCIP_PROP *  prop)

gets number of constraint sides changed during presolving of propagator

Parameters
proppropagator

Definition at line 1202 of file prop.c.

References SCIP_Prop::nchgsides, and NULL.

Referenced by printPresolverStatistics().

int SCIPpropGetNPresolCalls ( SCIP_PROP *  prop)

gets number of times the propagator was called in presolving and tried to find reductions

Parameters
proppropagator

Definition at line 1212 of file prop.c.

References SCIP_Prop::npresolcalls, and NULL.

Referenced by printPresolverStatistics().

SCIP_PROPTIMING SCIPpropGetTimingmask ( SCIP_PROP *  prop)

returns the timing mask of the propagator

Parameters
proppropagator

Definition at line 1222 of file prop.c.

References NULL, and SCIP_Prop::timingmask.

Referenced by propagationRound().

SCIP_Bool SCIPpropDoesPresolve ( SCIP_PROP *  prop)

does the propagator perform presolving?

Parameters
proppropagator

Definition at line 1232 of file prop.c.

References NULL.

Referenced by printPresolverStatistics().

SCIP_PRESOLTIMING SCIPpropGetPresolTiming ( SCIP_PROP *  prop)

returns the timing mask of the presolving method of the propagator

Parameters
proppropagator

Definition at line 1242 of file prop.c.

References NULL, and SCIP_Prop::presoltiming.

Referenced by SCIP_DECL_DIALOGEXEC().

void SCIPpropSetPresolTiming ( SCIP_PROP *  prop,
SCIP_PRESOLTIMING  presoltiming 
)

sets the timing mask of the presolving method of the propagator

Parameters
proppropagator
presoltimingtiming mask to be set

Definition at line 1252 of file prop.c.

References NULL, and SCIP_Prop::presoltiming.