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_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

Expressions and Expression tree methods
SCIP_RETCODE SCIPexprtreeRemoveFixedVars (SCIP_EXPRTREE *tree, SCIP_SET *set, SCIP_Bool *changed, int *varpos, int *newvarsstart)
 
Nonlinear row methods
SCIP_RETCODE SCIPnlrowCreate (SCIP_NLROW **nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, const char *name, SCIP_Real constant, int nlinvars, SCIP_VAR **linvars, SCIP_Real *lincoefs, int nquadvars, SCIP_VAR **quadvars, int nquadelems, SCIP_QUADELEM *quadelems, SCIP_EXPRTREE *exprtree, SCIP_Real lhs, SCIP_Real rhs)
 
SCIP_RETCODE SCIPnlrowCreateCopy (SCIP_NLROW **nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_NLROW *sourcenlrow)
 
SCIP_RETCODE SCIPnlrowCreateFromRow (SCIP_NLROW **nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_ROW *row)
 
SCIP_RETCODE SCIPnlrowFree (SCIP_NLROW **nlrow, BMS_BLKMEM *blkmem)
 
SCIP_RETCODE SCIPnlrowPrint (SCIP_NLROW *nlrow, SCIP_MESSAGEHDLR *messagehdlr, FILE *file)
 
void SCIPnlrowCapture (SCIP_NLROW *nlrow)
 
SCIP_RETCODE SCIPnlrowRelease (SCIP_NLROW **nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set)
 
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 SCIPnlrowEnsureQuadVarsSize (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, int num)
 
SCIP_RETCODE SCIPnlrowAddQuadVar (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_VAR *var)
 
SCIP_RETCODE SCIPnlrowEnsureQuadElementsSize (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, int num)
 
SCIP_RETCODE SCIPnlrowAddQuadElement (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, SCIP_QUADELEM elem)
 
SCIP_RETCODE SCIPnlrowDelQuadElement (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, int idx1, int idx2)
 
SCIP_RETCODE SCIPnlrowChgQuadElem (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, SCIP_QUADELEM elem)
 
SCIP_RETCODE SCIPnlrowChgExprtree (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, SCIP_EXPRTREE *exprtree)
 
SCIP_RETCODE SCIPnlrowChgExprtreeParam (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, int paramidx, SCIP_Real paramval)
 
SCIP_RETCODE SCIPnlrowChgExprtreeParams (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, SCIP_Real *paramvals)
 
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 SCIPnlrowRemoveFixedVars (SCIP_NLROW *nlrow, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp)
 
SCIP_RETCODE SCIPnlrowRecalcNLPActivity (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp)
 
SCIP_RETCODE SCIPnlrowGetNLPActivity (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, SCIP_Real *activity)
 
SCIP_RETCODE SCIPnlrowGetNLPFeasibility (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_NLP *nlp, SCIP_Real *feasibility)
 
SCIP_RETCODE SCIPnlrowRecalcPseudoActivity (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat)
 
SCIP_RETCODE SCIPnlrowGetPseudoActivity (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_Real *pseudoactivity)
 
SCIP_RETCODE SCIPnlrowGetPseudoFeasibility (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_Real *pseudofeasibility)
 
SCIP_RETCODE SCIPnlrowGetSolActivity (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_SOL *sol, SCIP_Real *activity)
 
SCIP_RETCODE SCIPnlrowGetSolFeasibility (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_SOL *sol, SCIP_Real *feasibility)
 
SCIP_RETCODE SCIPnlrowGetActivityBounds (SCIP_NLROW *nlrow, SCIP_SET *set, SCIP_STAT *stat, SCIP_Real *minactivity, SCIP_Real *maxactivity)
 
SCIP_RETCODE SCIPnlrowIsRedundant (SCIP_NLROW *nlrow, 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_EVENTQUEUE *eventqueue, SCIP_LP *lp)
 
SCIP_RETCODE SCIPnlpReset (SCIP_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_SET *set, 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_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_NLROW *nlrow)
 
SCIP_RETCODE SCIPnlpFlush (SCIP_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_SET *set)
 
SCIP_RETCODE SCIPnlpSolve (SCIP_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_STAT *stat)
 
SCIP_Real SCIPnlpGetObjval (SCIP_NLP *nlp)
 
SCIP_RETCODE SCIPnlpGetPseudoObjval (SCIP_NLP *nlp, SCIP_SET *set, SCIP_STAT *stat, 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_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_Real *initguess)
 
SCIP_RETCODE SCIPnlpWrite (SCIP_NLP *nlp, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *fname)
 
SCIP_RETCODE SCIPnlpStartDive (SCIP_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_SET *set)
 
SCIP_RETCODE SCIPnlpEndDive (SCIP_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_SET *set)
 
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_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_RETCODE SCIPnlpSolveDive (SCIP_NLP *nlp, BMS_BLKMEM *blkmem, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_STAT *stat)
 
SCIP_VAR ** SCIPnlpGetVars (SCIP_NLP *nlp)
 
int SCIPnlpGetNVars (SCIP_NLP *nlp)
 
SCIP_RETCODE SCIPnlpGetVarsNonlinearity (SCIP_NLP *nlp, int *nlcount)
 
