Detailed Description

internal methods for NLP management

Author: Thorsten Gellermann; Stefan Vigerske

Definition in file nlp.h.

#include <stdio.h>
#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_event.h"
#include "scip/type_set.h"
#include "scip/type_stat.h"
#include "scip/type_misc.h"
#include "scip/type_lp.h"
#include "scip/type_var.h"
#include "scip/type_prob.h"
#include "scip/type_sol.h"
#include "scip/type_primal.h"
#include "scip/pub_nlp.h"

Go to the source code of this file.

Functions
Nonlinear row methods
SCIP_RETCODE	SCIPnlrowCreate (SCIP_NLROW *nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, const char name, SCIP_Real constant, int nlinvars, SCIP_VAR linvars, SCIP_Real lincoefs, SCIP_EXPR *expr, SCIP_Real lhs, SCIP_Real rhs, SCIP_EXPRCURV curvature)

SCIP_RETCODE	SCIPnlrowCreateCopy (SCIP_NLROW *nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLROW *sourcenlrow)

SCIP_RETCODE	SCIPnlrowCreateFromRow (SCIP_NLROW *nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_ROW *row)

SCIP_RETCODE	SCIPnlrowPrint (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_MESSAGEHDLR messagehdlr, FILE file)

void	SCIPnlrowCapture (SCIP_NLROW *nlrow)

SCIP_RETCODE	SCIPnlrowRelease (SCIP_NLROW *nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat)

SCIP_RETCODE	SCIPnlrowEnsureLinearSize (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET *set, int num)

SCIP_RETCODE	SCIPnlrowAddLinearCoef (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_VAR var, SCIP_Real val)

SCIP_RETCODE	SCIPnlrowDelLinearCoef (SCIP_NLROW nlrow, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_VAR *var)

SCIP_RETCODE	SCIPnlrowChgLinearCoef (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_VAR var, SCIP_Real coef)

SCIP_RETCODE	SCIPnlrowChgExpr (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_EXPR expr)

SCIP_RETCODE	SCIPnlrowChgConstant (SCIP_NLROW nlrow, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_Real constant)

SCIP_RETCODE	SCIPnlrowChgLhs (SCIP_NLROW nlrow, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_Real lhs)

SCIP_RETCODE	SCIPnlrowChgRhs (SCIP_NLROW nlrow, SCIP_SET set, SCIP_STAT stat, SCIP_NLP nlp, SCIP_Real rhs)

SCIP_RETCODE	SCIPnlrowSimplify (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLP *nlp)

SCIP_RETCODE	SCIPnlrowRecalcNLPActivity (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_NLP *nlp)

SCIP_RETCODE	SCIPnlrowGetNLPActivity (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_NLP nlp, SCIP_Real activity)

SCIP_RETCODE	SCIPnlrowGetNLPFeasibility (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_NLP nlp, SCIP_Real feasibility)

SCIP_RETCODE	SCIPnlrowRecalcPseudoActivity (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PROB prob, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_LP lp)

SCIP_RETCODE	SCIPnlrowGetPseudoActivity (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PROB prob, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_LP lp, SCIP_Real *pseudoactivity)

SCIP_RETCODE	SCIPnlrowGetPseudoFeasibility (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PROB prob, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_LP lp, SCIP_Real *pseudofeasibility)

SCIP_RETCODE	SCIPnlrowGetSolActivity (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_SOL sol, SCIP_Real activity)

SCIP_RETCODE	SCIPnlrowGetSolFeasibility (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_SOL sol, SCIP_Real feasibility)

SCIP_RETCODE	SCIPnlrowGetActivityBounds (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_Real minactivity, SCIP_Real maxactivity)

SCIP_RETCODE	SCIPnlrowIsRedundant (SCIP_NLROW nlrow, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_Bool *isredundant)

NLP methods
SCIP_RETCODE	SCIPnlpInclude (SCIP_SET set, BMS_BLKMEM blkmem)

SCIP_RETCODE	SCIPnlpCreate (SCIP_NLP *nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, const char *name, int nvars_estimate)

