Detailed Description

COMPLETESOL - primal heuristic trying to complete given partial solutions.

Author: Jakob Witzig

#include "blockmemshell/memory.h"
#include "scip/cons_linear.h"
#include "scip/heur_completesol.h"
#include "scip/pub_event.h"
#include "scip/pub_heur.h"
#include "scip/pub_message.h"
#include "scip/pub_misc.h"
#include "scip/pub_sol.h"
#include "scip/pub_var.h"
#include "scip/scip_branch.h"
#include "scip/scip_cons.h"
#include "scip/scip_copy.h"
#include "scip/scip_event.h"
#include "scip/scip_general.h"
#include "scip/scip_heur.h"
#include "scip/scip_mem.h"
#include "scip/scip_message.h"
#include "scip/scip_nlp.h"
#include "scip/scip_nodesel.h"
#include "scip/scip_numerics.h"
#include "scip/scip_param.h"
#include "scip/scip_prob.h"
#include "scip/scip_probing.h"
#include "scip/scip_sol.h"
#include "scip/scip_solve.h"
#include "scip/scip_solvingstats.h"
#include "scip/scip_timing.h"
#include "scip/scip_tree.h"
#include "scip/scip_var.h"
#include <string.h>

Go to the source code of this file.

Macros
#define	HEUR_NAME "completesol"

#define	HEUR_DESC "primal heuristic trying to complete given partial solutions"

#define	HEUR_DISPCHAR 'h'

#define	HEUR_PRIORITY 0

#define	HEUR_FREQ 0

#define	HEUR_FREQOFS 0

#define	HEUR_MAXDEPTH 0

#define	HEUR_TIMING SCIP_HEURTIMING_BEFOREPRESOL \| SCIP_HEURTIMING_BEFORENODE

#define	HEUR_USESSUBSCIP TRUE

#define	DEFAULT_MAXNODES 5000LL

#define	DEFAULT_MAXUNKRATE 0.85

#define	DEFAULT_ADDALLSOLS FALSE

#define	DEFAULT_MINNODES 50LL

#define	DEFAULT_NODESOFS 500LL

#define	DEFAULT_NODESQUOT 0.1

#define	DEFAULT_LPLIMFAC 2.0

#define	DEFAULT_OBJWEIGHT 1.0

#define	DEFAULT_BOUNDWIDENING 0.1

#define	DEFAULT_MINIMPROVE 0.01

#define	DEFAULT_MINOBJWEIGHT 1e-3

#define	DEFAULT_IGNORECONT FALSE

#define	DEFAULT_BESTSOLS 5

#define	DEFAULT_MAXPROPROUNDS 10

#define	DEFAULT_MAXLPITER -1LL

#define	DEFAULT_MAXCONTVARS -1

#define	DEFAULT_BEFOREPRESOL TRUE

#define	EVENTHDLR_NAME "Completesol"

#define	EVENTHDLR_DESC "LP event handler for " HEUR_NAME " heuristic"

Functions
static	SCIP_DECL_EVENTEXEC (eventExecCompletesol)

static SCIP_RETCODE	createSubproblem (SCIP scip, SCIP subscip, SCIP_HEURDATA heurdata, SCIP_VAR subvars, SCIP_SOL partialsol, SCIP_Bool tightened, SCIP_Bool success)

static SCIP_RETCODE	createNewSol (SCIP scip, SCIP subscip, SCIP_VAR *subvars, SCIP_HEUR heur, SCIP_SOL subsol, SCIP_Bool success)

static SCIP_RETCODE	chgProbingBound (SCIP scip, SCIP_VAR var, SCIP_Real newval, SCIP_BRANCHDIR branchdir, SCIP_Bool *success)

static SCIP_RETCODE	tightenVariables (SCIP scip, SCIP_HEURDATA heurdata, SCIP_VAR *vars, int nvars, SCIP_SOL sol, SCIP_Bool tightened, SCIP_Bool success)

static SCIP_RETCODE	setupAndSolve (SCIP scip, SCIP subscip, SCIP_HEUR heur, SCIP_HEURDATA heurdata, SCIP_RESULT result, SCIP_Longint nstallnodes, SCIP_SOL partialsol, SCIP_Bool *tightened)