SCIP_Bool SCIPnlpHasContinuousNonlinearity (SCIP_NLP *nlp)
 
SCIP_RealSCIPnlpGetVarsLbDualsol (SCIP_NLP *nlp)
 
SCIP_RealSCIPnlpGetVarsUbDualsol (SCIP_NLP *nlp)
 
SCIP_NLROW ** SCIPnlpGetNlRows (SCIP_NLP *nlp)
 
int SCIPnlpGetNNlRows (SCIP_NLP *nlp)
 
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_NLP *nlp, SCIP_NLPSTATISTICS *statistics)
 
SCIP_Bool SCIPnlpHasSolution (SCIP_NLP *nlp)
 
SCIP_RETCODE SCIPnlpGetIntPar (SCIP_NLP *nlp, SCIP_NLPPARAM type, int *ival)
 
SCIP_RETCODE SCIPnlpSetIntPar (SCIP_NLP *nlp, SCIP_NLPPARAM type, int ival)
 
SCIP_RETCODE SCIPnlpGetRealPar (SCIP_NLP *nlp, SCIP_NLPPARAM type, SCIP_Real *dval)
 
SCIP_RETCODE SCIPnlpSetRealPar (SCIP_NLP *nlp, SCIP_NLPPARAM type, SCIP_Real dval)
 
SCIP_RETCODE SCIPnlpGetStringPar (SCIP_NLP *nlp, SCIP_NLPPARAM type, const char **sval)
 
SCIP_RETCODE SCIPnlpSetStringPar (SCIP_NLP *nlp, SCIP_NLPPARAM type, const char *sval)
 

Function Documentation

SCIP_RETCODE SCIPexprtreeRemoveFixedVars ( SCIP_EXPRTREE tree,
SCIP_SET set,
SCIP_Bool changed,
int *  varpos,
int *  newvarsstart 
)

removes fixed variables from an expression tree, so that at exit all variables are active

Parameters
treeexpression tree
setglobal SCIP settings
changedbuffer to store whether the tree was changed, i.e., whether there was a fixed variable
varposarray of length at least tree->nvars to store new indices of previously existing variables in expression tree, or -1 if variable was removed; set to NULL if not of interest
newvarsstartbuffer to store index in tree->vars array where new variables begin, or NULL if not of interest

Definition at line 223 of file nlp.c.

References SCIP_ExprTree::blkmem, BMSallocBlockMemoryArray, BMSclearMemoryArray, BMSfreeBlockMemoryArray, BMSreallocBlockMemoryArray, FALSE, NULL, SCIP_ExprTree::nvars, SCIP_ExprTree::root, SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_EXPR_CONST, SCIP_EXPR_VARIDX, SCIP_OKAY, SCIP_Real, SCIP_VARSTATUS_MULTAGGR, SCIPcalcHashtableSize(), SCIPexprCreate(), SCIPexprCreateLinear(), SCIPexprFreeDeep(), SCIPexprReindexVars(), SCIPexprtreeAddVars(), SCIPexprtreeRemoveFixedVars(), SCIPexprtreeSubstituteVars(), SCIPhashmapCreate(), SCIPhashmapExists(), SCIPhashmapFree(), SCIPhashmapGetImage(), SCIPhashmapInsert(), SCIPvarGetMultaggrConstant(), SCIPvarGetMultaggrNVars(), SCIPvarGetMultaggrScalars(), SCIPvarGetMultaggrVars(), SCIPvarGetProbvarSum(), SCIPvarGetStatus(), SCIPvarIsActive(), TRUE, and SCIP_ExprTree::vars.

Referenced by nlrowRemoveFixedExprtreeVars(), SCIPexprtreeRemoveFixedVars(), and SCIPnlrowChgExprtree().

SCIP_RETCODE SCIPnlrowCreate ( SCIP_NLROW **  nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
const char *  name,
SCIP_Real  constant,
int  nlinvars,
SCIP_VAR **  linvars,
SCIP_Real lincoefs,
int  nquadvars,
SCIP_VAR **  quadvars,
int  nquadelems,
SCIP_QUADELEM quadelems,
SCIP_EXPRTREE exprtree,
SCIP_Real  lhs,
SCIP_Real  rhs 
)

create a new nonlinear row the new row is already captured

Parameters
nlrowbuffer to store pointer to nonlinear row
blkmemblock memory
setglobal SCIP settings
namename of nonlinear row
constantconstant
nlinvarsnumber of linear variables
linvarslinear variables, or NULL if nlinvars == 0
lincoefslinear coefficients, or NULL if nlinvars == 0
nquadvarsnumber of variables in quadratic terms
quadvarsvariables in quadratic terms, or NULL if nquadvars == 0
nquadelemsnumber of entries in quadratic term matrix
quadelemselements of quadratic term matrix, or NULL if nquadelems == 0
exprtreeexpression tree, or NULL
lhsleft hand side
rhsright hand side

Definition at line 1995 of file nlp.c.