SCIP_RETCODE	SCIPnlpFree (SCIP_NLP *nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_EVENTQUEUE eventqueue, SCIP_LP lp)

SCIP_RETCODE	SCIPnlpReset (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_EVENTQUEUE eventqueue, SCIP_LP lp)

SCIP_Bool	SCIPnlpHasCurrentNodeNLP (SCIP_NLP *nlp)

SCIP_RETCODE	SCIPnlpEnsureVarsSize (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET *set, int num)

SCIP_RETCODE	SCIPnlpAddVar (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_VAR var)

SCIP_RETCODE	SCIPnlpAddVars (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, int nvars, SCIP_VAR *vars)

SCIP_RETCODE	SCIPnlpDelVar (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_EVENTQUEUE eventqueue, SCIP_LP lp, SCIP_VAR *var)

SCIP_RETCODE	SCIPnlpEnsureNlRowsSize (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET *set, int num)

SCIP_RETCODE	SCIPnlpAddNlRow (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLROW *nlrow)

SCIP_RETCODE	SCIPnlpAddNlRows (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, int nnlrows, SCIP_NLROW **nlrows)

SCIP_RETCODE	SCIPnlpDelNlRow (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_NLROW *nlrow)

SCIP_RETCODE	SCIPnlpFlush (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat)

SCIP_RETCODE	SCIPnlpSolve (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_MESSAGEHDLR messagehdlr, SCIP_STAT stat, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_NLPPARAM nlpparam)

SCIP_Real	SCIPnlpGetObjval (SCIP_NLP *nlp)

SCIP_RETCODE	SCIPnlpGetPseudoObjval (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_PROB prob, SCIP_PRIMAL primal, SCIP_TREE tree, SCIP_LP lp, SCIP_Real *pseudoobjval)

SCIP_RETCODE	SCIPnlpGetFracVars (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_VAR *fracvars, SCIP_Real fracvarssol, SCIP_Real *fracvarsfrac, int nfracvars, int *npriofracvars)

SCIP_RETCODE	SCIPnlpRemoveRedundantNlRows (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat)

SCIP_RETCODE	SCIPnlpSetInitialGuess (SCIP_SET set, SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_Real initguess)

SCIP_RETCODE	SCIPnlpWrite (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_MESSAGEHDLR messagehdlr, const char fname)

SCIP_RETCODE	SCIPnlpStartDive (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat)

SCIP_RETCODE	SCIPnlpEndDive (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat)

SCIP_RETCODE	SCIPnlpChgVarObjDive (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_VAR *var, SCIP_Real coef)

SCIP_RETCODE	SCIPnlpChgVarBoundsDive (SCIP_SET set, SCIP_NLP nlp, SCIP_VAR *var, SCIP_Real lb, SCIP_Real ub)

SCIP_RETCODE	SCIPnlpChgVarsBoundsDive (SCIP_NLP nlp, SCIP_SET set, int nvars, SCIP_VAR *vars, SCIP_Real lbs, SCIP_Real *ubs)

SCIP_Bool	SCIPnlpIsDivingObjChanged (SCIP_NLP *nlp)

SCIP_VAR **	SCIPnlpGetVars (SCIP_NLP *nlp)

int	SCIPnlpGetNVars (SCIP_NLP *nlp)

SCIP_RETCODE	SCIPnlpGetVarsNonlinearity (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, int *nlcount)

SCIP_RETCODE	SCIPnlpHasContinuousNonlinearity (SCIP_NLP nlp, BMS_BLKMEM blkmem, SCIP_SET set, SCIP_STAT stat, SCIP_Bool *result)

SCIP_Real *	SCIPnlpGetVarsLbDualsol (SCIP_NLP *nlp)

SCIP_Real *	SCIPnlpGetVarsUbDualsol (SCIP_NLP *nlp)

SCIP_NLROW **	SCIPnlpGetNlRows (SCIP_NLP *nlp)

int	SCIPnlpGetNNlRows (SCIP_NLP *nlp)

