Scippy

SCIP

Solving Constraint Integer Programs

nlp.h File Reference

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)
 
void SCIPnlrowSetCurvature (SCIP_NLP *nlp, SCIP_SET *set, SCIP_NLROW *nlrow, SCIP_EXPRCURV curvature)
 
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_RealSCIPnlpGetVarsLbDualsol (SCIP_NLP *nlp)
 
SCIP_RealSCIPnlpGetVarsUbDualsol (SCIP_NLP *nlp)
 
SCIP_NLROW ** SCIPnlpGetNlRows (SCIP_NLP *nlp)
 
int SCIPnlpGetNNlRows (SCIP_NLP *nlp)
 
void SCIPnlpGetNlRowsStat (SCIP_NLP *nlp, int *nlinear, int *nconvexineq, int *nnonconvexineq, int *nnonlineareq)
 
SCIP_NLPISCIPnlpGetNLPI (SCIP_NLP *nlp)
 
SCIP_NLPIPROBLEMSCIPnlpGetNLPIProblem (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
setglobal SCIP settings
blkmemblock memory

Definition at line 3514 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
nlpNLP handler, call by reference
blkmemblock memory
setglobal SCIP settings
statproblem statistics
nameproblem name
nvars_estimatean estimate on the number of variables that may be added to the NLP later

Definition at line 3540 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
nlppointer to NLP data object
blkmemblock memory
setglobal SCIP settings
statproblem statistics
eventqueueevent queue
lpSCIP LP, needed for releasing variables

Definition at line 3664 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
eventqueueevent queue
lpSCIP LP, needed for releasing variables

Definition at line 3724 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
nlpNLP data

Definition at line 3766 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
numminimum number of entries to store

Definition at line 3775 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
varvariable

Definition at line 3809 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
nvarsnumber of variables to add
varsvariables to add

Definition at line 3835 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
eventqueueevent queue
lpSCIP LP, needed to release variable
varvariable

Definition at line 3860 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
numminimum number of entries to store

Definition at line 3897 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlrownonlinear row

Definition at line 3927 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nnlrowsnumber of rows to add
nlrowsrows to add

Definition at line 3953 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
nlpNLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlrownonlinear row

Definition at line 3983 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()

◆ 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
nlpNLP data
blkmemblock memory buffers
setglobal SCIP settings
messagehdlrmessage handler
statproblem statistics
primalprimal data
treebranch and bound tree
nlpparamNLP solve parameters

Definition at line 4053 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
nlpcurrent NLP data

Definition at line 4080 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
nlpcurrent NLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
probSCIP problem
primalprimal data
treebranch and bound tree
lpSCIP LP
pseudoobjvalbuffer to store pseudo objective value

Definition at line 4090 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
nlpNLP data structure
blkmemblock memory
setglobal SCIP settings
statproblem statistics
fracvarspointer to store the array of NLP fractional variables, or NULL
fracvarssolpointer to store the array of NLP fractional variables solution values, or NULL
fracvarsfracpointer to store the array of NLP fractional variables fractionalities, or NULL
nfracvarspointer to store the number of NLP fractional variables , or NULL
npriofracvarspointer to store the number of NLP fractional variables with maximal branching priority, or NULL

Definition at line 4124 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
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings
statproblem statistics

Definition at line 4158 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
setglobal SCIP settings
nlpcurrent NLP data
blkmemblock memory buffers
initguessnew initial guess, or NULL to clear previous one

Definition at line 4204 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
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings
statproblem statistics
messagehdlrmessage handler
fnamefile name

Definition at line 4240 of file nlp.c.

References SCIP_Nlp::name, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, NULL, SCIP_Nlp::nvars, SCIP_CALL, SCIP_CALL_TERMINATE, 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
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings
statproblem statistics

Definition at line 4561 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 
)

◆ 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
nlpcurrent NLP data
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
varvariable which coefficient to change
coefnew linear coefficient of variable in objective

Definition at line 4654 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
setglobal SCIP settings
nlpcurrent NLP data
varvariable which coefficient to change
lbnew lower bound of variable
ubnew upper bound of variable

Definition at line 4711 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
nlpcurrent NLP data
setglobal SCIP settings
nvarsnumber of variables which bounds to change
varsvariables which bounds to change
lbsnew lower bounds of variables
ubsnew upper bounds of variables

Definition at line 4740 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
nlpcurrent NLP data

Definition at line 4784 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
nlpcurrent NLP data

Definition at line 4295 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
nlpcurrent NLP data

Definition at line 4305 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
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings
statproblem statistics
nlcountan array of length at least SCIPnlpGetNVars() to store nonlinearity counts of variables

Definition at line 4315 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
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings
statproblem statistics
resultbuffer to store whether continuous variable present in an expression of any row

Definition at line 4369 of file nlp.c.

References SCIP_NlRow::expr, FALSE, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, NULL, SCIP_CALL, SCIP_EXPRITER_DFS, SCIP_OKAY, SCIP_VARTYPE_CONTINUOUS, SCIPexprIsVar(), SCIPexpriterCreate(), SCIPexpriterFree(), SCIPexpriterGetNext(), SCIPexpriterInit(), SCIPexpriterIsEnd(), SCIPexpriterRestartDFS(), SCIPgetVarExprVar(), SCIPvarGetType(), and TRUE.

Referenced by SCIPhasNLPContinuousNonlinearity().

◆ SCIPnlpGetVarsLbDualsol()

SCIP_Real* SCIPnlpGetVarsLbDualsol ( SCIP_NLP nlp)

gives dual solution values associated with lower bounds of NLP variables

Parameters
nlpcurrent NLP data

Definition at line 4412 of file nlp.c.