References BMSallocBlockMemory, BMSduplicateBlockMemoryArray, FALSE, MAX, MIN, nlrowSetupQuadVarsHash(), NULL, REALABS, SCIP_ALLOC, SCIP_CALL, SCIP_INVALID, SCIP_OKAY, SCIPexprtreeCopy(), SCIPnlrowCapture(), SCIPsetIsInfinity(), SCIPsetIsRelLE(), and TRUE.

Referenced by SCIPcreateEmptyNlRow(), SCIPcreateNlRow(), SCIPnlpChgVarObjDive(), SCIPnlrowCreateCopy(), and SCIPnlrowCreateFromRow().

SCIP_RETCODE SCIPnlrowCreateCopy ( SCIP_NLROW **  nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_NLROW sourcenlrow 
)
SCIP_RETCODE SCIPnlrowCreateFromRow ( SCIP_NLROW **  nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_ROW row 
)

create a new nonlinear row from a linear row the new row is already captured

Parameters
nlrowbuffer to store pointer to nonlinear row
blkmemblock memory
setglobal SCIP settings
rowthe linear row to copy

Definition at line 2177 of file nlp.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPcolGetVar(), SCIPnlrowCreate(), SCIProwGetCols(), SCIProwGetConstant(), SCIProwGetLhs(), SCIProwGetName(), SCIProwGetNNonz(), SCIProwGetRhs(), SCIProwGetVals(), SCIPsetAllocBufferArray, and SCIPsetFreeBufferArray.

Referenced by SCIPcreateNlRowFromRow().

SCIP_RETCODE SCIPnlrowFree ( SCIP_NLROW **  nlrow,
BMS_BLKMEM blkmem 
)

frees a nonlinear row

Parameters
nlrowpointer to NLP row
blkmemblock memory

Definition at line 2242 of file nlp.c.

References BMSfreeBlockMemory, BMSfreeBlockMemoryArray, BMSfreeBlockMemoryArrayNull, NULL, SCIP_CALL, SCIP_OKAY, SCIPexprtreeFree(), and SCIPhashmapFree().

Referenced by SCIPnlrowRelease().

void SCIPnlrowCapture ( SCIP_NLROW nlrow)

increases usage counter of NLP nonlinear row

Parameters
nlrownonlinear row to capture

Definition at line 2334 of file nlp.c.

References SCIP_NlRow::name, NULL, SCIP_NlRow::nuses, and SCIPdebugMessage.

Referenced by nlpAddNlRows(), SCIPcaptureNlRow(), and SCIPnlrowCreate().

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

decreases usage counter of NLP nonlinear row

Parameters
nlrownonlinear row to free
blkmemblock memory
setglobal SCIP settings

Definition at line 2346 of file nlp.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, and SCIPnlrowFree().

Referenced by nlpDelNlRowPos(), SCIPnlpEndDive(), and SCIPreleaseNlRow().

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

ensures, that linear coefficient array of nonlinear row can store at least num entries

Parameters
nlrowNLP row
blkmemblock memory
setglobal SCIP settings
numminimum number of entries to store

Definition at line 2370 of file nlp.c.

References BMSreallocBlockMemoryArray, SCIP_NlRow::lincoefs, SCIP_NlRow::linvars, SCIP_NlRow::linvarssize, SCIP_NlRow::nlinvars, NULL, SCIP_ALLOC, SCIP_OKAY, and SCIPsetCalcMemGrowSize().

Referenced by nlrowAddLinearCoef(), and nlrowRemoveFixedLinearCoefPos().

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

adds a previously non existing linear coefficient to an NLP nonlinear row

Parameters
nlrowNLP nonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
varvariable
valvalue of coefficient

Definition at line 2395 of file nlp.c.

References SCIP_NlRow::constant, SCIP_NlRow::nlpindex, nlrowAddLinearCoef(), SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIP_VARSTATUS_MULTAGGR, SCIPnlrowAddLinearCoef(), SCIPnlrowChgConstant(), SCIPvarGetMultaggrNVars(), SCIPvarGetMultaggrScalars(), SCIPvarGetMultaggrVars(), SCIPvarGetProbvarSum(), SCIPvarGetStatus(), and SCIPvarIsActive().

Referenced by SCIPaddLinearCoefsToNlRow(), SCIPaddLinearCoefToNlRow(), and SCIPnlrowAddLinearCoef().

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

deletes linear coefficient from nonlinear row

Parameters
nlrownonlinear row to be changed
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
varcoefficient to be deleted

Definition at line 2443 of file nlp.c.

References SCIP_NlRow::linvars, SCIP_NlRow::name, SCIP_NlRow::nlpindex, nlrowDelLinearCoefPos(), nlrowSearchLinearCoef(), NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPerrorMessage, SCIPvarGetName(), and SCIPvarIsActive().

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

changes or adds a linear coefficient to a nonlinear row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
varvariable
coefnew value of coefficient

Definition at line 2476 of file nlp.c.