SCIP_NLPI *	SCIPnlpGetNLPI (SCIP_NLP *nlp)

SCIP_NLPIPROBLEM *	SCIPnlpGetNLPIProblem (SCIP_NLP *nlp)

SCIP_Bool	SCIPnlpIsDiving (SCIP_NLP *nlp)

SCIP_NLPSOLSTAT	SCIPnlpGetSolstat (SCIP_NLP *nlp)

SCIP_NLPTERMSTAT	SCIPnlpGetTermstat (SCIP_NLP *nlp)

SCIP_RETCODE	SCIPnlpGetStatistics (SCIP_SET set, SCIP_NLP nlp, SCIP_NLPSTATISTICS *statistics)

SCIP_Bool	SCIPnlpHasSolution (SCIP_NLP *nlp)

Function Documentation

◆ SCIPnlpInclude()

SCIP_RETCODE SCIPnlpInclude	(	SCIP_SET *	set,
		BMS_BLKMEM *	blkmem
	)

includes event handler that is used by NLP

Parameters

set	global SCIP settings
blkmem	block memory

Definition at line 3416 of file nlp.c.

References EVENTHDLR_DESC, EVENTHDLR_NAME, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_STAGE_INIT, SCIPerrorMessage, SCIPeventhdlrCreate(), SCIPsetFindEventhdlr(), and SCIPsetIncludeEventhdlr().

Referenced by doScipCreate().

◆ SCIPnlpCreate()

SCIP_RETCODE SCIPnlpCreate	(	SCIP_NLP **	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		const char *	name,
		int	nvars_estimate
	)

construct a new empty NLP

Parameters

nlp	NLP handler, call by reference
blkmem	block memory
set	global SCIP settings
stat	problem statistics
name	problem name
nvars_estimate	an estimate on the number of variables that may be added to the NLP later

Definition at line 3442 of file nlp.c.

References BMSallocMemory, BMSduplicateBlockMemoryArray, EVENTHDLR_NAME, FALSE, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_EVENTTYPE_VARADDED, SCIP_EVENTTYPE_VARDELETED, SCIP_INVALID, SCIP_NLPSOLSTAT_UNKNOWN, SCIP_NLPTERMSTAT_OTHER, SCIP_OKAY, SCIP_PLUGINNOTFOUND, SCIPerrorMessage, SCIPeventfilterAdd(), SCIPhashmapCreate(), SCIPnlpiCreateProblem(), SCIPsetFindEventhdlr(), SCIPsetFindNlpi(), SCIPsetSortNlpis(), and TRUE.

Referenced by initSolve().

◆ SCIPnlpFree()

SCIP_RETCODE SCIPnlpFree	(	SCIP_NLP **	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_LP *	lp
	)

frees NLP data object

Parameters

nlp	pointer to NLP data object
blkmem	block memory
set	global SCIP settings
stat	problem statistics
eventqueue	event queue
lp	SCIP LP, needed for releasing variables

Definition at line 3562 of file nlp.c.

References BMSfreeBlockMemoryArray, BMSfreeBlockMemoryArrayNull, BMSfreeMemory, NULL, SCIP_CALL, SCIP_EVENTTYPE_VARADDED, SCIP_EVENTTYPE_VARDELETED, SCIP_OKAY, SCIPeventfilterDel(), SCIPhashmapFree(), SCIPnlpiFreeProblem(), and SCIPnlpReset().

Referenced by freeReoptSolve(), and freeSolve().

◆ SCIPnlpReset()

SCIP_RETCODE SCIPnlpReset	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_LP *	lp
	)

resets the NLP to the empty NLP by removing all variables and rows from NLP, releasing all rows, and flushing the changes to the NLP solver

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
eventqueue	event queue
lp	SCIP LP, needed for releasing variables

Definition at line 3622 of file nlp.c.