static SCIP_RETCODE	applyCompletesol (SCIP scip, SCIP_HEUR heur, SCIP_HEURDATA heurdata, SCIP_RESULT result, SCIP_Longint nstallnodes, SCIP_SOL *partialsol)

static	SCIP_DECL_HEURCOPY (heurCopyCompletesol)

static	SCIP_DECL_HEURFREE (heurFreeCompletesol)

static	SCIP_DECL_HEUREXEC (heurExecCompletesol)

SCIP_RETCODE	SCIPincludeHeurCompletesol (SCIP *scip)

Macro Definition Documentation

◆ HEUR_NAME

#define HEUR_NAME "completesol"

Definition at line 54 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol(), and setupAndSolve().

◆ HEUR_DESC

#define HEUR_DESC "primal heuristic trying to complete given partial solutions"

Definition at line 55 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_DISPCHAR

#define HEUR_DISPCHAR 'h'

Definition at line 56 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_PRIORITY

#define HEUR_PRIORITY 0

Definition at line 57 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_FREQ

#define HEUR_FREQ 0

Definition at line 58 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_FREQOFS

#define HEUR_FREQOFS 0

Definition at line 59 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_MAXDEPTH

#define HEUR_MAXDEPTH 0

Definition at line 60 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_TIMING

#define HEUR_TIMING SCIP_HEURTIMING_BEFOREPRESOL | SCIP_HEURTIMING_BEFORENODE

Definition at line 61 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ HEUR_USESSUBSCIP

#define HEUR_USESSUBSCIP TRUE

does the heuristic use a secondary SCIP instance?

Definition at line 62 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MAXNODES

#define DEFAULT_MAXNODES 5000LL

maximum number of nodes to regard in the subproblem

Definition at line 65 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MAXUNKRATE

#define DEFAULT_MAXUNKRATE 0.85

maximum percentage of unknown solution values

Definition at line 66 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_ADDALLSOLS

#define DEFAULT_ADDALLSOLS FALSE

should all subproblem solutions be added to the original SCIP?

Definition at line 67 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MINNODES

#define DEFAULT_MINNODES 50LL

minimum number of nodes to regard in the subproblem

Definition at line 68 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_NODESOFS

#define DEFAULT_NODESOFS 500LL

number of nodes added to the contingent of the total nodes

Definition at line 69 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_NODESQUOT

#define DEFAULT_NODESQUOT 0.1

subproblem nodes in relation to nodes of the original problem

Definition at line 70 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_LPLIMFAC

#define DEFAULT_LPLIMFAC 2.0

factor by which the limit on the number of LP depends on the node limit

Definition at line 71 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_OBJWEIGHT

#define DEFAULT_OBJWEIGHT 1.0

weight of the original objective function (1: only original objective)

Definition at line 72 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_BOUNDWIDENING

#define DEFAULT_BOUNDWIDENING 0.1

bound widening factor applied to continuous variables (0: round bounds to next integer, 1: relax to global bounds)

Definition at line 73 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MINIMPROVE

#define DEFAULT_MINIMPROVE 0.01

factor by which the incumbent should be improved at least

Definition at line 78 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MINOBJWEIGHT

#define DEFAULT_MINOBJWEIGHT 1e-3

minimal weight for original objective function (zero could lead to infinite solutions)

Definition at line 79 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_IGNORECONT

#define DEFAULT_IGNORECONT FALSE

should solution values for continuous variables be ignored?

Definition at line 80 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_BESTSOLS

#define DEFAULT_BESTSOLS 5

heuristic stops, if the given number of improving solutions were found (-1: no limit)

Definition at line 81 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MAXPROPROUNDS

#define DEFAULT_MAXPROPROUNDS 10

maximal number of iterations in propagation (-1: no limit)

Definition at line 82 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MAXLPITER

#define DEFAULT_MAXLPITER -1LL

maximal number of LP iterations (-1: no limit)

Definition at line 83 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_MAXCONTVARS

#define DEFAULT_MAXCONTVARS -1

maximal number of continuous variables after presolving (-1: no limit)

Definition at line 84 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ DEFAULT_BEFOREPRESOL

#define DEFAULT_BEFOREPRESOL TRUE

should the heuristic run before presolving?

Definition at line 85 of file heur_completesol.c.

Referenced by SCIPincludeHeurCompletesol().

◆ EVENTHDLR_NAME