References NULL, and SCIP_Nlp::varlbdualvals.

Referenced by SCIPgetNLPVarsLbDualsol().

◆ SCIPnlpGetVarsUbDualsol()

SCIP_Real* SCIPnlpGetVarsUbDualsol ( SCIP_NLP nlp)

gives dual solution values associated with upper bounds of NLP variables

Parameters
nlpcurrent NLP data

Definition at line 4422 of file nlp.c.

References NULL, and SCIP_Nlp::varubdualvals.

Referenced by SCIPgetNLPVarsUbDualsol().

◆ SCIPnlpGetNlRows()

SCIP_NLROW** SCIPnlpGetNlRows ( SCIP_NLP nlp)

gets array with nonlinear rows of the NLP

Parameters
nlpcurrent NLP data

Definition at line 4432 of file nlp.c.

References SCIP_Nlp::nlrows, and NULL.

Referenced by SCIPgetNLPNlRows(), and SCIPgetNLPNlRowsData().

◆ SCIPnlpGetNNlRows()

int SCIPnlpGetNNlRows ( SCIP_NLP nlp)

gets current number of nonlinear rows in NLP

Parameters
nlpcurrent NLP data

Definition at line 4442 of file nlp.c.

References SCIP_Nlp::nnlrows, and NULL.

Referenced by SCIPgetNLPNlRowsData(), and SCIPgetNNLPNlRows().

◆ SCIPnlpGetNlRowsStat()

void SCIPnlpGetNlRowsStat ( SCIP_NLP nlp,
int *  nlinear,
int *  nconvexineq,
int *  nnonconvexineq,
int *  nnonlineareq 
)

gets statistics on convexity of nonlinear rows in NLP

Parameters
nlpcurrent NLP data
nlinearbuffer to store number of linear rows in NLP, or NULL
nconvexineqbuffer to store number of convex inequalities in NLP, or NULL
nnonconvexineqbuffer to store number of nonconvex inequalities in NLP, or NULL
nnonlineareqbuffer to store number of nonlinear equalities or ranged rows in NLP, or NULL

Definition at line 4452 of file nlp.c.

References SCIP_Nlp::nnlrowconvexineq, SCIP_Nlp::nnlrowlinear, SCIP_Nlp::nnlrownonconvexineq, SCIP_Nlp::nnlrownonlineareq, and NULL.

Referenced by SCIPgetNLPNlRowsStat().

◆ SCIPnlpGetNLPI()

SCIP_NLPI* SCIPnlpGetNLPI ( SCIP_NLP nlp)

gets the NLP solver interface

Parameters
nlpcurrent NLP data

Definition at line 4476 of file nlp.c.

References NULL, and SCIP_Nlp::solver.

Referenced by SCIPgetNLPI().

◆ SCIPnlpGetNLPIProblem()

SCIP_NLPIPROBLEM* SCIPnlpGetNLPIProblem ( SCIP_NLP nlp)

gets the NLP problem in the solver interface

Parameters
nlpcurrent NLP data

Definition at line 4486 of file nlp.c.

References NULL, and SCIP_Nlp::problem.

Referenced by SCIPgetNLPI().

◆ SCIPnlpIsDiving()

SCIP_Bool SCIPnlpIsDiving ( SCIP_NLP nlp)

indicates whether NLP is currently in diving mode

Parameters
nlpcurrent NLP data

Definition at line 4496 of file nlp.c.

References SCIP_Nlp::indiving, and NULL.

◆ SCIPnlpGetSolstat()

SCIP_NLPSOLSTAT SCIPnlpGetSolstat ( SCIP_NLP nlp)

gets solution status of current NLP

Parameters
nlpcurrent NLP data

Definition at line 4506 of file nlp.c.

References NULL, and SCIP_Nlp::solstat.

Referenced by SCIP_DECL_SEPAEXECLP(), SCIPgetNLPSolstat(), and SCIPlinkNLPSol().

◆ SCIPnlpGetTermstat()

SCIP_NLPTERMSTAT SCIPnlpGetTermstat ( SCIP_NLP nlp)

gets termination status of last NLP solve

Parameters
nlpcurrent NLP data

Definition at line 4516 of file nlp.c.

References NULL, and SCIP_Nlp::termstat.

Referenced by SCIPgetNLPTermstat().

◆ SCIPnlpGetStatistics()

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

gives statistics (number of iterations, solving time, ...) of last NLP solve

Parameters
setglobal SCIP settings
nlppointer to NLP datastructure
statisticspointer to store statistics

Definition at line 4526 of file nlp.c.

References NULL, SCIP_Nlp::problem, SCIP_CALL, SCIP_OKAY, SCIPnlpiGetStatistics(), and SCIP_Nlp::solver.

Referenced by SCIPgetNLPStatistics().

◆ SCIPnlpHasSolution()

SCIP_Bool SCIPnlpHasSolution ( SCIP_NLP nlp)

indicates whether a solution for the current NLP is available

The solution may be optimal, feasible, or infeasible. Thus, returns whether the NLP solution status is at most SCIP_NLPSOLSTAT_LOCINFEASIBLE.

Parameters
nlpcurrent NLP data

Definition at line 4547 of file nlp.c.

References NULL, SCIP_NLPSOLSTAT_LOCINFEASIBLE, and SCIP_Nlp::solstat.

Referenced by nlpCalcFracVars(), SCIPcreateNLPSol(), SCIPgetNlRowActivity(), SCIPgetNlRowFeasibility(), SCIPgetNlRowSolActivity(), SCIPgetNlRowSolFeasibility(), SCIPhasNLPSolution(), SCIPrecalcNlRowActivity(), and SCIPsolLinkNLPSol().