References BMSfreeBlockMemoryArrayNull, FALSE, SCIP_Nlp::haveinitguess, SCIP_Nlp::indiving, SCIP_Nlp::initialguess, nlpDelNlRowPos(), nlpDelVarPos(), SCIP_Nlp::nnlrows, NULL, SCIP_Nlp::nvars, SCIP_CALL, SCIP_NLPSOLSTAT_UNKNOWN, SCIP_NLPTERMSTAT_OTHER, SCIP_OKAY, SCIPnlpEndDive(), SCIPnlpFlush(), SCIP_Nlp::sizevars, SCIP_Nlp::solstat, and SCIP_Nlp::termstat.

Referenced by SCIPnlpFree().

◆ SCIPnlpHasCurrentNodeNLP()

SCIP_Bool SCIPnlpHasCurrentNodeNLP ( SCIP_NLP * nlp )

currently a dummy function that always returns TRUE

Parameters

nlp NLP data

Definition at line 3664 of file nlp.c.

References NULL, and TRUE.

Referenced by SCIPgetNlRowActivity(), SCIPgetNlRowFeasibility(), SCIPgetNlRowSolActivity(), SCIPgetNlRowSolFeasibility(), and SCIPrecalcNlRowActivity().

◆ SCIPnlpEnsureVarsSize()

SCIP_RETCODE SCIPnlpEnsureVarsSize	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		int	num
	)

ensures, that variables array of NLP can store at least num entries

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
num	minimum number of entries to store

Definition at line 3673 of file nlp.c.

References BMSreallocBlockMemoryArray, SCIP_Nlp::initialguess, NULL, SCIP_Nlp::nvars, SCIP_ALLOC, SCIP_OKAY, SCIPsetCalcMemGrowSize(), SCIP_Nlp::sizevars, SCIP_Nlp::varlbdualvals, SCIP_Nlp::varmap_nlp2nlpi, SCIP_Nlp::vars, and SCIP_Nlp::varubdualvals.

Referenced by nlpAddVars().

◆ SCIPnlpAddVar()

SCIP_RETCODE SCIPnlpAddVar	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_VAR *	var
	)

adds a variable to the NLP and captures the variable

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
var	variable

Definition at line 3707 of file nlp.c.

References SCIP_Nlp::indiving, nlpAddVars(), NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIPhashmapExists(), SCIPvarIsTransformed(), and SCIP_Nlp::varhash.

Referenced by SCIP_DECL_EVENTEXEC().

◆ SCIPnlpAddVars()

SCIP_RETCODE SCIPnlpAddVars	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		int	nvars,
		SCIP_VAR **	vars
	)

adds a set of variables to the NLP and captures the variables

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
nvars	number of variables to add
vars	variables to add

Definition at line 3733 of file nlp.c.

References SCIP_Nlp::indiving, nlpAddVars(), NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, and SCIPerrorMessage.

Referenced by initSolve().

◆ SCIPnlpDelVar()

SCIP_RETCODE SCIPnlpDelVar	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_EVENTQUEUE *	eventqueue,
		SCIP_LP *	lp,
		SCIP_VAR *	var
	)

deletes a variable from the NLP and releases the variable

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
eventqueue	event queue
lp	SCIP LP, needed to release variable
var	variable

Definition at line 3758 of file nlp.c.

References SCIP_Nlp::indiving, nlpDelVarPos(), NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIPhashmapExists(), SCIPhashmapGetImageInt(), SCIPvarGetName(), and SCIP_Nlp::varhash.

Referenced by nlpRemoveFixedVar(), and SCIP_DECL_EVENTEXEC().

◆ SCIPnlpEnsureNlRowsSize()

SCIP_RETCODE SCIPnlpEnsureNlRowsSize	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		int	num
	)

ensures, that nonlinear rows array of NLP can store at least num entries

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
num	minimum number of entries to store

Definition at line 3795 of file nlp.c.

References BMSreallocBlockMemoryArray, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, NULL, SCIP_ALLOC, SCIP_OKAY, SCIPsetCalcMemGrowSize(), and SCIP_Nlp::sizenlrows.

Referenced by nlpAddNlRows().

◆ SCIPnlpAddNlRow()

SCIP_RETCODE SCIPnlpAddNlRow	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_NLROW *	nlrow
	)

adds a nonlinear row to the NLP and captures it