#define EVENTHDLR_NAME "Completesol"

Definition at line 88 of file heur_completesol.c.

Referenced by setupAndSolve().

◆ EVENTHDLR_DESC

#define EVENTHDLR_DESC "LP event handler for " HEUR_NAME " heuristic"

Definition at line 89 of file heur_completesol.c.

Referenced by setupAndSolve().

Function Documentation

◆ SCIP_DECL_EVENTEXEC()

static SCIP_DECL_EVENTEXEC ( eventExecCompletesol )

static

Definition at line 123 of file heur_completesol.c.

◆ createSubproblem()

static SCIP_RETCODE createSubproblem	(	SCIP *	scip,
		SCIP *	subscip,
		SCIP_HEURDATA *	heurdata,
		SCIP_VAR **	subvars,
		SCIP_SOL *	partialsol,
		SCIP_Bool *	tightened,
		SCIP_Bool *	success
	)

static

creates a subproblem by fixing a number of variables

Parameters

scip	original SCIP data structure
subscip	SCIP data structure for the subproblem
heurdata	heuristic's private data structure
subvars	the variables of the subproblem
partialsol	partial solution
tightened	array to store for which variables we have found bound tightenings
success	pointer to store whether the creation was successful

Definition at line 148 of file heur_completesol.c.

References createNewSol(), eps, FALSE, MIN, NULL, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OBJSENSE_MAXIMIZE, SCIP_OBJSENSE_MINIMIZE, SCIP_OKAY, SCIP_Real, SCIP_UNKNOWN, SCIP_VARTYPE_CONTINUOUS, SCIPaddCoefLinear(), SCIPaddCons(), SCIPaddVar(), SCIPchgVarObj(), SCIPcreateConsBasicLinear(), SCIPcreateVarBasic(), SCIPdebugMsg, SCIPfeasFrac(), SCIPgetLowerbound(), SCIPgetNSols(), SCIPgetNVars(), SCIPgetObjsense(), SCIPgetSolVal(), SCIPgetUpperbound(), SCIPgetVars(), SCIPinfinity(), SCIPisEQ(), SCIPisInfinity(), SCIPreleaseCons(), SCIPreleaseVar(), SCIPsnprintf(), SCIPsumepsilon(), SCIPvarGetName(), SCIPvarGetObj(), SCIPvarGetProbindex(), SCIPvarIsActive(), SCIPvarIsBinary(), and TRUE.

Referenced by setupAndSolve().

◆ createNewSol()

static SCIP_RETCODE createNewSol	(	SCIP *	scip,
		SCIP *	subscip,
		SCIP_VAR **	subvars,
		SCIP_HEUR *	heur,
		SCIP_SOL *	subsol,
		SCIP_Bool *	success
	)

static

creates a new solution for the original problem by copying the solution of the subproblem

Parameters

scip	original SCIP data structure
subscip	SCIP structure of the subproblem
subvars	the variables of the subproblem
heur	Completesol heuristic structure
subsol	solution of the subproblem or the partial
success	used to store whether new solution was found or not

Definition at line 341 of file heur_completesol.c.

