Scippy

SCIP

Solving Constraint Integer Programs

Data Fields
SCIP_Nlp Struct Reference

Detailed Description

current NLP data

Definition at line 109 of file struct_nlp.h.

#include <struct_nlp.h>

Data Fields

SCIP_NLPI * solver
 
SCIP_NLPIPROBLEM * problem
 
int nunflushedvaradd
 
int nunflushedvardel
 
int nunflushednlrowadd
 
int nunflushednlrowdel
 
SCIP_Bool isrelax
 
SCIP_Bool indiving
 
int nvars
 
int sizevars
 
SCIP_VAR ** vars
 
SCIP_HASHMAP * varhash
 
int nvars_solver
 
int sizevars_solver
 
int * varmap_nlp2nlpi
 
int * varmap_nlpi2nlp
 
int nnlrows
 
int sizenlrows
 
SCIP_NLROW ** nlrows
 
int nnlrows_solver
 
int sizenlrows_solver
 
int * nlrowmap_nlpi2nlp
 
SCIP_Bool objflushed
 
SCIP_NLROW * divingobj
 
SCIP_Bool haveinitguess
 
SCIP_Real * initialguess
 
SCIP_Real primalsolobjval
 
SCIP_NLPSOLSTAT solstat
 
SCIP_NLPTERMSTAT termstat
 
SCIP_Real * varlbdualvals
 
SCIP_Real * varubdualvals
 
SCIP_EVENTHDLR * eventhdlr
 
int globalfilterpos
 
SCIP_VAR ** fracvars
 
SCIP_Real * fracvarssol
 
SCIP_Real * fracvarsfrac
 
int nfracvars
 
int npriofracvars
 
int fracvarssize
 
SCIP_Longint validfracvars
 
char * name
 

Field Documentation

◆ solver

SCIP_NLPI* SCIP_Nlp::solver

interface to NLP solver, or NULL if no NLP solvers are available

Definition at line 112 of file struct_nlp.h.

Referenced by nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpSolve(), nlpUpdateObjCoef(), nlpUpdateVarBounds(), nlrowConstantChanged(), nlrowExprtreeChanged(), nlrowExprtreeParamChanged(), nlrowLinearCoefChanged(), nlrowQuadElemChanged(), nlrowSideChanged(), SCIPnlpChgVarBoundsDive(), SCIPnlpChgVarObjDive(), SCIPnlpChgVarsBoundsDive(), SCIPnlpEndDive(), SCIPnlpGetIntPar(), SCIPnlpGetNLPI(), SCIPnlpGetRealPar(), SCIPnlpGetStatistics(), SCIPnlpGetStringPar(), SCIPnlpSetInitialGuess(), SCIPnlpSetIntPar(), SCIPnlpSetRealPar(), SCIPnlpSetStringPar(), and SCIPnlpStartDive().

◆ problem

SCIP_NLPIPROBLEM* SCIP_Nlp::problem

problem in NLP solver

Definition at line 113 of file struct_nlp.h.

Referenced by nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpSolve(), nlpUpdateObjCoef(), nlpUpdateVarBounds(), nlrowConstantChanged(), nlrowExprtreeChanged(), nlrowExprtreeParamChanged(), nlrowLinearCoefChanged(), nlrowQuadElemChanged(), nlrowSideChanged(), SCIPnlpChgVarBoundsDive(), SCIPnlpChgVarObjDive(), SCIPnlpChgVarsBoundsDive(), SCIPnlpEndDive(), SCIPnlpGetIntPar(), SCIPnlpGetNLPIProblem(), SCIPnlpGetRealPar(), SCIPnlpGetStatistics(), SCIPnlpGetStringPar(), SCIPnlpSetInitialGuess(), SCIPnlpSetIntPar(), SCIPnlpSetRealPar(), and SCIPnlpSetStringPar().

◆ nunflushedvaradd

int SCIP_Nlp::nunflushedvaradd

number of variable additions not flushed to NLPI problem yet

Definition at line 116 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpDelVarPos(), nlpFlushNlRowAdditions(), nlpFlushObjective(), nlpFlushVarAdditions(), and SCIPnlpFlush().

◆ nunflushedvardel

int SCIP_Nlp::nunflushedvardel

number of variable deletions not flushed to NLPI problem yet

Definition at line 117 of file struct_nlp.h.

Referenced by nlpDelVarPos(), nlpFlushNlRowAdditions(), nlpFlushObjective(), nlpFlushVarDeletions(), and SCIPnlpFlush().

◆ nunflushednlrowadd

int SCIP_Nlp::nunflushednlrowadd