all variables of the row need to be present in the NLP

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
nlrow	nonlinear row

Definition at line 3825 of file nlp.c.

References SCIP_Nlp::indiving, nlpAddNlRows(), NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, and SCIPerrorMessage.

Referenced by SCIPaddNlRow().

◆ SCIPnlpAddNlRows()

SCIP_RETCODE SCIPnlpAddNlRows	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		int	nnlrows,
		SCIP_NLROW **	nlrows
	)

adds nonlinear rows to the NLP and captures them

all variables of the row need to be present in the NLP

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
nnlrows	number of rows to add
nlrows	rows to add

Definition at line 3851 of file nlp.c.

References SCIP_Nlp::indiving, nlpAddNlRows(), NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, and SCIPerrorMessage.

◆ SCIPnlpDelNlRow()

SCIP_RETCODE SCIPnlpDelNlRow	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_NLROW *	nlrow
	)

deletes a nonlinear row from the NLP

does nothing if nonlinear row is not in NLP

Parameters

nlp	NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
nlrow	nonlinear row

Definition at line 3881 of file nlp.c.

References SCIP_Nlp::indiving, nlpDelNlRowPos(), SCIP_NlRow::nlpindex, SCIP_Nlp::nnlrows, NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, and SCIPerrorMessage.

Referenced by SCIPdelNlRow().

◆ SCIPnlpFlush()

SCIP_RETCODE SCIPnlpFlush	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat
	)

applies all cached changes to the NLP solver

Parameters

nlp	current NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics

Definition at line 3913 of file nlp.c.

References SCIP_Nlp::indiving, nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), SCIP_Nlp::nnlrows, SCIP_Nlp::nnlrows_solver, NULL, SCIP_Nlp::nunflushednlrowadd, SCIP_Nlp::nunflushednlrowdel, SCIP_Nlp::nunflushedvaradd, SCIP_Nlp::nunflushedvardel, SCIP_Nlp::nvars, SCIP_Nlp::nvars_solver, SCIP_Nlp::objflushed, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, and TRUE.

Referenced by SCIPflushNLP(), SCIPnlpReset(), SCIPnlpSolve(), and SCIPnlpStartDive().

◆ SCIPnlpSolve()

SCIP_RETCODE SCIPnlpSolve	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_MESSAGEHDLR *	messagehdlr,
		SCIP_STAT *	stat,
		SCIP_PRIMAL *	primal,
		SCIP_TREE *	tree,
		SCIP_NLPPARAM *	nlpparam
	)

solves the NLP or diving NLP

Parameters

nlp	NLP data
blkmem	block memory buffers
set	global SCIP settings
messagehdlr	message handler
stat	problem statistics
primal	primal data
tree	branch and bound tree
nlpparam	NLP solve parameters

Definition at line 3951 of file nlp.c.

References SCIP_Nlp::indiving, nlpSolve(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPnlpFlush().

Referenced by SCIPsolveNLPParam().

◆ SCIPnlpGetObjval()

SCIP_Real SCIPnlpGetObjval ( SCIP_NLP * nlp )

gets objective value of current NLP

Parameters

nlp	current NLP data

Definition at line 3978 of file nlp.c.

References NULL, and SCIP_Nlp::primalsolobjval.

Referenced by SCIPgetNLPObjval(), and SCIPsolLinkNLPSol().

◆ SCIPnlpGetPseudoObjval()

SCIP_RETCODE SCIPnlpGetPseudoObjval	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_PROB *	prob,
		SCIP_PRIMAL *	primal,
		SCIP_TREE *	tree,
		SCIP_LP *	lp,
		SCIP_Real *	pseudoobjval
	)

gives current pseudo objective value

Parameters

nlp	current NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
prob	SCIP problem
primal	primal data
tree	branch and bound tree
lp	SCIP LP
pseudoobjval	buffer to store pseudo objective value

Definition at line 3988 of file nlp.c.