References chgProbingBound(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIP_UNKNOWN, SCIPcreateSol(), SCIPgetNOrigVars(), SCIPgetSolVal(), SCIPgetVarsData(), SCIPisInfinity(), SCIPsetSolVal(), SCIPtrySolFree(), and TRUE.

Referenced by createSubproblem(), and setupAndSolve().

◆ chgProbingBound()

static SCIP_RETCODE chgProbingBound	(	SCIP *	scip,
		SCIP_VAR *	var,
		SCIP_Real	newval,
		SCIP_BRANCHDIR	branchdir,
		SCIP_Bool *	success
	)

static

perform a probing bound change or fixes the variable

Parameters

scip	original SCIP data structure
var	problem variable
newval	new bound
branchdir	bound change direction
success	pointer to store whether the bound could be tightened

Definition at line 389 of file heur_completesol.c.

References FALSE, NULL, SCIP_BRANCHDIR_DOWNWARDS, SCIP_BRANCHDIR_FIXED, SCIP_BRANCHDIR_UPWARDS, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIPchgVarLbProbing(), SCIPchgVarUbProbing(), SCIPfixVarProbing(), SCIPisGE(), SCIPisGT(), SCIPisLE(), SCIPisLT(), SCIPvarGetLbLocal(), SCIPvarGetUbLocal(), tightenVariables(), and TRUE.

Referenced by createNewSol(), and tightenVariables().

◆ tightenVariables()

static SCIP_RETCODE tightenVariables	(	SCIP *	scip,
		SCIP_HEURDATA *	heurdata,
		SCIP_VAR **	vars,
		int	nvars,
		SCIP_SOL *	sol,
		SCIP_Bool *	tightened,
		SCIP_Bool *	success
	)

static

tries variables bound changes guided by the given solution

Parameters

scip	original SCIP data structure
heurdata	heuristic's private data structure
vars	problem variables
nvars	number of problem variables
sol	solution to guide the bound changes
tightened	array to store if variable bound could be tightened
success	pointer to store the success

Definition at line 439 of file heur_completesol.c.

References chgProbingBound(), FALSE, NULL, REALABS, SCIP_Bool, SCIP_BRANCHDIR_DOWNWARDS, SCIP_BRANCHDIR_FIXED, SCIP_BRANCHDIR_UPWARDS, SCIP_CALL, SCIP_Longint, SCIP_MAXTREEDEPTH, SCIP_OKAY, SCIP_Real, SCIP_SOLORIGIN_PARTIAL, SCIP_UNKNOWN, SCIPbacktrackProbing(), SCIPceil(), SCIPdebugMsg, SCIPfloor(), SCIPgetNContVars(), SCIPgetProbingDepth(), SCIPgetSolVal(), SCIPisEQ(), SCIPisGT(), SCIPisInfinity(), SCIPisIntegral(), SCIPisLT(), SCIPnewProbingNode(), SCIPpropagateProbing(), SCIPsolGetOrigin(), SCIPvarGetLbGlobal(), SCIPvarGetLbLocal(), SCIPvarGetName(), SCIPvarGetProbindex(), SCIPvarGetUbGlobal(), SCIPvarGetUbLocal(), SCIPvarIsActive(), SCIPvarIsIntegral(), setupAndSolve(), and TRUE.

Referenced by applyCompletesol(), and chgProbingBound().

◆ setupAndSolve()

static SCIP_RETCODE setupAndSolve	(	SCIP *	scip,
		SCIP *	subscip,
		SCIP_HEUR *	heur,
		SCIP_HEURDATA *	heurdata,
		SCIP_RESULT *	result,
		SCIP_Longint	nstallnodes,
		SCIP_SOL *	partialsol,
		SCIP_Bool *	tightened
	)

static

Parameters

scip	original SCIP data structure
subscip	sub-SCIP data structure
heur	heuristic data structure
heurdata	heuristic's private data structure
result	result data structure
nstallnodes	number of stalling nodes for the subproblem
partialsol	partial solution
tightened	array to store whether a variable was already tightened

Definition at line 752 of file heur_completesol.c.

References applyCompletesol(), createNewSol(), createSubproblem(), EVENTHDLR_DESC, EVENTHDLR_NAME, FALSE, HEUR_NAME, NULL, SCIP_Bool, SCIP_CALL, SCIP_EVENTTYPE_LPSOLVED, SCIP_FOUNDSOL, SCIP_LONGINT_FORMAT, SCIP_OKAY, SCIP_PARAMSETTING_FAST, SCIP_PARAMSETTING_OFF, SCIP_PLUGINNOTFOUND, SCIP_STAGE_PRESOLVED, SCIP_VERBLEVEL_FULL, SCIP_VERBLEVEL_NONE, SCIPABORT, SCIPallocBufferArray, SCIPblkmem(), SCIPcatchEvent(), SCIPcopyConsCompression(), SCIPcopyLimits(), SCIPdebug, SCIPdebugMsg, SCIPdropEvent(), SCIPerrorMessage, SCIPfindBranchrule(), SCIPfindNodesel(), SCIPfreeBufferArray, SCIPgetBestSol(), SCIPgetNBinVars(), SCIPgetNConss(), SCIPgetNContVars(), SCIPgetNIntVars(), SCIPgetNNodes(), SCIPgetNSols(), SCIPgetNVars(), SCIPgetPrimalbound(), SCIPgetSols(), SCIPgetSolvingTime(), SCIPgetStage(), SCIPgetVars(), SCIPhashmapCreate(), SCIPhashmapFree(), SCIPhashmapGetImage(), SCIPincludeEventhdlrBasic(), SCIPinfinity(), SCIPisNLPEnabled(), SCIPisParamFixed(), SCIPpresolve(), SCIPprintStatistics(), SCIPsetBoolParam(), SCIPsetIntParam(), SCIPsetLongintParam(), SCIPsetPresolving(), SCIPsetSeparating(), SCIPsetSubscipsOff(), SCIPsolGetNodenum(), SCIPsolve(), SCIPstatisticPrintf, SCIPtransformProb(), SCIPwarningMessage(), and TRUE.

Referenced by applyCompletesol(), and tightenVariables().

◆ applyCompletesol()

static SCIP_RETCODE applyCompletesol	(	SCIP *	scip,
		SCIP_HEUR *	heur,
		SCIP_HEURDATA *	heurdata,
		SCIP_RESULT *	result,
		SCIP_Longint	nstallnodes,
		SCIP_SOL *	partialsol
	)

static

main procedure of the completesol heuristic, creates and solves a sub-SCIP

Parameters

scip	original SCIP data structure
heur	heuristic data structure
heurdata	heuristic's private data structure
result	result data structure
nstallnodes	number of stalling nodes for the subproblem
partialsol	partial solution

Definition at line 970 of file heur_completesol.c.

References NULL, SCIP_Bool, SCIP_CALL, SCIP_DECL_HEURCOPY(), SCIP_DIDNOTFIND, SCIP_DIDNOTRUN, SCIP_OKAY, SCIPallocClearBufferArray, SCIPcheckCopyLimits(), SCIPcreate(), SCIPdebugMsg, SCIPendProbing(), SCIPfree(), SCIPfreeBufferArray, SCIPgetNVars(), SCIPgetVars(), SCIPstartProbing(), setupAndSolve(), and tightenVariables().

Referenced by setupAndSolve().

◆ SCIP_DECL_HEURCOPY()

static SCIP_DECL_HEURCOPY ( heurCopyCompletesol )

static

copy method for primal heuristic plugins (called when SCIP copies plugins)

Definition at line 1042 of file heur_completesol.c.

Referenced by applyCompletesol().

◆ SCIP_DECL_HEURFREE()

static SCIP_DECL_HEURFREE ( heurFreeCompletesol )

static

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

Definition at line 1056 of file heur_completesol.c.

◆ SCIP_DECL_HEUREXEC()

static SCIP_DECL_HEUREXEC ( heurExecCompletesol )

static

execution method of primal heuristic

Definition at line 1076 of file heur_completesol.c.

SCIP

Detailed Description

Macros

Functions

Macro Definition Documentation

◆ HEUR_NAME

◆ HEUR_DESC

◆ HEUR_DISPCHAR

◆ HEUR_PRIORITY

◆ HEUR_FREQ

◆ HEUR_FREQOFS

◆ HEUR_MAXDEPTH

◆ HEUR_TIMING

◆ HEUR_USESSUBSCIP

◆ DEFAULT_MAXNODES

◆ DEFAULT_MAXUNKRATE

◆ DEFAULT_ADDALLSOLS

◆ DEFAULT_MINNODES

◆ DEFAULT_NODESOFS

◆ DEFAULT_NODESQUOT

◆ DEFAULT_LPLIMFAC

◆ DEFAULT_OBJWEIGHT

◆ DEFAULT_BOUNDWIDENING

◆ DEFAULT_MINIMPROVE

◆ DEFAULT_MINOBJWEIGHT

◆ DEFAULT_IGNORECONT

◆ DEFAULT_BESTSOLS

◆ DEFAULT_MAXPROPROUNDS

◆ DEFAULT_MAXLPITER

◆ DEFAULT_MAXCONTVARS

◆ DEFAULT_BEFOREPRESOL

◆ EVENTHDLR_NAME

◆ EVENTHDLR_DESC

Function Documentation

◆ SCIP_DECL_EVENTEXEC()

◆ createSubproblem()

◆ createNewSol()

◆ chgProbingBound()

◆ tightenVariables()

◆ setupAndSolve()

◆ applyCompletesol()

◆ SCIP_DECL_HEURCOPY()

◆ SCIP_DECL_HEURFREE()

◆ SCIP_DECL_HEUREXEC()