References nlrowAddLinearCoef(), nlrowChgLinearCoefPos(), nlrowSearchLinearCoef(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetIsZero().

Referenced by SCIPchgNlRowLinearCoef(), and SCIPnlpChgVarObjDive().

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

ensures, that quadratic variables array of nonlinear row can store at least num entries

Parameters
nlrowNLP row
blkmemblock memory
setglobal SCIP settings
numminimum number of entries to store

Definition at line 2514 of file nlp.c.

References BMSreallocBlockMemoryArray, SCIP_NlRow::nquadvars, NULL, SCIP_NlRow::quadvars, SCIP_NlRow::quadvarssize, SCIP_ALLOC, SCIP_OKAY, and SCIPsetCalcMemGrowSize().

Referenced by SCIPaddQuadVarsToNlRow(), and SCIPnlrowAddQuadVar().

SCIP_RETCODE SCIPnlrowAddQuadVar ( SCIP_NLROW nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_VAR var 
)

adds variable to quadvars array of row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
varvariable to search for

Definition at line 2538 of file nlp.c.

References SCIP_NlRow::nlpindex, nlrowSetupQuadVarsHash(), SCIP_NlRow::nquadvars, NULL, SCIP_NlRow::quadvars, SCIP_NlRow::quadvarshash, SCIP_CALL, SCIP_OKAY, SCIPhashmapInsert(), SCIPnlrowEnsureQuadVarsSize(), SCIPnlrowSearchQuadVar(), and SCIPvarIsActive().

Referenced by nlrowRemoveFixedQuadVars(), SCIPaddQuadVarsToNlRow(), and SCIPaddQuadVarToNlRow().

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

ensures, that quadratic elements array of nonlinear row can store at least num entries

Parameters
nlrowNLP row
blkmemblock memory
setglobal SCIP settings
numminimum number of entries to store

Definition at line 2573 of file nlp.c.

References BMSreallocBlockMemoryArray, SCIP_NlRow::nquadelems, NULL, SCIP_NlRow::quadelems, SCIP_NlRow::quadelemssize, SCIP_ALLOC, SCIP_OKAY, and SCIPsetCalcMemGrowSize().

Referenced by nlrowAddQuadElement(), and SCIPaddQuadElementsToNlRow().

SCIP_RETCODE SCIPnlrowAddQuadElement ( SCIP_NLROW nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
SCIP_QUADELEM  elem 
)

adds a previously non existing quadratic element to an NLP nonlinear row

Parameters
nlrowNLP nonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
elemquadratic element to add

Definition at line 2597 of file nlp.c.

References nlrowAddQuadElement(), SCIP_CALL, and SCIP_OKAY.

Referenced by nlrowRemoveFixedQuadVars(), SCIPaddQuadElementsToNlRow(), and SCIPaddQuadElementToNlRow().

SCIP_RETCODE SCIPnlrowDelQuadElement ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
int  idx1,
int  idx2 
)

deletes quadratic element from nonlinear row

Parameters
nlrownonlinear row to be changed
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
idx1index of first variable in element
idx2index of second variable in element

Definition at line 2612 of file nlp.c.

References SCIP_NlRow::name, nlrowDelQuadElemPos(), nlrowSearchQuadElem(), NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, and SCIPerrorMessage.

SCIP_RETCODE SCIPnlrowChgQuadElem ( SCIP_NLROW nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
SCIP_QUADELEM  elem 
)

changes or adds a quadratic element to a nonlinear row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
elemnew quadratic element

Definition at line 2646 of file nlp.c.

References SCIP_QuadElement::coef, SCIP_QuadElement::idx1, SCIP_QuadElement::idx2, nlrowAddQuadElement(), nlrowChgQuadElemPos(), nlrowSearchQuadElem(), NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPchgNlRowQuadElement().

SCIP_RETCODE SCIPnlrowChgExprtree ( SCIP_NLROW nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
SCIP_EXPRTREE exprtree 
)

replaces or deletes an expression tree in nonlinear row

replaces an expression tree in nonlinear row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
exprtreenew expression tree

Definition at line 2678 of file nlp.c.

References SCIP_NlRow::exprtree, SCIP_NlRow::nlpindex, nlrowExprtreeChanged(), NULL, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPexprtreeCopy(), SCIPexprtreeFree(), and SCIPexprtreeRemoveFixedVars().

Referenced by SCIPsetNlRowExprtree().

SCIP_RETCODE SCIPnlrowChgExprtreeParam ( SCIP_NLROW nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
int  paramidx,
SCIP_Real  paramval 
)

changes a parameter in an expression of a nonlinear row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
paramidxindex of parameter in expression tree's parameter array
paramvalnew value of parameter

Definition at line 2717 of file nlp.c.