References SCIP_Nlp::divingobj, SCIP_Nlp::indiving, NULL, SCIP_Nlp::nvars, SCIP_CALL, SCIP_OKAY, SCIPnlrowGetPseudoActivity(), SCIPvarGetBestBoundLocal(), SCIPvarGetObj(), and SCIP_Nlp::vars.

◆ SCIPnlpGetFracVars()

SCIP_RETCODE SCIPnlpGetFracVars	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_VAR ***	fracvars,
		SCIP_Real **	fracvarssol,
		SCIP_Real **	fracvarsfrac,
		int *	nfracvars,
		int *	npriofracvars
	)

gets fractional variables of last NLP solution along with solution values and fractionalities

Parameters

nlp	NLP data structure
blkmem	block memory
set	global SCIP settings
stat	problem statistics
fracvars	pointer to store the array of NLP fractional variables, or NULL
fracvarssol	pointer to store the array of NLP fractional variables solution values, or NULL
fracvarsfrac	pointer to store the array of NLP fractional variables fractionalities, or NULL
nfracvars	pointer to store the number of NLP fractional variables , or NULL
npriofracvars	pointer to store the number of NLP fractional variables with maximal branching priority, or NULL

Definition at line 4022 of file nlp.c.

References SCIP_Nlp::fracvars, SCIP_Nlp::fracvarsfrac, SCIP_Nlp::fracvarssol, SCIP_Nlp::nfracvars, nlpCalcFracVars(), SCIP_Nlp::npriofracvars, NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPgetNLPFracVars().

◆ SCIPnlpRemoveRedundantNlRows()

SCIP_RETCODE SCIPnlpRemoveRedundantNlRows	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat
	)

removes all redundant nonlinear rows

Parameters

nlp	current NLP data
blkmem	block memory buffers
set	global SCIP settings
stat	problem statistics

Definition at line 4056 of file nlp.c.

References SCIP_Nlp::indiving, nlpDelNlRowPos(), SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, NULL, SCIP_Bool, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIPnlrowIsRedundant(), and SCIP_Nlp::solstat.

◆ SCIPnlpSetInitialGuess()

SCIP_RETCODE SCIPnlpSetInitialGuess	(	SCIP_SET *	set,
		SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_Real *	initguess
	)

set initial guess (approximate primal solution) for next solve

array initguess must be NULL or have length at least SCIPnlpGetNVars()

Parameters

set	global SCIP settings
nlp	current NLP data
blkmem	block memory buffers
initguess	new initial guess, or NULL to clear previous one

Definition at line 4102 of file nlp.c.

References BMSallocBlockMemoryArray, BMScopyMemoryArray, FALSE, SCIP_Nlp::haveinitguess, SCIP_Nlp::initialguess, NULL, SCIP_Nlp::nvars, SCIP_Nlp::problem, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, SCIPnlpiSetInitialGuess(), SCIP_Nlp::sizevars, SCIP_Nlp::solver, and TRUE.

Referenced by SCIPsetNLPInitialGuess(), and SCIPsetNLPInitialGuessSol().

◆ SCIPnlpWrite()

SCIP_RETCODE SCIPnlpWrite	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_MESSAGEHDLR *	messagehdlr,
		const char *	fname
	)

writes NLP to a file

Parameters

nlp	current NLP data
blkmem	block memory buffers
set	global SCIP settings
stat	problem statistics
messagehdlr	message handler
fname	file name

Definition at line 4138 of file nlp.c.

References SCIP_Nlp::name, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, NULL, SCIP_Nlp::nvars, SCIP_CALL, SCIP_FILECREATEERROR, SCIP_OKAY, SCIPerrorMessage, SCIPmessageFPrintInfo(), SCIPnlrowPrint(), SCIPvarPrint(), and SCIP_Nlp::vars.

Referenced by SCIPwriteNLP().

◆ SCIPnlpStartDive()

SCIP_RETCODE SCIPnlpStartDive	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat
	)

signals start of diving

Parameters

nlp	current NLP data
blkmem	block memory buffers
set	global SCIP settings
stat	problem statistics

Definition at line 4433 of file nlp.c.