number of nonlinear row additions not flushed to NLPI problem yet

Definition at line 118 of file struct_nlp.h.

Referenced by nlpAddNlRows(), nlpDelNlRowPos(), nlpFlushNlRowAdditions(), and SCIPnlpFlush().

◆ nunflushednlrowdel

int SCIP_Nlp::nunflushednlrowdel

number of nonlinear row deletions not flushed to NLPI problem yet

Definition at line 119 of file struct_nlp.h.

Referenced by nlpDelNlRowPos(), nlpFlushNlRowDeletions(), nlpFlushVarDeletions(), and SCIPnlpFlush().

◆ isrelax

SCIP_Bool SCIP_Nlp::isrelax

is the current NLP a relaxation of a SCIP problem?

Definition at line 120 of file struct_nlp.h.

◆ indiving

SCIP_Bool SCIP_Nlp::indiving

are we currently in diving mode?

Definition at line 121 of file struct_nlp.h.

Referenced by nlpAddNlRows(), nlpAddVars(), nlpDelNlRowPos(), nlpDelVarPos(), nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpRemoveFixedVar(), nlpRowChanged(), nlpSolve(), nlpUpdateObjCoef(), nlpUpdateVarBounds(), SCIPnlpAddNlRow(), SCIPnlpAddNlRows(), SCIPnlpAddVar(), SCIPnlpAddVars(), SCIPnlpChgVarBoundsDive(), SCIPnlpChgVarObjDive(), SCIPnlpChgVarsBoundsDive(), SCIPnlpDelNlRow(), SCIPnlpDelVar(), SCIPnlpEndDive(), SCIPnlpFlush(), SCIPnlpGetPseudoObjval(), SCIPnlpIsDiving(), SCIPnlpRemoveRedundantNlRows(), SCIPnlpReset(), SCIPnlpSolve(), and SCIPnlpStartDive().

◆ nvars

int SCIP_Nlp::nvars

number of variables