References SCIP_NlRow::exprtree, nlrowExprtreeParamChanged(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPexprtreeSetParamVal().

Referenced by SCIPsetNlRowExprtreeParam().

SCIP_RETCODE SCIPnlrowChgExprtreeParams ( SCIP_NLROW nlrow,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
SCIP_Real paramvals 
)

changes all parameters in an expression of a nonlinear row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
paramvalsnew values of parameters

Definition at line 2740 of file nlp.c.

References SCIP_NlRow::exprtree, nlrowExprtreeParamChanged(), NULL, SCIP_CALL, SCIP_OKAY, SCIPexprtreeGetNParams(), and SCIPexprtreeSetParams().

Referenced by SCIPsetNlRowExprtreeParams().

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

changes constant of nonlinear row

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
constantnew constant

Definition at line 2762 of file nlp.c.

References SCIP_NlRow::constant, nlrowConstantChanged(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetIsEQ().

Referenced by nlrowRemoveFixedExprtreeVars(), SCIPchgNlRowConstant(), and SCIPnlrowAddLinearCoef().

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

changes left hand side of nonlinear row

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
lhsnew left hand side

Definition at line 2782 of file nlp.c.

References SCIP_NlRow::lhs, nlrowSideChanged(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPsetIsEQ().

Referenced by SCIPchgNlRowLhs().

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

changes right hand side of nonlinear row

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data
rhsnew right hand side

Definition at line 2802 of file nlp.c.

References nlrowSideChanged(), NULL, SCIP_NlRow::rhs, SCIP_CALL, SCIP_OKAY, and SCIPsetIsEQ().

Referenced by SCIPchgNlRowRhs().

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

removes (or substitutes) all fixed, negated, aggregated, multi-aggregated variables from the linear, quadratic, and nonquadratic terms of a nonlinear row

removes (or substitutes) all fixed, negated, aggregated, multi-aggregated variables from the linear, quadratic, and non-quadratic terms of a nonlinear row

Parameters
nlrownonlinear row
blkmemblock memory
setglobal SCIP settings
statproblem statistics data
nlpcurrent NLP data

Definition at line 2822 of file nlp.c.

References nlrowRemoveFixedExprtreeVars(), nlrowRemoveFixedLinearCoefs(), nlrowRemoveFixedQuadVars(), SCIP_CALL, and SCIP_OKAY.

Referenced by nlpAddNlRows().

SCIP_RETCODE SCIPnlrowGetNLPActivity ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
SCIP_Real activity 
)

gives the activity of a nonlinear row in the current NLP solution

returns the activity of a nonlinear row in the current NLP solution

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics
nlpcurrent NLP data
activitybuffer to store activity value

Definition at line 2915 of file nlp.c.

References SCIP_NlRow::activity, SCIP_Stat::nnlps, NULL, SCIP_CALL, SCIP_INVALID, SCIP_OKAY, SCIPnlrowRecalcNLPActivity(), and SCIP_NlRow::validactivitynlp.

Referenced by nlpSolve(), SCIPgetNlRowActivity(), SCIPgetNlRowNLPActivity(), SCIPgetNlRowSolActivity(), and SCIPnlrowGetNLPFeasibility().

SCIP_RETCODE SCIPnlrowGetNLPFeasibility ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_NLP nlp,
SCIP_Real feasibility 
)

gives the feasibility of a nonlinear row in the current NLP solution: negative value means infeasibility

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics
nlpcurrent NLP data
feasibilitybuffer to store feasibility value

Definition at line 2942 of file nlp.c.

References SCIP_NlRow::lhs, MIN, NULL, SCIP_NlRow::rhs, SCIP_CALL, SCIP_OKAY, SCIP_Real, and SCIPnlrowGetNLPActivity().

Referenced by nlpAddNlRows(), nlpRowChanged(), SCIPgetNlRowFeasibility(), SCIPgetNlRowNLPFeasibility(), and SCIPgetNlRowSolFeasibility().

SCIP_RETCODE SCIPnlrowGetPseudoActivity ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_Real pseudoactivity 
)

returns the pseudo activity of a nonlinear row in the current pseudo solution

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics
pseudoactivitybuffer to store pseudo activity value

Definition at line 3017 of file nlp.c.

References SCIP_Stat::domchgcount, NULL, SCIP_NlRow::pseudoactivity, SCIP_CALL, SCIP_INVALID, SCIP_OKAY, SCIPnlrowRecalcPseudoActivity(), and SCIP_NlRow::validpsactivitydomchg.

Referenced by SCIPgetNlRowActivity(), SCIPgetNlRowPseudoActivity(), SCIPgetNlRowSolActivity(), SCIPnlpGetPseudoObjval(), and SCIPnlrowGetPseudoFeasibility().

SCIP_RETCODE SCIPnlrowGetPseudoFeasibility ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_Real pseudofeasibility 
)

returns the pseudo feasibility of a nonlinear row in the current pseudo solution: negative value means infeasibility

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics
pseudofeasibilitybuffer to store pseudo feasibility value

Definition at line 3043 of file nlp.c.

References SCIP_NlRow::lhs, MIN, NULL, SCIP_NlRow::rhs, SCIP_CALL, SCIP_OKAY, SCIP_Real, and SCIPnlrowGetPseudoActivity().

Referenced by SCIPgetNlRowFeasibility(), SCIPgetNlRowPseudoFeasibility(), and SCIPgetNlRowSolFeasibility().

SCIP_RETCODE SCIPnlrowGetSolActivity ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_SOL sol,
SCIP_Real activity 
)
SCIP_RETCODE SCIPnlrowGetSolFeasibility ( SCIP_NLROW nlrow,
SCIP_SET set,
SCIP_STAT stat,
SCIP_SOL sol,
SCIP_Real feasibility 
)

returns the feasibility of a nonlinear row for the given solution

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics data
solprimal CIP solution
feasibilitybuffer to store feasibility value

Definition at line 3148 of file nlp.c.