References SCIP_Nlp::indiving, NULL, SCIP_CALL, SCIP_ERROR, SCIP_OKAY, SCIPerrorMessage, SCIPnlpFlush(), SCIP_Nlp::solver, and TRUE.

Referenced by SCIPstartDiveNLP().

◆ SCIPnlpEndDive()

SCIP_RETCODE SCIPnlpEndDive	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat
	)

resets the bound and objective changes made during diving and disables diving mode

Parameters

nlp	current NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data

Definition at line 4464 of file nlp.c.

References SCIP_Nlp::divingobj, FALSE, SCIP_Nlp::indiving, NULL, SCIP_Nlp::nvars, SCIP_Nlp::nvars_solver, SCIP_Nlp::objflushed, SCIP_Nlp::primalsolobjval, SCIP_Nlp::problem, SCIP_CALL, SCIP_ERROR, SCIP_INVALID, SCIP_NLPSOLSTAT_UNKNOWN, SCIP_NLPTERMSTAT_OTHER, SCIP_OKAY, SCIP_Real, SCIPerrorMessage, SCIPnlpiChgVarBounds(), SCIPnlrowRelease(), SCIPsetAllocBufferArray, SCIPsetFreeBufferArray, SCIPvarGetLbLocal(), SCIPvarGetUbLocal(), SCIP_Nlp::solstat, SCIP_Nlp::solver, SCIP_Nlp::termstat, SCIP_Nlp::varmap_nlpi2nlp, and SCIP_Nlp::vars.

Referenced by SCIPendDiveNLP(), and SCIPnlpReset().

◆ SCIPnlpChgVarObjDive()

SCIP_RETCODE SCIPnlpChgVarObjDive	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_VAR *	var,
		SCIP_Real	coef
	)

changes coefficient of variable in diving NLP

Parameters

nlp	current NLP data
blkmem	block memory
set	global SCIP settings
stat	problem statistics data
var	variable which coefficient to change
coef	new linear coefficient of variable in objective

Definition at line 4526 of file nlp.c.

References SCIP_Nlp::divingobj, FALSE, SCIP_Nlp::indiving, NULL, SCIP_Nlp::nvars, SCIP_Nlp::objflushed, SCIP_Nlp::problem, SCIP_CALL, SCIP_EXPRCURV_LINEAR, SCIP_OKAY, SCIP_Real, SCIPhashmapExists(), SCIPhashmapGetImageInt(), SCIPnlpiChgLinearCoefs(), SCIPnlrowChgLinearCoef(), SCIPnlrowCreate(), SCIPsetAllocBufferArray, SCIPsetFreeBufferArray, SCIPsetInfinity(), SCIPvarGetObj(), SCIP_Nlp::solver, SCIP_Nlp::varhash, SCIP_Nlp::varmap_nlp2nlpi, and SCIP_Nlp::vars.

Referenced by SCIPchgVarObjDiveNLP().

◆ SCIPnlpChgVarBoundsDive()

SCIP_RETCODE SCIPnlpChgVarBoundsDive	(	SCIP_SET *	set,
		SCIP_NLP *	nlp,
		SCIP_VAR *	var,
		SCIP_Real	lb,
		SCIP_Real	ub
	)

changes bounds of variable in diving NLP

Parameters

set	global SCIP settings
nlp	current NLP data
var	variable which coefficient to change
lb	new lower bound of variable
ub	new upper bound of variable

Definition at line 4583 of file nlp.c.

References SCIP_Nlp::indiving, NULL, SCIP_Nlp::problem, SCIP_CALL, SCIP_OKAY, SCIPhashmapExists(), SCIPhashmapGetImageInt(), SCIPnlpiChgVarBounds(), SCIP_Nlp::solver, SCIP_Nlp::varhash, and SCIP_Nlp::varmap_nlp2nlpi.

Referenced by SCIPchgVarBoundsDiveNLP().

◆ SCIPnlpChgVarsBoundsDive()

