Scippy

SCIP

Solving Constraint Integer Programs

nlpioracle.h File Reference

Detailed Description

methods to store an NLP and request function, gradient, and hessian values

Author
Stefan Vigerske

Not a full NLPI, but implements a common part of many NLPIs that takes care of the problem storage and function, gradient, and hessian evaluation.

Definition in file nlpioracle.h.

Go to the source code of this file.

Typedefs

typedef struct SCIP_NlpiOracle SCIP_NLPIORACLE
 

Functions

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleCreate (BMS_BLKMEM *blkmem, SCIP_NLPIORACLE **oracle)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleFree (SCIP_NLPIORACLE **oracle)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleSetInfinity (SCIP_NLPIORACLE *oracle, SCIP_Real infinity)
 
SCIP_EXPORT SCIP_Real SCIPnlpiOracleGetInfinity (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleSetProblemName (SCIP_NLPIORACLE *oracle, const char *name)
 
SCIP_EXPORT const char * SCIPnlpiOracleGetProblemName (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleAddVars (SCIP_NLPIORACLE *oracle, int nvars, const SCIP_Real *lbs, const SCIP_Real *ubs, const char **varnames)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleAddConstraints (SCIP_NLPIORACLE *oracle, int nconss, const SCIP_Real *lhss, const SCIP_Real *rhss, const int *nlininds, int *const *lininds, SCIP_Real *const *linvals, const int *nquadelems, SCIP_QUADELEM *const *quadelems, int *const *exprvaridxs, SCIP_EXPRTREE *const *exprtrees, const char **consnames)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleSetObjective (SCIP_NLPIORACLE *oracle, const SCIP_Real constant, int nlin, const int *lininds, const SCIP_Real *linvals, int nquadelems, const SCIP_QUADELEM *quadelems, const int *exprvaridxs, const SCIP_EXPRTREE *exprtree)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgVarBounds (SCIP_NLPIORACLE *oracle, int nvars, const int *indices, const SCIP_Real *lbs, const SCIP_Real *ubs)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgConsSides (SCIP_NLPIORACLE *oracle, int nconss, const int *indices, const SCIP_Real *lhss, const SCIP_Real *rhss)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleDelVarSet (SCIP_NLPIORACLE *oracle, int *delstats)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleDelConsSet (SCIP_NLPIORACLE *oracle, int *delstats)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgLinearCoefs (SCIP_NLPIORACLE *oracle, int considx, int nentries, const int *varidxs, const SCIP_Real *newcoefs)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgQuadCoefs (SCIP_NLPIORACLE *oracle, int considx, int nquadelems, const SCIP_QUADELEM *quadelems)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgExprtree (SCIP_NLPIORACLE *oracle, int considx, const int *exprvaridxs, const SCIP_EXPRTREE *exprtree)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgExprParam (SCIP_NLPIORACLE *oracle, int considx, int paramidx, SCIP_Real paramval)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgObjConstant (SCIP_NLPIORACLE *oracle, SCIP_Real objconstant)
 
SCIP_EXPORT int SCIPnlpiOracleGetNVars (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT int SCIPnlpiOracleGetNConstraints (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT const SCIP_RealSCIPnlpiOracleGetVarLbs (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT const SCIP_RealSCIPnlpiOracleGetVarUbs (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT char ** SCIPnlpiOracleGetVarNames (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT int SCIPnlpiOracleGetVarDegree (SCIP_NLPIORACLE *oracle, int varidx)
 
SCIP_EXPORT int * SCIPnlpiOracleGetVarDegrees (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT SCIP_Real SCIPnlpiOracleGetConstraintLhs (SCIP_NLPIORACLE *oracle, int considx)
 
SCIP_EXPORT SCIP_Real SCIPnlpiOracleGetConstraintRhs (SCIP_NLPIORACLE *oracle, int considx)
 
SCIP_EXPORT char * SCIPnlpiOracleGetConstraintName (SCIP_NLPIORACLE *oracle, int considx)
 
SCIP_EXPORT int SCIPnlpiOracleGetConstraintDegree (SCIP_NLPIORACLE *oracle, int considx)
 
SCIP_EXPORT int SCIPnlpiOracleGetMaxDegree (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT SCIP_EXPRINTCAPABILITY SCIPnlpiOracleGetEvalCapability (SCIP_NLPIORACLE *oracle)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalObjectiveValue (SCIP_NLPIORACLE *oracle, const SCIP_Real *x, SCIP_Real *objval)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalConstraintValue (SCIP_NLPIORACLE *oracle, int considx, const SCIP_Real *x, SCIP_Real *conval)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalConstraintValues (SCIP_NLPIORACLE *oracle, const SCIP_Real *x, SCIP_Real *convals)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalObjectiveGradient (SCIP_NLPIORACLE *oracle, const SCIP_Real *x, SCIP_Bool isnewx, SCIP_Real *objval, SCIP_Real *objgrad)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalConstraintGradient (SCIP_NLPIORACLE *oracle, const int considx, const SCIP_Real *x, SCIP_Bool isnewx, SCIP_Real *conval, SCIP_Real *congrad)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleGetJacobianSparsity (SCIP_NLPIORACLE *oracle, const int **offset, const int **col)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalJacobian (SCIP_NLPIORACLE *oracle, const SCIP_Real *x, SCIP_Bool isnewx, SCIP_Real *convals, SCIP_Real *jacobi)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleGetHessianLagSparsity (SCIP_NLPIORACLE *oracle, const int **offset, const int **col)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalHessianLag (SCIP_NLPIORACLE *oracle, const SCIP_Real *x, SCIP_Bool isnewx, SCIP_Real objfactor, const SCIP_Real *lambdas, SCIP_Real *hessian)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOraclePrintProblem (SCIP_NLPIORACLE *oracle, SCIP_MESSAGEHDLR *messagehdlr, FILE *file)
 
SCIP_EXPORT SCIP_RETCODE SCIPnlpiOraclePrintProblemGams (SCIP_NLPIORACLE *oracle, SCIP_Real *initval, SCIP_MESSAGEHDLR *messagehdlr, FILE *file)
 

Typedef Documentation

◆ SCIP_NLPIORACLE

NLPI oracle data structure

Definition at line 36 of file nlpioracle.h.

Function Documentation

◆ SCIPnlpiOracleCreate()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleCreate ( BMS_BLKMEM blkmem,
SCIP_NLPIORACLE **  oracle 
)

creates an NLPIORACLE data structure

Parameters
blkmemblock memory
oraclepointer to store NLPIORACLE data structure

Definition at line 1328 of file nlpioracle.c.

References BMSallocMemory, BMSclearMemory, createConstraint(), NULL, SCIP_ALLOC, SCIP_CALL, SCIP_DEFAULT_INFINITY, SCIP_OKAY, SCIPdebugMessage, SCIPexprintCreate(), SCIPexprintGetName(), and TRUE.

Referenced by SCIP_DECL_NLPICREATEPROBLEM().

◆ SCIPnlpiOracleFree()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleFree ( SCIP_NLPIORACLE **  oracle)

frees an NLPIORACLE data structure

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 1355 of file nlpioracle.c.

References BMSfreeMemory, freeConstraint(), freeConstraints(), freeVariables(), invalidateHessianLagSparsity(), invalidateJacobiSparsity(), NULL, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, SCIPexprintFree(), and SCIPnlpiOracleSetProblemName().

Referenced by SCIP_DECL_NLPIFREEPROBLEM().

◆ SCIPnlpiOracleSetInfinity()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleSetInfinity ( SCIP_NLPIORACLE oracle,
SCIP_Real  infinity 
)

sets the value for infinity

Parameters
oraclepointer to NLPIORACLE data structure
infinityvalue to use for infinity

Definition at line 1384 of file nlpioracle.c.

References infinity, NULL, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPICREATEPROBLEM(), and SCIP_DECL_NLPISETREALPAR().

◆ SCIPnlpiOracleGetInfinity()

SCIP_EXPORT SCIP_Real SCIPnlpiOracleGetInfinity ( SCIP_NLPIORACLE oracle)

gets the value for infinity

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 1400 of file nlpioracle.c.

References NULL, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPIGETREALPAR(), and SCIP_DECL_NLPISOLVE().

◆ SCIPnlpiOracleSetProblemName()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleSetProblemName ( SCIP_NLPIORACLE oracle,
const char *  name 
)

sets the problem name (used for printing)

Parameters
oraclepointer to NLPIORACLE data structure
namename of problem

Definition at line 1412 of file nlpioracle.c.

References BMSduplicateBlockMemoryArray, BMSfreeBlockMemoryArray, NULL, SCIP_ALLOC, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPICREATEPROBLEM(), and SCIPnlpiOracleFree().

◆ SCIPnlpiOracleGetProblemName()

SCIP_EXPORT const char* SCIPnlpiOracleGetProblemName ( SCIP_NLPIORACLE oracle)

gets the problem name, or NULL if none set

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 1435 of file nlpioracle.c.

References NULL, and SCIPdebugMessage.

◆ SCIPnlpiOracleAddVars()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleAddVars ( SCIP_NLPIORACLE oracle,
int  nvars,
const SCIP_Real lbs,
const SCIP_Real ubs,
const char **  varnames 
)

adds variables

Parameters
oraclepointer to NLPIORACLE data structure
nvarsnumber of variables to add
lbsarray with lower bounds of new variables, or NULL if all -infinity
ubsarray with upper bounds of new variables, or NULL if all +infinity
varnamesarray with names of new variables, or NULL if no names should be stored

Definition at line 1447 of file nlpioracle.c.

References BMSallocBlockMemoryArray, BMSclearMemoryArray, BMScopyMemoryArray, BMSduplicateBlockMemoryArray, ensureVarsSize(), EPSEQ, invalidateHessianLagSparsity(), NULL, SCIP_ALLOC, SCIP_CALL, SCIP_DEFAULT_EPSILON, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPIADDVARS().

◆ SCIPnlpiOracleAddConstraints()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleAddConstraints ( SCIP_NLPIORACLE oracle,
int  nconss,
const SCIP_Real lhss,
const SCIP_Real rhss,
const int *  nlininds,
int *const *  lininds,
SCIP_Real *const *  linvals,
const int *  nquadelems,
SCIP_QUADELEM *const *  quadelems,
int *const *  exprvaridxs,
SCIP_EXPRTREE *const *  exprtrees,
const char **  consnames 
)

adds constraints

linear coefficients: row(=constraint) oriented matrix; quadratic coefficients: row oriented matrix for each constraint

Parameters
oraclepointer to NLPIORACLE data structure
nconssnumber of constraints to add
lhssarray with left-hand sides of constraints, or NULL if all -infinity
rhssarray with right-hand sides of constraints, or NULL if all +infinity
nlinindsnumber of linear coefficients for each constraint, may be NULL in case of no linear part
linindsindices of variables for linear coefficients for each constraint, may be NULL in case of no linear part
linvalsvalues of linear coefficient for each constraint, may be NULL in case of no linear part
nquadelemsnumber of elements in matrix of quadratic part for each constraint, may be NULL in case of no quadratic part in any constraint
quadelemsquadratic elements specifying quadratic part for each constraint, entry of array may be NULL in case of no quadratic part, may be NULL in case of no quadratic part in any constraint
exprvaridxsNULL if no nonquadratic parts, otherwise epxrvaridxs[.] maps variable indices in expression tree to indices in nlp
exprtreesNULL if no nonquadratic parts, otherwise exprtrees[.] gives nonquadratic part, or NULL if no nonquadratic part in this constraint
consnamesnames of new constraints, or NULL if no names should be stored

Definition at line 1532 of file nlpioracle.c.

References createConstraint(), ensureConssSize(), SCIP_NlpiOracleCons::exprtree, FALSE, invalidateHessianLagSparsity(), invalidateJacobiSparsity(), SCIP_NlpiOracleCons::nquadelems, NULL, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, SCIPexprintCompile(), TRUE, and updateVariableDegreesCons().

Referenced by SCIP_DECL_NLPIADDCONSTRAINTS().

◆ SCIPnlpiOracleSetObjective()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleSetObjective ( SCIP_NLPIORACLE oracle,
const SCIP_Real  constant,
int  nlin,
const int *  lininds,
const SCIP_Real linvals,
int  nquadelems,
const SCIP_QUADELEM quadelems,
const int *  exprvaridxs,
const SCIP_EXPRTREE exprtree 
)

sets or overwrites objective, a minimization problem is expected

May change sparsity pattern.

Parameters
oraclepointer to NLPIORACLE data structure
constantconstant part of objective
nlinnumber of linear variable coefficients
linindsindices of linear variables, or NULL if no linear part
linvalscoefficients of linear variables, or NULL if no linear part
nquadelemsnumber of entries in matrix of quadratic part
quadelemsentries in matrix of quadratic part, may be NULL in case of no quadratic part
exprvaridxsmaps variable indices in expression tree to indices in nlp, or NULL if no nonquadratic part
exprtreeexpression tree of nonquadratic part, or NULL if no nonquadratic part

Definition at line 1610 of file nlpioracle.c.

References createConstraint(), FALSE, freeConstraint(), SCIP_NlpiOracle::infinity, invalidateHessianLagSparsity(), NULL, REALABS, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, and SCIPexprintCompile().

Referenced by SCIP_DECL_NLPISETOBJECTIVE().

◆ SCIPnlpiOracleChgVarBounds()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgVarBounds ( SCIP_NLPIORACLE oracle,
int  nvars,
const int *  indices,
const SCIP_Real lbs,
const SCIP_Real ubs 
)

change variable bounds

Parameters
oraclepointer to NLPIORACLE data structure
nvarsnumber of variables to change bounds
indicesindices of variables to change bounds
lbsnew lower bounds, or NULL if all should be -infty
ubsnew upper bounds, or NULL if all should be +infty

Definition at line 1647 of file nlpioracle.c.

References EPSEQ, NULL, SCIP_DEFAULT_EPSILON, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPICHGVARBOUNDS().

◆ SCIPnlpiOracleChgConsSides()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgConsSides ( SCIP_NLPIORACLE oracle,
int  nconss,
const int *  indices,
const SCIP_Real lhss,
const SCIP_Real rhss 
)

change constraint sides

change constraint bounds

Parameters
oraclepointer to NLPIORACLE data structure
nconssnumber of constraints to change bounds
indicesindices of constraints to change bounds
lhssnew left-hand sides, or NULL if all should be -infty
rhssnew right-hand sides, or NULL if all should be +infty

Definition at line 1683 of file nlpioracle.c.

References EPSEQ, NULL, SCIP_DEFAULT_EPSILON, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPICHGCONSSIDES().

◆ SCIPnlpiOracleDelVarSet()

◆ SCIPnlpiOracleDelConsSet()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleDelConsSet ( SCIP_NLPIORACLE oracle,
int *  delstats 
)

deletes a set of constraints

Parameters
oraclepointer to NLPIORACLE data structure
delstatsarray with deletion status of rows in input (1 if row should be deleted, 0 if not); new position of row in output (-1 if row was deleted)

Definition at line 1827 of file nlpioracle.c.

References FALSE, freeConstraint(), freeConstraints(), invalidateHessianLagSparsity(), invalidateJacobiSparsity(), NULL, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPIDELCONSSET().

◆ SCIPnlpiOracleChgLinearCoefs()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgLinearCoefs ( SCIP_NLPIORACLE oracle,
int  considx,
int  nentries,
const int *  varidxs,
const SCIP_Real newcoefs 
)

changes (or adds) linear coefficients in one constraint or objective

changes linear coefficients in one constraint or objective

Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint where linear coefficients should be changed, or -1 for objective
nentriesnumber of coefficients to change
varidxsarray with indices of variables which coefficients should be changed
newcoefsarray with new coefficients of variables

Definition at line 1909 of file nlpioracle.c.

References BMSduplicateBlockMemoryArray, ensureConsLinSize(), FALSE, invalidateJacobiSparsity(), SCIP_NlpiOracleCons::lincoefs, SCIP_NlpiOracleCons::linidxs, SCIP_NlpiOracleCons::linsize, MAX, SCIP_NlpiOracleCons::nlinidxs, NULL, SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, SCIPsortedvecFindInt(), sortLinearCoefficients(), and TRUE.

Referenced by SCIP_DECL_NLPICHGLINEARCOEFS().

◆ SCIPnlpiOracleChgQuadCoefs()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgQuadCoefs ( SCIP_NLPIORACLE oracle,
int  considx,
int  nquadelems,
const SCIP_QUADELEM quadelems 
)

changes (or adds) coefficients in the quadratic part of one constraint or objective

Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint where quadratic coefficients should be changed, or -1 for objective
nquadelemsnumber of entries in quadratic constraint to change
quadelemsnew elements in quadratic matrix (replacing already existing ones or adding new ones)

Definition at line 2006 of file nlpioracle.c.

References BMSduplicateBlockMemoryArray, SCIP_QuadElement::coef, ensureConsQuadSize(), FALSE, SCIP_QuadElement::idx1, SCIP_QuadElement::idx2, invalidateHessianLagSparsity(), invalidateJacobiSparsity(), MAX, SCIP_NlpiOracleCons::nquadelems, NULL, SCIP_NlpiOracleCons::quadelems, SCIP_NlpiOracleCons::quadsize, SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, SCIPquadelemSort(), SCIPquadelemSortedFind(), SCIPquadelemSqueeze(), and TRUE.

Referenced by SCIP_DECL_NLPICHGQUADCOEFS().

◆ SCIPnlpiOracleChgExprtree()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgExprtree ( SCIP_NLPIORACLE oracle,
int  considx,
const int *  exprvaridxs,
const SCIP_EXPRTREE exprtree 
)

replaces expression tree of one constraint or objective

Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint where expression tree should be changed, or -1 for objective
exprvaridxsproblem indices of variables in expression tree
exprtreenew expression tree, or NULL

Definition at line 2104 of file nlpioracle.c.

References BMSduplicateBlockMemoryArray, BMSfreeBlockMemoryArray, SCIP_NlpiOracleCons::exprtree, SCIP_NlpiOracleCons::exprvaridxs, FALSE, invalidateHessianLagSparsity(), invalidateJacobiSparsity(), NULL, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, SCIPexprintCompile(), SCIPexprtreeCopy(), SCIPexprtreeFree(), and SCIPexprtreeGetNVars().

Referenced by SCIP_DECL_NLPICHGEXPRTREE().

◆ SCIPnlpiOracleChgExprParam()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgExprParam ( SCIP_NLPIORACLE oracle,
int  considx,
int  paramidx,
SCIP_Real  paramval 
)

changes one parameter of expression tree of one constraint or objective

Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint where parameter should be changed in expression tree, or -1 for objective
paramidxindex of parameter
paramvalnew value of parameter

Definition at line 2161 of file nlpioracle.c.

References NULL, SCIP_OKAY, SCIPdebugMessage, SCIPexprtreeGetNParams(), and SCIPexprtreeSetParamVal().

Referenced by SCIP_DECL_NLPICHGNONLINCOEF().

◆ SCIPnlpiOracleChgObjConstant()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleChgObjConstant ( SCIP_NLPIORACLE oracle,
SCIP_Real  objconstant 
)

changes the constant value in the objective function

Parameters
oraclepointer to NLPIORACLE data structure
objconstantnew value for objective constant

Definition at line 2186 of file nlpioracle.c.

References NULL, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIP_DECL_NLPICHGOBJCONSTANT().

◆ SCIPnlpiOracleGetNVars()

◆ SCIPnlpiOracleGetNConstraints()

SCIP_EXPORT int SCIPnlpiOracleGetNConstraints ( SCIP_NLPIORACLE oracle)

gives the current number of constraints

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2212 of file nlpioracle.c.

References SCIP_NlpiOracle::nconss, and NULL.

Referenced by computeInteriorPoint(), initWorhp(), processSolveOutcome(), SCIP_DECL_NLPIADDCONSTRAINTS(), SCIP_DECL_NLPIADDVARS(), SCIP_DECL_NLPISOLVE(), SCIPsetModifiedDefaultSettingsIpopt(), setupGradients(), setupStart(), updateWorhp(), userDF(), userDG(), userF(), userG(), and userHM().

◆ SCIPnlpiOracleGetVarLbs()

SCIP_EXPORT const SCIP_Real* SCIPnlpiOracleGetVarLbs ( SCIP_NLPIORACLE oracle)

gives the variables lower bounds

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2222 of file nlpioracle.c.

References NULL, and SCIP_NlpiOracle::varlbs.

Referenced by initWorhp(), SCIP_DECL_NLPICHGVARBOUNDS(), SCIP_DECL_NLPISOLVE(), SCIPsetModifiedDefaultSettingsIpopt(), setupStart(), and updateWorhp().

◆ SCIPnlpiOracleGetVarUbs()

SCIP_EXPORT const SCIP_Real* SCIPnlpiOracleGetVarUbs ( SCIP_NLPIORACLE oracle)

gives the variables upper bounds

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2232 of file nlpioracle.c.

References NULL, and SCIP_NlpiOracle::varubs.

Referenced by initWorhp(), SCIP_DECL_NLPICHGVARBOUNDS(), SCIP_DECL_NLPISOLVE(), SCIPsetModifiedDefaultSettingsIpopt(), setupStart(), and updateWorhp().

◆ SCIPnlpiOracleGetVarNames()

SCIP_EXPORT char** SCIPnlpiOracleGetVarNames ( SCIP_NLPIORACLE oracle)

gives the variables names, or NULL if not set

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2242 of file nlpioracle.c.

References NULL, and SCIP_NlpiOracle::varnames.

Referenced by SCIPsetModifiedDefaultSettingsIpopt().

◆ SCIPnlpiOracleGetVarDegree()

SCIP_EXPORT int SCIPnlpiOracleGetVarDegree ( SCIP_NLPIORACLE oracle,
int  varidx 
)

Gives maximum degree of a variable w.r.t. objective and all constraints. The degree of a variable is the degree of the summand where it appears in, and is infinity for nonpolynomial terms.

Parameters
oraclepointer to NLPIORACLE data structure
varidxthe variable for which the degree is returned

Definition at line 2254 of file nlpioracle.c.

References NULL, updateVariableDegrees(), and SCIP_NlpiOracle::vardegrees.

Referenced by SCIPsetModifiedDefaultSettingsIpopt().

◆ SCIPnlpiOracleGetVarDegrees()

SCIP_EXPORT int* SCIPnlpiOracleGetVarDegrees ( SCIP_NLPIORACLE oracle)

Gives maximum degree of all variables w.r.t. objective and all constraints. The degree of a variable is the degree of the summand where it appears in, and is infinity for nonpolynomial terms.

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2271 of file nlpioracle.c.

References NULL, updateVariableDegrees(), and SCIP_NlpiOracle::vardegrees.

◆ SCIPnlpiOracleGetConstraintLhs()

SCIP_EXPORT SCIP_Real SCIPnlpiOracleGetConstraintLhs ( SCIP_NLPIORACLE oracle,
int  considx 
)

gives left-hand side of a constraint

Parameters
oraclepointer to NLPIORACLE data structure
considxconstraint index

Definition at line 2283 of file nlpioracle.c.

References SCIP_NlpiOracle::conss, SCIP_NlpiOracleCons::lhs, and NULL.

Referenced by initWorhp(), SCIP_DECL_NLPICHGCONSSIDES(), SCIP_DECL_NLPISOLVE(), SCIPsetModifiedDefaultSettingsIpopt(), and updateWorhp().

◆ SCIPnlpiOracleGetConstraintRhs()

SCIP_EXPORT SCIP_Real SCIPnlpiOracleGetConstraintRhs ( SCIP_NLPIORACLE oracle,
int  considx 
)

gives right-hand side of a constraint

Parameters
oraclepointer to NLPIORACLE data structure
considxconstraint index

Definition at line 2296 of file nlpioracle.c.

References SCIP_NlpiOracle::conss, NULL, and SCIP_NlpiOracleCons::rhs.

Referenced by initWorhp(), SCIP_DECL_NLPICHGCONSSIDES(), SCIP_DECL_NLPISOLVE(), SCIPsetModifiedDefaultSettingsIpopt(), and updateWorhp().

◆ SCIPnlpiOracleGetConstraintName()

SCIP_EXPORT char* SCIPnlpiOracleGetConstraintName ( SCIP_NLPIORACLE oracle,
int  considx 
)

gives name of a constraint, may be NULL

Parameters
oraclepointer to NLPIORACLE data structure
considxconstraint index

Definition at line 2309 of file nlpioracle.c.

References SCIP_NlpiOracle::conss, SCIP_NlpiOracleCons::name, and NULL.

Referenced by SCIPsetModifiedDefaultSettingsIpopt().

◆ SCIPnlpiOracleGetConstraintDegree()

SCIP_EXPORT int SCIPnlpiOracleGetConstraintDegree ( SCIP_NLPIORACLE oracle,
int  considx 
)

gives maximum degree of a constraint or objective The degree is the maximal degree of all summands,, and is infinity for nonpolynomial terms.

Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint for which the degree is requested, or -1 for objective

Definition at line 2324 of file nlpioracle.c.

References SCIP_NlpiOracle::conss, SCIP_NlpiOracleCons::exprtree, SCIP_NlpiOracleCons::nlinidxs, SCIP_NlpiOracleCons::nquadelems, NULL, and SCIP_NlpiOracle::objective.

Referenced by computeInteriorPoint(), SCIP_DECL_NLPIADDCONSTRAINTS(), SCIP_DECL_NLPICHGEXPRTREE(), SCIP_DECL_NLPICHGQUADCOEFS(), SCIP_DECL_NLPISETOBJECTIVE(), SCIP_DECL_NLPISOLVE(), and SCIPsetModifiedDefaultSettingsIpopt().

◆ SCIPnlpiOracleGetMaxDegree()

SCIP_EXPORT int SCIPnlpiOracleGetMaxDegree ( SCIP_NLPIORACLE oracle)

Gives maximum degree over all constraints and the objective (or over all variables, resp.). Thus, if this function returns 0, then the objective and all constraints are constant. If it returns 1, then the problem in linear. If it returns 2, then its a QP, QCP, or QCQP. And if it returns > 2, then it is an NLP.

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2356 of file nlpioracle.c.

References NULL, SCIPdebugMessage, and updateVariableDegrees().

Referenced by SCIP_DECL_NLPISOLVE().

◆ SCIPnlpiOracleGetEvalCapability()

SCIP_EXPORT SCIP_EXPRINTCAPABILITY SCIPnlpiOracleGetEvalCapability ( SCIP_NLPIORACLE oracle)

Gives the evaluation capabilities that are shared among all expression trees in the problem.

Parameters
oraclepointer to NLPIORACLE data structure

Definition at line 2382 of file nlpioracle.c.

References SCIP_NlpiOracle::conss, SCIP_NlpiOracle::exprinterpreter, SCIP_NlpiOracleCons::exprtree, SCIP_NlpiOracle::nconss, NULL, SCIP_NlpiOracle::objective, SCIP_EXPRINTCAPABILITY_ALL, and SCIPexprintGetExprtreeCapability().

Referenced by SCIP_DECL_NLPISOLVE().

◆ SCIPnlpiOracleEvalObjectiveValue()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalObjectiveValue ( SCIP_NLPIORACLE oracle,
const SCIP_Real x,
SCIP_Real objval 
)

evaluates the objective function in a given point

Parameters
oraclepointer to NLPIORACLE data structure
xpoint where to evaluate
objvalpointer to store objective value

Definition at line 2404 of file nlpioracle.c.

References evalFunctionValue(), NULL, SCIP_CALL_QUIET, SCIP_OKAY, and SCIPdebugMessage.

Referenced by F77_FUNC(), SCIP_DECL_NLPIGETSOLUTION(), SCIPsetModifiedDefaultSettingsIpopt(), setupStart(), and userF().

◆ SCIPnlpiOracleEvalConstraintValue()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalConstraintValue ( SCIP_NLPIORACLE oracle,
int  considx,
const SCIP_Real x,
SCIP_Real conval 
)

evaluates one constraint function in a given point

Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint to evaluate
xpoint where to evaluate
convalpointer to store constraint value

Definition at line 2423 of file nlpioracle.c.

References evalFunctionValue(), NULL, SCIP_NlpiOracle::nvars, SCIP_CALL_QUIET, SCIP_OKAY, and SCIPdebugMessage.

Referenced by F77_FUNC(), and setupStart().

◆ SCIPnlpiOracleEvalConstraintValues()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalConstraintValues ( SCIP_NLPIORACLE oracle,
const SCIP_Real x,
SCIP_Real convals 
)

evaluates all constraint functions in a given point

Parameters
oraclepointer to NLPIORACLE data structure
xpoint where to evaluate
convalsbuffer to store constraint values

Definition at line 2442 of file nlpioracle.c.

References evalFunctionValue(), NULL, SCIP_CALL_QUIET, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIPsetModifiedDefaultSettingsIpopt(), and userG().

◆ SCIPnlpiOracleEvalObjectiveGradient()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalObjectiveGradient ( SCIP_NLPIORACLE oracle,
const SCIP_Real x,
SCIP_Bool  isnewx,
SCIP_Real objval,
SCIP_Real objgrad 
)

computes the objective gradient in a given point

Returns
SCIP_INVALIDDATA, if the function or its gradient could not be evaluated (domain error, etc.)
Parameters
oraclepointer to NLPIORACLE data structure
xpoint where to evaluate
isnewxhas the point x changed since the last call to some evaluation function?
objvalpointer to store objective value
objgradpointer to store (dense) objective gradient

Definition at line 2468 of file nlpioracle.c.

References evalFunctionGradient(), NULL, SCIP_CALL_QUIET, SCIP_OKAY, and SCIPdebugMessage.

Referenced by F77_FUNC(), SCIPsetModifiedDefaultSettingsIpopt(), setupStart(), and userDF().

◆ SCIPnlpiOracleEvalConstraintGradient()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalConstraintGradient ( SCIP_NLPIORACLE oracle,
const int  considx,
const SCIP_Real x,
SCIP_Bool  isnewx,
SCIP_Real conval,
SCIP_Real congrad 
)

computes a constraints gradient in a given point

Returns
SCIP_INVALIDDATA, if the function or its gradient could not be evaluated (domain error, etc.)
Parameters
oraclepointer to NLPIORACLE data structure
considxindex of constraint to compute gradient for
xpoint where to evaluate
isnewxhas the point x changed since the last call to some evaluation function?
convalpointer to store constraint value
congradpointer to store (dense) constraint gradient

Definition at line 2492 of file nlpioracle.c.

References evalFunctionGradient(), NULL, SCIP_NlpiOracle::nvars, SCIP_CALL_QUIET, SCIP_OKAY, and SCIPdebugMessage.

Referenced by SCIPnlpiOracleEvalJacobian().

◆ SCIPnlpiOracleGetJacobianSparsity()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleGetJacobianSparsity ( SCIP_NLPIORACLE oracle,
const int **  offset,
const int **  col 
)

gets sparsity pattern (rowwise) of Jacobian matrix

Note that internal data is returned in *offset and *col, thus the user does not need to allocate memory there. Adding or deleting constraints destroys the sparsity structure and make another call to this function necessary.

Parameters
oraclepointer to NLPIORACLE data structure
offsetpointer to store pointer that stores the offsets to each rows sparsity pattern in col, can be NULL
colpointer to store pointer that stores the indices of variables that appear in each row, offset[nconss] gives length of col, can be NULL

Definition at line 2517 of file nlpioracle.c.

References BMSallocBlockMemoryArray, BMSclearMemoryArray, BMScopyMemoryArray, BMSfreeBlockMemoryArray, BMSreallocBlockMemoryArray, ensureIntArraySize(), SCIP_NlpiOracleCons::exprtree, SCIP_NlpiOracleCons::exprvaridxs, FALSE, SCIP_QuadElement::idx1, SCIP_QuadElement::idx2, SCIP_NlpiOracleCons::linidxs, MIN, SCIP_NlpiOracleCons::nlinidxs, SCIP_NlpiOracleCons::nquadelems, NULL, SCIP_NlpiOracleCons::quadelems, SCIP_ALLOC, SCIP_Bool, SCIP_CALL, SCIP_OKAY, SCIPdebugMessage, SCIPexprtreeGetNVars(), and TRUE.

Referenced by initWorhp(), SCIPsetModifiedDefaultSettingsIpopt(), and setupGradients().

◆ SCIPnlpiOracleEvalJacobian()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalJacobian ( SCIP_NLPIORACLE oracle,
const SCIP_Real x,
SCIP_Bool  isnewx,
SCIP_Real convals,
SCIP_Real jacobi 
)

evaluates the Jacobi matrix in a given point

The values in the Jacobi matrix are returned in the same order as specified by the offset and col arrays obtained by SCIPnlpiOracleGetJacobianSparsity. The user need to call SCIPnlpiOracleGetJacobianSparsity at least ones before using this function.

Returns
SCIP_INVALIDDATA, if the Jacobian could not be evaluated (domain error, etc.)
Parameters
oraclepointer to NLPIORACLE data structure
xpoint where to evaluate
isnewxhas the point x changed since the last call to some evaluation function?
convalspointer to store constraint values, can be NULL
jacobipointer to store sparse jacobian values

Definition at line 2658 of file nlpioracle.c.

References ABS, BMSallocBlockMemoryArray, BMScopyMemoryArray, BMSfreeBlockMemoryArray, BMSfreeBlockMemoryArrayNull, SCIP_NlpiOracleCons::exprtree, SCIP_NlpiOracleCons::exprvaridxs, SCIP_NlpiOracleCons::lincoefs, SCIP_NlpiOracleCons::nlinidxs, SCIP_NlpiOracleCons::nquadelems, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIP_Real, SCIPdebug, SCIPdebugMessage, SCIPexprintEval(), SCIPexprintGrad(), SCIPexprtreeGetNVars(), SCIPisFinite, and SCIPnlpiOracleEvalConstraintGradient().

Referenced by F77_FUNC(), SCIPsetModifiedDefaultSettingsIpopt(), setupStart(), and userDG().

◆ SCIPnlpiOracleGetHessianLagSparsity()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleGetHessianLagSparsity ( SCIP_NLPIORACLE oracle,
const int **  offset,
const int **  col 
)

gets sparsity pattern of the Hessian matrix of the Lagrangian

Note that internal data is returned in *offset and *col, thus the user must not to allocate memory there. Adding or deleting variables, objective, or constraints may destroy the sparsity structure and make another call to this function necessary. Only elements of the lower left triangle and the diagonal are counted.

gets sparsity pattern of the Hessian matrix of the Lagrangian

Note that internal data is returned in *offset and *col, thus the user must not allocate memory there. Adding or deleting variables, objective, or constraints may destroy the sparsity structure and make another call to this function necessary. Only elements of the lower left triangle and the diagonal are counted.

Parameters
oraclepointer to NLPIORACLE data structure
offsetpointer to store pointer that stores the offsets to each rows sparsity pattern in col, can be NULL
colpointer to store pointer that stores the indices of variables that appear in each row, offset[nconss] gives length of col, can be NULL

Definition at line 2797 of file nlpioracle.c.

References BMSallocBlockMemoryArray, BMSclearMemoryArray, BMSfreeBlockMemoryArray, BMSfreeBlockMemoryArrayNull, hessLagSparsitySetNzFlagForExprtree(), hessLagSparsitySetNzFlagForQuad(), NULL, SCIP_ALLOC, SCIP_CALL, SCIP_OKAY, and SCIPdebugMessage.

Referenced by initWorhp(), SCIPsetModifiedDefaultSettingsIpopt(), setupHessian(), and userHM().

◆ SCIPnlpiOracleEvalHessianLag()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOracleEvalHessianLag ( SCIP_NLPIORACLE oracle,
const SCIP_Real x,
SCIP_Bool  isnewx,
SCIP_Real  objfactor,
const SCIP_Real lambda,
SCIP_Real hessian 
)

evaluates the Hessian matrix of the Lagrangian in a given point

The values in the Hessian matrix are returned in the same order as specified by the offset and col arrays obtained by SCIPnlpiOracleGetHessianLagSparsity. The user must call SCIPnlpiOracleGetHessianLagSparsity at least ones before using this function. Only elements of the lower left triangle and the diagonal are computed.

Returns
SCIP_INVALIDDATA, if the Hessian could not be evaluated (domain error, etc.)
Parameters
oraclepointer to NLPIORACLE data structure
xpoint where to evaluate
isnewxhas the point x changed since the last call to some evaluation function?
objfactorweight for objective function
lambdaweights (Lagrangian multipliers) for the constraints
hessianpointer to store sparse hessian values

Definition at line 2896 of file nlpioracle.c.

References SCIP_NlpiOracle::heslagcols, SCIP_NlpiOracle::heslagoffsets, hessLagAddExprtree(), hessLagAddQuad(), SCIP_NlpiOracle::nconss, NULL, SCIP_CALL, SCIP_CALL_QUIET, SCIP_OKAY, and SCIPdebugMessage.

Referenced by F77_FUNC(), SCIPsetModifiedDefaultSettingsIpopt(), and userHM().

◆ SCIPnlpiOraclePrintProblem()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOraclePrintProblem ( SCIP_NLPIORACLE oracle,
SCIP_MESSAGEHDLR messagehdlr,
FILE *  file 
)

prints the problem to a file.

Parameters
oraclepointer to NLPIORACLE data structure
messagehdlrmessage handler
filefile to print to, or NULL for standard output

Definition at line 2939 of file nlpioracle.c.

References FALSE, infinity, SCIP_NlpiOracleCons::lhs, NULL, printFunction(), SCIP_NlpiOracleCons::rhs, SCIP_CALL, SCIP_OKAY, SCIP_Real, SCIPdebugMessage, and SCIPmessageFPrintInfo().

Referenced by computeInteriorPoint(), and SCIP_DECL_NLPISOLVE().

◆ SCIPnlpiOraclePrintProblemGams()

SCIP_EXPORT SCIP_RETCODE SCIPnlpiOraclePrintProblemGams ( SCIP_NLPIORACLE oracle,
SCIP_Real initval,
SCIP_MESSAGEHDLR messagehdlr,
FILE *  file 
)

prints the problem to a file in GAMS format If there are variable (equation, resp.) names with more than 9 characters, then variable (equation, resp.) names are prefixed with an unique identifier. This is to make it easier to identify variables solution output in the listing file. Names with more than 64 characters are shorten to 64 letters due to GAMS limits.

Parameters
oraclepointer to NLPIORACLE data structure
initvalstarting point values for variables or NULL
messagehdlrmessage handler
filefile to print to, or NULL for standard output

Definition at line 3008 of file nlpioracle.c.

References exprIsNonSmooth(), SCIP_NlpiOracleCons::exprtree, FALSE, infinity, SCIP_NlpiOracleCons::lhs, SCIP_NlpiOracleCons::name, SCIP_NlpiOracleCons::nquadelems, NULL, printFunction(), printName(), SCIP_NlpiOracleCons::rhs, SCIP_Bool, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIP_Real, SCIPdebugMessage, SCIPexprtreeGetRoot(), SCIPmessageFPrintInfo(), SCIPsnprintf(), and TRUE.