References SCIP_NlRow::lhs, MIN, NULL, SCIP_NlRow::rhs, SCIP_CALL, SCIP_OKAY, SCIP_Real, and SCIPnlrowGetSolActivity().

Referenced by SCIPgetNlRowSolFeasibility().

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

returns the minimal activity of a nonlinear row w.r.t. the variables' bounds

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics data
minactivitybuffer to store minimal activity, or NULL
maxactivitybuffer to store maximal activity, or NULL

Definition at line 3169 of file nlp.c.

References SCIP_Stat::domchgcount, SCIP_NlRow::maxactivity, SCIP_NlRow::minactivity, nlrowCalcActivityBounds(), NULL, SCIP_CALL, SCIP_INVALID, SCIP_OKAY, and SCIP_NlRow::validactivitybdsdomchg.

Referenced by SCIPgetNlRowActivityBounds(), and SCIPnlrowIsRedundant().

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

returns whether the nonlinear row is redundant w.r.t. the variables' bounds

Parameters
nlrownonlinear row
setglobal SCIP settings
statproblem statistics data
isredundantbuffer to store whether row is redundant

Definition at line 3200 of file nlp.c.

References FALSE, SCIP_NlRow::lhs, NULL, SCIP_NlRow::rhs, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIPnlrowGetActivityBounds(), SCIPsetIsFeasGT(), SCIPsetIsFeasLT(), SCIPsetIsInfinity(), and TRUE.

Referenced by SCIPnlpRemoveRedundantNlRows().

SCIP_RETCODE SCIPnlpInclude ( SCIP_SET set,
BMS_BLKMEM blkmem 
)

includes event handler that is used by NLP

includes NLP specific plugins (e.g., event handler) and parameters

Parameters
setglobal SCIP settings
blkmemblock memory

Definition at line 4988 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 SCIPcreate().

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 5013 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, SCIPcalcHashtableSize(), SCIPerrorMessage, SCIPeventfilterAdd(), SCIPhashmapCreate(), SCIPnlpiCreateProblem(), SCIPsetFindEventhdlr(), SCIPsetFindNlpi(), SCIPsetSortNlpis(), and TRUE.

Referenced by initSolve().

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

frees NLP data object

Parameters
nlppointer to NLP data object
blkmemblock memory
setglobal SCIP settings
eventqueueevent queue
lpSCIP LP, needed for releasing variables

Definition at line 5134 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 freeSolve().