SCIP_RETCODE SCIPnlpChgVarsBoundsDive	(	SCIP_NLP *	nlp,
		SCIP_SET *	set,
		int	nvars,
		SCIP_VAR **	vars,
		SCIP_Real *	lbs,
		SCIP_Real *	ubs
	)

changes bounds of a set of variables in diving NLP

Parameters

nlp	current NLP data
set	global SCIP settings
nvars	number of variables which bounds to change
vars	variables which bounds to change
lbs	new lower bounds of variables
ubs	new upper bounds of variables

Definition at line 4612 of file nlp.c.

References SCIP_Nlp::indiving, NULL, SCIP_Nlp::problem, SCIP_CALL, SCIP_OKAY, SCIPhashmapExists(), SCIPhashmapGetImageInt(), SCIPnlpiChgVarBounds(), SCIPsetAllocBufferArray, SCIPsetFreeBufferArray, SCIP_Nlp::solver, SCIP_Nlp::varhash, and SCIP_Nlp::varmap_nlp2nlpi.

Referenced by SCIPchgVarsBoundsDiveNLP().

◆ SCIPnlpIsDivingObjChanged()

SCIP_Bool SCIPnlpIsDivingObjChanged ( SCIP_NLP * nlp )

returns whether the objective function has been changed during diving

Parameters

nlp	current NLP data

Definition at line 4656 of file nlp.c.

References SCIP_Nlp::divingobj, and NULL.

Referenced by SCIPsolLinkNLPSol().

◆ SCIPnlpGetVars()

SCIP_VAR** SCIPnlpGetVars ( SCIP_NLP * nlp )

gets array with variables of the NLP

Parameters

nlp	current NLP data

Definition at line 4191 of file nlp.c.

References NULL, and SCIP_Nlp::vars.

Referenced by SCIPgetNLPVars(), SCIPgetNLPVarsData(), SCIPsetNLPInitialGuessSol(), and SCIPsolLinkNLPSol().

◆ SCIPnlpGetNVars()

int SCIPnlpGetNVars ( SCIP_NLP * nlp )

gets current number of variables in NLP

Parameters

nlp	current NLP data

Definition at line 4201 of file nlp.c.

References NULL, and SCIP_Nlp::nvars.

Referenced by SCIPgetNLPVarsData(), SCIPgetNNLPVars(), SCIPsetNLPInitialGuessSol(), and SCIPsolLinkNLPSol().

◆ SCIPnlpGetVarsNonlinearity()

SCIP_RETCODE SCIPnlpGetVarsNonlinearity	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		int *	nlcount
	)

computes for each variables the number of NLP rows in which the variable appears in a nonlinear var

Parameters

nlp	current NLP data
blkmem	block memory buffers
set	global SCIP settings
stat	problem statistics
nlcount	an array of length at least SCIPnlpGetNVars() to store nonlinearity counts of variables

Definition at line 4211 of file nlp.c.

References BMSclearMemoryArray, SCIP_NlRow::expr, FALSE, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, NULL, SCIP_Nlp::nvars, SCIP_CALL, SCIP_EXPRITER_DFS, SCIP_OKAY, SCIPexprIsVar(), SCIPexpriterCreate(), SCIPexpriterFree(), SCIPexpriterGetNext(), SCIPexpriterInit(), SCIPexpriterIsEnd(), SCIPgetVarExprVar(), SCIPhashmapExists(), SCIPhashmapGetImageInt(), and SCIP_Nlp::varhash.

Referenced by SCIPgetNLPVarsNonlinearity().

◆ SCIPnlpHasContinuousNonlinearity()

SCIP_RETCODE SCIPnlpHasContinuousNonlinearity	(	SCIP_NLP *	nlp,
		BMS_BLKMEM *	blkmem,
		SCIP_SET *	set,
		SCIP_STAT *	stat,
		SCIP_Bool *	result
	)

indicates whether there exists a row that contains a continuous variable in a nonlinear term

Note: The method may have to touch every row and nonlinear term to compute its result.

Parameters

nlp	current NLP data
blkmem	block memory buffers
set	global SCIP settings
stat	problem statistics
result	buffer to store whether continuous variable present in an expression of any row