Definition at line 124 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpCalcFracVars(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpSolve(), nlrowQuadElemChanged(), SCIPnlpChgVarObjDive(), SCIPnlpEndDive(), SCIPnlpEnsureVarsSize(), SCIPnlpFlush(), SCIPnlpGetNVars(), SCIPnlpGetPseudoObjval(), SCIPnlpGetVarsNonlinearity(), SCIPnlpReset(), SCIPnlpSetInitialGuess(), and SCIPnlpWrite().

◆ sizevars

int SCIP_Nlp::sizevars

allocated space for variables

Definition at line 125 of file struct_nlp.h.

Referenced by nlpAddVars(), and SCIPnlpEnsureVarsSize().

◆ vars

SCIP_VAR** SCIP_Nlp::vars

variables

Definition at line 126 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpCalcFracVars(), nlpDelVarPos(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpMoveVar(), nlpSolve(), SCIPnlpChgVarObjDive(), SCIPnlpEndDive(), SCIPnlpEnsureVarsSize(), SCIPnlpGetPseudoObjval(), SCIPnlpGetVars(), and SCIPnlpWrite().

◆ varhash

SCIP_HASHMAP* SCIP_Nlp::varhash

variable hash: map SCIP_VAR* to index of variable in NLP

Definition at line 127 of file struct_nlp.h.

Referenced by nlpAddNlRows(), nlpAddVars(), nlpMoveVar(), nlpRemoveFixedVar(), nlpSetupNlpiIndices(), nlpUpdateObjCoef(), nlpUpdateVarBounds(), nlrowExprtreeChanged(), nlrowLinearCoefChanged(), nlrowQuadElemChanged(), SCIPnlpAddVar(), SCIPnlpChgVarBoundsDive(), SCIPnlpChgVarObjDive(), SCIPnlpChgVarsBoundsDive(), SCIPnlpDelVar(), and SCIPnlpGetVarsNonlinearity().

◆ nvars_solver

int SCIP_Nlp::nvars_solver

number of variables in NLPI problem

Definition at line 129 of file struct_nlp.h.

Referenced by nlpEnsureVarsSolverSize(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpSolve(), nlrowQuadElemChanged(), SCIPnlpEndDive(), and SCIPnlpFlush().

◆ sizevars_solver

int SCIP_Nlp::sizevars_solver

allocated space for variables in NLPI problem

Definition at line 130 of file struct_nlp.h.

Referenced by nlpEnsureVarsSolverSize().

◆ varmap_nlp2nlpi

int* SCIP_Nlp::varmap_nlp2nlpi

index of variables in NLPI problem, or -1 if variable has not been added to NLPI problem yet

Definition at line 131 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpDelVarPos(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpMoveVar(), nlpSetupNlpiIndices(), nlpSolve(), nlpUpdateObjCoef(), nlpUpdateVarBounds(), nlrowExprtreeChanged(), nlrowLinearCoefChanged(), nlrowQuadElemChanged(), SCIPnlpChgVarBoundsDive(), SCIPnlpChgVarObjDive(), SCIPnlpChgVarsBoundsDive(), and SCIPnlpEnsureVarsSize().

◆ varmap_nlpi2nlp

int* SCIP_Nlp::varmap_nlpi2nlp

index of a NLPI problem variable in NLP (varmap_nlp2nlpi[varmap_nlpi2nlp[i]] == i for i = 0..nvarssolver-1), or -1 if variable has been deleted from NLP

Definition at line 132 of file struct_nlp.h.

Referenced by nlpDelVarPos(), nlpEnsureVarsSolverSize(), nlpFlushObjective(), nlpFlushVarAdditions(), nlpFlushVarDeletions(), nlpMoveVar(), nlpSolve(), and SCIPnlpEndDive().

◆ nnlrows

int SCIP_Nlp::nnlrows

number of nonlinear rows

Definition at line 135 of file struct_nlp.h.

Referenced by nlpAddNlRows(), nlpDelNlRowPos(), nlpDelVarPos(), nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), nlpRemoveFixedVar(), nlpSolve(), SCIPnlpDelNlRow(), SCIPnlpEnsureNlRowsSize(), SCIPnlpFlush(), SCIPnlpGetNNlRows(), SCIPnlpGetVarsNonlinearity(), SCIPnlpHasContinuousNonlinearity(), SCIPnlpRemoveRedundantNlRows(), SCIPnlpReset(), and SCIPnlpWrite().

◆ sizenlrows

int SCIP_Nlp::sizenlrows

allocated space for nonlinear rows

Definition at line 136 of file struct_nlp.h.

Referenced by SCIPnlpEnsureNlRowsSize().

◆ nlrows

SCIP_NLROW** SCIP_Nlp::nlrows

nonlinear rows

Definition at line 137 of file struct_nlp.h.

Referenced by nlpAddNlRows(), nlpDelNlRowPos(), nlpDelVarPos(), nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), nlpMoveNlrow(), nlpRemoveFixedVar(), nlpSolve(), SCIPnlpEnsureNlRowsSize(), SCIPnlpGetNlRows(), SCIPnlpGetVarsNonlinearity(), SCIPnlpHasContinuousNonlinearity(), SCIPnlpRemoveRedundantNlRows(), and SCIPnlpWrite().

◆ nnlrows_solver

int SCIP_Nlp::nnlrows_solver

number of nonlinear rows in solver

Definition at line 139 of file struct_nlp.h.

Referenced by nlpDelNlRowPos(), nlpEnsureNlRowsSolverSize(), nlpFlushNlRowAdditions(), nlpFlushNlRowDeletions(), and SCIPnlpFlush().

◆ sizenlrows_solver

int SCIP_Nlp::sizenlrows_solver

allocated space for nonlinear rows in solver

Definition at line 140 of file struct_nlp.h.

Referenced by nlpEnsureNlRowsSolverSize().

◆ nlrowmap_nlpi2nlp

int* SCIP_Nlp::nlrowmap_nlpi2nlp

index of a NLPI row in NLP (nlrows[nlrowmap_nlpi2nlp[i]]->nlpiidx == i for i = 0..nnlrows_solver-1), or -1 if row has been deleted from NLP

Definition at line 141 of file struct_nlp.h.

Referenced by nlpDelNlRowPos(), nlpEnsureNlRowsSolverSize(), nlpFlushNlRowAdditions(), and nlpFlushNlRowDeletions().

◆ objflushed

SCIP_Bool SCIP_Nlp::objflushed

is the objective in the NLPI up to date?

Definition at line 144 of file struct_nlp.h.

Referenced by nlpFlushObjective(), nlpFlushVarAdditions(), nlpUpdateObjCoef(), SCIPnlpChgVarObjDive(), SCIPnlpEndDive(), and SCIPnlpFlush().

◆ divingobj

SCIP_NLROW* SCIP_Nlp::divingobj

objective function during diving

Definition at line 145 of file struct_nlp.h.

Referenced by nlpSolve(), SCIPnlpChgVarObjDive(), SCIPnlpEndDive(), SCIPnlpGetPseudoObjval(), and SCIPnlpIsDivingObjChanged().

◆ haveinitguess

SCIP_Bool SCIP_Nlp::haveinitguess

is an initial guess available?

Definition at line 148 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpSolve(), SCIPnlpReset(), and SCIPnlpSetInitialGuess().

◆ initialguess

SCIP_Real* SCIP_Nlp::initialguess

initial guess of primal values to use in next NLP solve, if available

Definition at line 149 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpMoveVar(), nlpSolve(), SCIPnlpEnsureVarsSize(), SCIPnlpReset(), and SCIPnlpSetInitialGuess().

◆ primalsolobjval

SCIP_Real SCIP_Nlp::primalsolobjval

objective function value of primal solution

Definition at line 152 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpDelVarPos(), nlpSolve(), SCIPnlpEndDive(), and SCIPnlpGetObjval().

◆ solstat

SCIP_NLPSOLSTAT SCIP_Nlp::solstat

status of NLP solution (feasible, optimal, unknown...)

Definition at line 153 of file struct_nlp.h.

Referenced by nlpAddNlRows(), nlpAddVars(), nlpCalcFracVars(), nlpDelNlRowPos(), nlpDelVarPos(), nlpRowChanged(), nlpSolve(), nlpUpdateObjCoef(), nlpUpdateVarBounds(), SCIPnlpEndDive(), SCIPnlpGetSolstat(), SCIPnlpHasSolution(), SCIPnlpRemoveRedundantNlRows(), SCIPnlpReset(), and SCIPnlrowRecalcNLPActivity().

◆ termstat

SCIP_NLPTERMSTAT SCIP_Nlp::termstat

termination status of NLP (normal, some limit reached, ...)

Definition at line 154 of file struct_nlp.h.

Referenced by nlpSolve(), SCIPnlpEndDive(), SCIPnlpGetTermstat(), and SCIPnlpReset().

◆ varlbdualvals

SCIP_Real* SCIP_Nlp::varlbdualvals

dual values associated with variable lower bounds

Definition at line 155 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpMoveVar(), nlpSolve(), SCIPnlpEnsureVarsSize(), and SCIPnlpGetVarsLbDualsol().

◆ varubdualvals

SCIP_Real* SCIP_Nlp::varubdualvals

dual values associated with variable upper bounds

Definition at line 156 of file struct_nlp.h.

Referenced by nlpAddVars(), nlpMoveVar(), nlpSolve(), SCIPnlpEnsureVarsSize(), and SCIPnlpGetVarsUbDualsol().

◆ eventhdlr

SCIP_EVENTHDLR* SCIP_Nlp::eventhdlr

event handler for bound change events

Definition at line 159 of file struct_nlp.h.

Referenced by nlpAddVars(), and nlpDelVarPos().

◆ globalfilterpos

int SCIP_Nlp::globalfilterpos

position of event handler in event handler filter

Definition at line 160 of file struct_nlp.h.

◆ fracvars

SCIP_VAR** SCIP_Nlp::fracvars

fractional variables

Definition at line 163 of file struct_nlp.h.

Referenced by nlpCalcFracVars(), and SCIPnlpGetFracVars().

◆ fracvarssol

SCIP_Real* SCIP_Nlp::fracvarssol

values of the fractional variables

Definition at line 164 of file struct_nlp.h.

Referenced by nlpCalcFracVars(), and SCIPnlpGetFracVars().

◆ fracvarsfrac

SCIP_Real* SCIP_Nlp::fracvarsfrac

fractionality of the fractional variables

Definition at line 165 of file struct_nlp.h.

Referenced by nlpCalcFracVars(), and SCIPnlpGetFracVars().

◆ nfracvars

int SCIP_Nlp::nfracvars

number of fractional variables

Definition at line 166 of file struct_nlp.h.

Referenced by nlpCalcFracVars(), and SCIPnlpGetFracVars().

◆ npriofracvars

int SCIP_Nlp::npriofracvars

number of fractional variables with highest branching priority

Definition at line 167 of file struct_nlp.h.

Referenced by nlpCalcFracVars(), and SCIPnlpGetFracVars().

◆ fracvarssize

int SCIP_Nlp::fracvarssize

size of fracvars* arrays

Definition at line 168 of file struct_nlp.h.

Referenced by nlpCalcFracVars().

◆ validfracvars

SCIP_Longint SCIP_Nlp::validfracvars

the NLP solve for which the fractional variables are valid, or -1 if never setup

Definition at line 169 of file struct_nlp.h.

Referenced by nlpCalcFracVars().

◆ name

char* SCIP_Nlp::name

problem name

Definition at line 172 of file struct_nlp.h.

Referenced by SCIPnlpWrite().