SCIP_RETCODE SCIPnlpReset ( SCIP_NLP nlp,
BMS_BLKMEM blkmem,
SCIP_SET set,
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
eventqueueevent queue
lpSCIP LP, needed for releasing variables

Definition at line 5193 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::solstat, and SCIP_Nlp::termstat.

Referenced by SCIPnlpFree().

SCIP_Bool SCIPnlpHasCurrentNodeNLP ( SCIP_NLP nlp)

currently a dummy function that always returns TRUE

Parameters
nlpNLP data

Definition at line 5234 of file nlp.c.

References TRUE.

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

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 5242 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().

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 5276 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().

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 5302 of file nlp.c.

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

Referenced by initSolve().

SCIP_RETCODE SCIPnlpDelVar ( SCIP_NLP nlp,
BMS_BLKMEM blkmem,
SCIP_SET set,
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
eventqueueevent queue
lpSCIP LP, needed to release variable
varvariable

Definition at line 5327 of file nlp.c.

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

Referenced by nlpRemoveFixedVar(), and SCIP_DECL_EVENTEXEC().

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 5363 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().

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 5391 of file nlp.c.

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

Referenced by SCIPaddNlRow().

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 5415 of file nlp.c.

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

SCIP_RETCODE SCIPnlpDelNlRow ( SCIP_NLP nlp,
BMS_BLKMEM blkmem,
SCIP_SET set,
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
nlrownonlinear row

Definition at line 5443 of file nlp.c.

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

SCIP_RETCODE SCIPnlpSolve ( SCIP_NLP nlp,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_STAT stat 
)

solves the NLP

Parameters
nlpNLP data
blkmemblock memory buffers
setglobal SCIP settings
messagehdlrmessage handler
statproblem statistics

Definition at line 5511 of file nlp.c.

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

Referenced by SCIPsolveNLP().

SCIP_Real SCIPnlpGetObjval ( SCIP_NLP nlp)

gets objective value of current NLP

Parameters
nlpcurrent NLP data

Definition at line 5538 of file nlp.c.

References NULL, and SCIP_Nlp::primalsolobjval.

Referenced by SCIPgetNLPObjval(), and SCIPsolLinkNLPSol().

SCIP_RETCODE SCIPnlpGetPseudoObjval ( SCIP_NLP nlp,
SCIP_SET set,
SCIP_STAT stat,
SCIP_Real pseudoobjval 
)

gives current pseudo objective value

Parameters
nlpcurrent NLP data
setglobal SCIP settings
statproblem statistics
pseudoobjvalbuffer to store pseudo objective value

Definition at line 5548 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.

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 5577 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().

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 5611 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.

SCIP_RETCODE SCIPnlpSetInitialGuess ( 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
nlpcurrent NLP data
blkmemblock memory buffers
initguessnew initial guess, or NULL to clear previous one

Definition at line 5657 of file nlp.c.

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

Referenced by SCIPsetNLPInitialGuess(), and SCIPsetNLPInitialGuessSol().

SCIP_RETCODE SCIPnlpWrite ( SCIP_NLP nlp,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
const char *  fname 
)

writes NLP to a file

Parameters
nlpcurrent NLP data
setglobal SCIP settings
messagehdlrmessage handler
fnamefile name

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

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

signals start of diving

Parameters
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings

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

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 6169 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_OKAY, SCIP_Real, SCIPhashmapExists(), SCIPhashmapGetImage(), SCIPnlpiChgLinearCoefs(), SCIPnlrowChgLinearCoef(), SCIPnlrowCreate(), SCIPsetAllocBufferArray, SCIPsetFreeBufferArray, SCIPsetInfinity(), SCIPvarGetObj(), SCIP_Nlp::solver, SCIP_Nlp::varhash, SCIP_Nlp::varmap_nlp2nlpi, and SCIP_Nlp::vars.

Referenced by SCIPchgVarObjDiveNLP().

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

changes bounds of variable in diving NLP

Parameters
nlpcurrent NLP data
varvariable which coefficient to change
lbnew lower bound of variable
ubnew upper bound of variable

Definition at line 6228 of file nlp.c.

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

Referenced by SCIPchgVarBoundsDiveNLP().

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 6256 of file nlp.c.

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

Referenced by SCIPchgVarsBoundsDiveNLP().

SCIP_Bool SCIPnlpIsDivingObjChanged ( SCIP_NLP nlp)

returns whether the objective function has been changed during diving

Parameters
nlpcurrent NLP data

Definition at line 6300 of file nlp.c.

References SCIP_Nlp::divingobj, and NULL.

Referenced by SCIPsolLinkNLPSol().

SCIP_RETCODE SCIPnlpSolveDive ( SCIP_NLP nlp,
BMS_BLKMEM blkmem,
SCIP_SET set,
SCIP_MESSAGEHDLR messagehdlr,
SCIP_STAT stat 
)

solves diving NLP

Parameters
nlpcurrent NLP data
blkmemblock memory buffers
setglobal SCIP settings
messagehdlrmessage handler
statproblem statistics

Definition at line 6308 of file nlp.c.

References nlpSolve(), SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPsolveDiveNLP().

SCIP_VAR** SCIPnlpGetVars ( SCIP_NLP nlp)

gets array with variables of the NLP

Parameters
nlpcurrent NLP data

Definition at line 5741 of file nlp.c.

References NULL, and SCIP_Nlp::vars.

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

int SCIPnlpGetNVars ( SCIP_NLP nlp)

gets current number of variables in NLP

Parameters
nlpcurrent NLP data

Definition at line 5751 of file nlp.c.

References NULL, and SCIP_Nlp::nvars.

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

SCIP_RETCODE SCIPnlpGetVarsNonlinearity ( SCIP_NLP nlp,
int *  nlcount 
)

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

Parameters
nlpcurrent NLP data
nlcountan array of length at least SCIPnlpGetNVars() to store nonlinearity counts of variables

Definition at line 5761 of file nlp.c.

References BMSclearMemoryArray, SCIP_NlRow::exprtree, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, SCIP_NlRow::nquadvars, NULL, SCIP_Nlp::nvars, SCIP_NlRow::quadvars, SCIP_NlRow::quadvarshash, SCIP_OKAY, SCIPexprtreeGetNVars(), SCIPexprtreeGetVars(), SCIPhashmapExists(), SCIPhashmapGetImage(), and SCIP_Nlp::varhash.

Referenced by SCIPgetNLPVarsNonlinearity().

SCIP_Bool SCIPnlpHasContinuousNonlinearity ( SCIP_NLP nlp)

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

Definition at line 5820 of file nlp.c.

References SCIP_NlRow::exprtree, FALSE, SCIP_Nlp::nlrows, SCIP_Nlp::nnlrows, SCIP_NlRow::nquadvars, NULL, SCIP_NlRow::quadvars, SCIP_VARTYPE_CONTINUOUS, SCIPexprtreeGetNVars(), SCIPexprtreeGetVars(), SCIPvarGetType(), and TRUE.

Referenced by SCIPhasNLPContinuousNonlinearity().

SCIP_Real* SCIPnlpGetVarsLbDualsol ( SCIP_NLP nlp)

gives dual solution values associated with lower bounds of NLP variables

Parameters
nlpcurrent NLP data

Definition at line 5858 of file nlp.c.

References NULL, and SCIP_Nlp::varlbdualvals.

Referenced by SCIPgetNLPVarsLbDualsol().

SCIP_Real* SCIPnlpGetVarsUbDualsol ( SCIP_NLP nlp)

gives dual solution values associated with upper bounds of NLP variables

Parameters
nlpcurrent NLP data

Definition at line 5868 of file nlp.c.

References NULL, and SCIP_Nlp::varubdualvals.

Referenced by SCIPgetNLPVarsUbDualsol().

SCIP_NLROW** SCIPnlpGetNlRows ( SCIP_NLP nlp)

gets array with nonlinear rows of the NLP

Parameters
nlpcurrent NLP data

Definition at line 5878 of file nlp.c.

References SCIP_Nlp::nlrows, and NULL.

Referenced by SCIPgetNLPNlRows(), and SCIPgetNLPNlRowsData().

int SCIPnlpGetNNlRows ( SCIP_NLP nlp)

gets current number of nonlinear rows in NLP

Parameters
nlpcurrent NLP data

Definition at line 5888 of file nlp.c.

References SCIP_Nlp::nnlrows, and NULL.

Referenced by SCIPgetNLPNlRowsData(), and SCIPgetNNLPNlRows().

SCIP_NLPI* SCIPnlpGetNLPI ( SCIP_NLP nlp)

gets the NLP solver interface

Parameters
nlpcurrent NLP data

Definition at line 5898 of file nlp.c.

References NULL, and SCIP_Nlp::solver.

Referenced by SCIPgetNLPI().

SCIP_NLPIPROBLEM* SCIPnlpGetNLPIProblem ( SCIP_NLP nlp)

gets the NLP problem in the solver interface

Parameters
nlpcurrent NLP data

Definition at line 5908 of file nlp.c.

References NULL, and SCIP_Nlp::problem.

Referenced by SCIPgetNLPI().

SCIP_Bool SCIPnlpIsDiving ( SCIP_NLP nlp)

indicates whether NLP is currently in diving mode

Parameters
nlpcurrent NLP data

Definition at line 5918 of file nlp.c.

References SCIP_Nlp::indiving, and NULL.

SCIP_NLPSOLSTAT SCIPnlpGetSolstat ( SCIP_NLP nlp)

gets solution status of current NLP

Parameters
nlpcurrent NLP data

Definition at line 5928 of file nlp.c.

References NULL, and SCIP_Nlp::solstat.

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

SCIP_NLPTERMSTAT SCIPnlpGetTermstat ( SCIP_NLP nlp)

gets termination status of last NLP solve

Parameters
nlpcurrent NLP data

Definition at line 5938 of file nlp.c.

References NULL, and SCIP_Nlp::termstat.

Referenced by SCIPgetNLPTermstat().

SCIP_RETCODE SCIPnlpGetStatistics ( SCIP_NLP nlp,
SCIP_NLPSTATISTICS statistics 
)

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

Parameters
nlppointer to NLP datastructure
statisticspointer to store statistics

Definition at line 5948 of file nlp.c.

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

Referenced by SCIPgetNLPStatistics().

SCIP_Bool SCIPnlpHasSolution ( SCIP_NLP nlp)

indicates whether a feasible solution for the current NLP is available thus, returns whether the solution status <= feasible

Parameters
nlpcurrent NLP data

Definition at line 5965 of file nlp.c.

References NULL, SCIP_NLPSOLSTAT_FEASIBLE, and SCIP_Nlp::solstat.

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

SCIP_RETCODE SCIPnlpGetIntPar ( SCIP_NLP nlp,
SCIP_NLPPARAM  type,
int *  ival 
)

gets integer parameter of NLP

Parameters
nlppointer to NLP datastructure
typeparameter number
ivalpointer to store the parameter value

Definition at line 5975 of file nlp.c.

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

Referenced by SCIPgetNLPIntPar().

SCIP_RETCODE SCIPnlpSetIntPar ( SCIP_NLP nlp,
SCIP_NLPPARAM  type,
int  ival 
)

sets integer parameter of NLP

Parameters
nlppointer to NLP datastructure
typeparameter number
ivalparameter value

Definition at line 5992 of file nlp.c.

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

Referenced by SCIPsetNLPIntPar().

SCIP_RETCODE SCIPnlpGetRealPar ( SCIP_NLP nlp,
SCIP_NLPPARAM  type,
SCIP_Real dval 
)

gets floating point parameter of NLP

Parameters
nlppointer to NLP datastructure
typeparameter number
dvalpointer to store the parameter value

Definition at line 6008 of file nlp.c.

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

Referenced by SCIPgetNLPRealPar().

SCIP_RETCODE SCIPnlpSetRealPar ( SCIP_NLP nlp,
SCIP_NLPPARAM  type,
SCIP_Real  dval 
)

sets floating point parameter of NLP

Parameters
nlppointer to NLP datastructure
typeparameter number
dvalparameter value

Definition at line 6025 of file nlp.c.

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

Referenced by SCIPsetNLPRealPar().

SCIP_RETCODE SCIPnlpGetStringPar ( SCIP_NLP nlp,
SCIP_NLPPARAM  type,
const char **  sval 
)

gets string parameter of NLP

Parameters
nlppointer to NLP datastructure
typeparameter number
svalpointer to store the parameter value

Definition at line 6041 of file nlp.c.

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

Referenced by SCIPgetNLPStringPar().

SCIP_RETCODE SCIPnlpSetStringPar ( SCIP_NLP nlp,
SCIP_NLPPARAM  type,
const char *  sval 
)

sets string parameter of NLP

Parameters
nlppointer to NLP datastructure
typeparameter number
svalparameter value

Definition at line 6058 of file nlp.c.

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

Referenced by SCIPsetNLPStringPar().