Scippy

SCIP

Solving Constraint Integer Programs

Macros | Typedefs | Enumerations
type_nlpi.h File Reference
Public API of SCIP » Core API » Type Definitions

Detailed Description

type definitions for specific NLP solver interfaces

Author
Stefan Vigerske
Thorsten Gellermann

Definition in file type_nlpi.h.

#include "scip/def.h"
#include "scip/type_message.h"
#include "blockmemshell/memory.h"
#include "nlpi/type_expr.h"

Go to the source code of this file.

Macros

#define SCIP_DECL_NLPICOPY(x)   SCIP_RETCODE x (BMS_BLKMEM* blkmem, SCIP_NLPI* sourcenlpi, SCIP_NLPI** targetnlpi)
 
#define SCIP_DECL_NLPIFREE(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi)
 
#define SCIP_DECL_NLPIGETSOLVERPOINTER(x)   void* x (SCIP_NLPI* nlpi)
 
#define SCIP_DECL_NLPICREATEPROBLEM(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM** problem, const char* name)
 
#define SCIP_DECL_NLPIFREEPROBLEM(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM** problem)
 
#define SCIP_DECL_NLPIGETPROBLEMPOINTER(x)   void* x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)
 
#define SCIP_DECL_NLPIADDVARS(x)
 
#define SCIP_DECL_NLPIADDCONSTRAINTS(x)
 
#define SCIP_DECL_NLPISETOBJECTIVE(x)
 
#define SCIP_DECL_NLPICHGVARBOUNDS(x)
 
#define SCIP_DECL_NLPICHGCONSSIDES(x)
 
#define SCIP_DECL_NLPIDELVARSET(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int* dstats, int dstatssize)
 
#define SCIP_DECL_NLPIDELCONSSET(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int* dstats, int dstatssize)
 
#define SCIP_DECL_NLPICHGLINEARCOEFS(x)
 
#define SCIP_DECL_NLPICHGQUADCOEFS(x)
 
#define SCIP_DECL_NLPICHGEXPRTREE(x)
 
#define SCIP_DECL_NLPICHGNONLINCOEF(x)
 
#define SCIP_DECL_NLPICHGOBJCONSTANT(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_Real objconstant)
 
#define SCIP_DECL_NLPISETINITIALGUESS(x)
 
#define SCIP_DECL_NLPISOLVE(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)
 
#define SCIP_DECL_NLPIGETSOLSTAT(x)   SCIP_NLPSOLSTAT x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)
 
#define SCIP_DECL_NLPIGETTERMSTAT(x)   SCIP_NLPTERMSTAT x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)
 
#define SCIP_DECL_NLPIGETSOLUTION(x)
 
#define SCIP_DECL_NLPIGETSTATISTICS(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPSTATISTICS* statistics)
 
#define SCIP_DECL_NLPIGETWARMSTARTSIZE(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, size_t* size)
 
#define SCIP_DECL_NLPIGETWARMSTARTMEMO(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, void* buffer)
 
#define SCIP_DECL_NLPISETWARMSTARTMEMO(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, void* buffer)
 
Parameter Methods
#define SCIP_DECL_NLPIGETINTPAR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, int* ival)
 
#define SCIP_DECL_NLPISETINTPAR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, int ival)
 
#define SCIP_DECL_NLPIGETREALPAR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, SCIP_Real* dval)
 
#define SCIP_DECL_NLPISETREALPAR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, SCIP_Real dval)
 
#define SCIP_DECL_NLPIGETSTRINGPAR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, const char** sval)
 
#define SCIP_DECL_NLPISETSTRINGPAR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, const char* sval)
 
#define SCIP_DECL_NLPISETMESSAGEHDLR(x)   SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_MESSAGEHDLR* messagehdlr)
 

Typedefs

typedef struct SCIP_Nlpi SCIP_NLPI
 
typedef struct SCIP_NlpiData SCIP_NLPIDATA
 
typedef struct SCIP_NlpiProblem SCIP_NLPIPROBLEM
 
typedef struct SCIP_NlpStatistics SCIP_NLPSTATISTICS
 
typedef enum SCIP_NlpParam SCIP_NLPPARAM
 
typedef enum SCIP_NlpSolStat SCIP_NLPSOLSTAT
 
typedef enum SCIP_NlpTermStat SCIP_NLPTERMSTAT
 

Enumerations

enum  SCIP_NlpParam {
  SCIP_NLPPAR_FROMSCRATCH = 0,
  SCIP_NLPPAR_VERBLEVEL = 1,
  SCIP_NLPPAR_FEASTOL = 2,
  SCIP_NLPPAR_RELOBJTOL = 3,
  SCIP_NLPPAR_LOBJLIM = 4,
  SCIP_NLPPAR_INFINITY = 5,
  SCIP_NLPPAR_ITLIM = 6,
  SCIP_NLPPAR_TILIM = 7,
  SCIP_NLPPAR_OPTFILE = 8,
  SCIP_NLPPAR_FASTFAIL = 9
}
 
enum  SCIP_NlpSolStat {
  SCIP_NLPSOLSTAT_GLOBOPT = 0,
  SCIP_NLPSOLSTAT_LOCOPT = 1,
  SCIP_NLPSOLSTAT_FEASIBLE = 2,
  SCIP_NLPSOLSTAT_LOCINFEASIBLE = 3,
  SCIP_NLPSOLSTAT_GLOBINFEASIBLE = 4,
  SCIP_NLPSOLSTAT_UNBOUNDED = 5,
  SCIP_NLPSOLSTAT_UNKNOWN = 6
}
 
enum  SCIP_NlpTermStat {
  SCIP_NLPTERMSTAT_OKAY = 0,
  SCIP_NLPTERMSTAT_TILIM = 1,
  SCIP_NLPTERMSTAT_ITLIM = 2,
  SCIP_NLPTERMSTAT_LOBJLIM = 3,
  SCIP_NLPTERMSTAT_NUMERR = 5,
  SCIP_NLPTERMSTAT_EVALERR = 6,
  SCIP_NLPTERMSTAT_MEMERR = 7,
  SCIP_NLPTERMSTAT_LICERR = 8,
  SCIP_NLPTERMSTAT_OTHER = 9
}
 

Macro Definition Documentation

◆ SCIP_DECL_NLPICOPY

#define SCIP_DECL_NLPICOPY (   x)    SCIP_RETCODE x (BMS_BLKMEM* blkmem, SCIP_NLPI* sourcenlpi, SCIP_NLPI** targetnlpi)

NLP solver termination status copy method of NLP interface (called when SCIP copies plugins)

input:

  • blkmem block memory of target SCIP
  • sourcenlpi the NLP interface to copy
  • targetnlpi buffer to store pointer to copy of NLP interface

Definition at line 93 of file type_nlpi.h.

◆ SCIP_DECL_NLPIFREE

#define SCIP_DECL_NLPIFREE (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi)

destructor of NLP interface to free nlpi data

input:

  • nlpi datastructure for solver interface

Definition at line 100 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETSOLVERPOINTER

#define SCIP_DECL_NLPIGETSOLVERPOINTER (   x)    void* x (SCIP_NLPI* nlpi)

gets pointer to solver-internal NLP solver

to do dirty stuff

input:

  • nlpi datastructure for solver interface

return: void pointer to solver

Definition at line 111 of file type_nlpi.h.

◆ SCIP_DECL_NLPICREATEPROBLEM

#define SCIP_DECL_NLPICREATEPROBLEM (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM** problem, const char* name)

creates a problem instance

input:

  • nlpi datastructure for solver interface
  • problem pointer to store the problem data
  • name name of problem, can be NULL

Definition at line 120 of file type_nlpi.h.

◆ SCIP_DECL_NLPIFREEPROBLEM

#define SCIP_DECL_NLPIFREEPROBLEM (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM** problem)

free a problem instance

input:

  • nlpi datastructure for solver interface
  • problem pointer where problem data is stored

Definition at line 128 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETPROBLEMPOINTER

#define SCIP_DECL_NLPIGETPROBLEMPOINTER (   x)    void* x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)

gets pointer to solver-internal problem instance

to do dirty stuff

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance

return: void pointer to problem instance

Definition at line 140 of file type_nlpi.h.

◆ SCIP_DECL_NLPIADDVARS

#define SCIP_DECL_NLPIADDVARS (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int nvars, const SCIP_Real* lbs, \
const SCIP_Real* ubs, const char** varnames)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

add variables

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • nvars number of variables
  • lbs lower bounds of variables, can be NULL if -infinity
  • ubs upper bounds of variables, can be NULL if +infinity
  • varnames names of variables, can be NULL

Definition at line 152 of file type_nlpi.h.

◆ SCIP_DECL_NLPIADDCONSTRAINTS

#define SCIP_DECL_NLPIADDCONSTRAINTS (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int ncons, 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** names)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_QuadElement
Definition: type_expr.h:100
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_ExprTree
Definition: struct_expr.h:55
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

add constraints quadratic coefficiens: row oriented matrix for each constraint

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • ncons number of added constraints
  • lhss left hand sides of constraints, can be NULL if -infinity
  • rhss right hand sides of constraints, can be NULL if +infinity
  • nlininds number of linear coefficients for each constraint may be NULL in case of no linear part
  • lininds indices of variables for linear coefficients for each constraint may be NULL in case of no linear part
  • linvals values of linear coefficient for each constraint may be NULL in case of no linear part
  • nquadelems number of quadratic elements for each constraint may be NULL in case of no quadratic part
  • quadelems quadratic elements for each constraint may be NULL in case of no quadratic part
  • exprvaridxs indices of variables in expression tree, maps variable indices in expression tree to indices in nlp entry of array may be NULL in case of no expression tree may be NULL in case of no expression tree in any constraint
  • exprtrees expression tree for nonquadratic part of constraints entry of array may be NULL in case of no nonquadratic part may be NULL in case of no nonquadratic part in any constraint
  • names of constraints, may be NULL or entries may be NULL

Definition at line 182 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETOBJECTIVE

#define SCIP_DECL_NLPISETOBJECTIVE (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int nlins, const int* lininds, \
const SCIP_Real* linvals, int nquadelems, const SCIP_QUADELEM* quadelems, const int* exprvaridxs, const SCIP_EXPRTREE* exprtree, \
const SCIP_Real constant)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_QuadElement
Definition: type_expr.h:100
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_ExprTree
Definition: struct_expr.h:55
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

sets or overwrites objective, a minimization problem is expected May change sparsity pattern.

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • nlins number of linear variables
  • lininds variable indices may be NULL in case of no linear part
  • linvals coefficient values may be NULL in case of no linear part
  • nquadelems number of elements in matrix of quadratic part
  • quadelems elements of quadratic part may be NULL in case of no quadratic part
  • exprvaridxs indices of variables in expression tree, maps variable indices in expression tree to indices in nlp may be NULL in case of no expression tree
  • exprtree expression tree for nonquadratic part of objective function may be NULL in case of no nonquadratic part
  • constant objective value offset

Definition at line 206 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGVARBOUNDS

#define SCIP_DECL_NLPICHGVARBOUNDS (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, const int nvars, const int* indices, \
const SCIP_Real* lbs, const SCIP_Real* ubs)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

change variable bounds

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • nvars number of variables to change bounds
  • indices indices of variables to change bounds
  • lbs new lower bounds
  • ubs new upper bounds

Definition at line 220 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGCONSSIDES

#define SCIP_DECL_NLPICHGCONSSIDES (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int nconss, const int* indices, \
const SCIP_Real* lhss, const SCIP_Real* rhss)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

change constraint sides

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • nconss number of constraints to change sides
  • indices indices of constraints to change sides
  • lhss new left hand sides
  • rhss new right hand sides

Definition at line 233 of file type_nlpi.h.

◆ SCIP_DECL_NLPIDELVARSET

#define SCIP_DECL_NLPIDELVARSET (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int* dstats, int dstatssize)

delete a set of variables

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • dstats deletion status of vars; 1 if var should be deleted, 0 if not
  • size of the dstats array

output:

  • dstats new position of var, -1 if var was deleted

Definition at line 247 of file type_nlpi.h.

◆ SCIP_DECL_NLPIDELCONSSET

#define SCIP_DECL_NLPIDELCONSSET (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int* dstats, int dstatssize)

delete a set of constraints

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • dstats deletion status of rows; 1 if row should be deleted, 0 if not
  • size of the dstats array

output:

  • dstats new position of row, -1 if row was deleted

Definition at line 260 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGLINEARCOEFS

#define SCIP_DECL_NLPICHGLINEARCOEFS (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int idx, int nvals, \
const int* varidxs, const SCIP_Real* vals)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

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

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • idx index of constraint or -1 for objective
  • nvals number of values in linear constraint to change
  • varidxs indices of variables which coefficient to change
  • vals new values for coefficients

Definition at line 272 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGQUADCOEFS

#define SCIP_DECL_NLPICHGQUADCOEFS (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int idx, int nquadelems, \
const SCIP_QUADELEM* quadelems)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_QuadElement
Definition: type_expr.h:100
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

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

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • idx index of constraint or -1 for objective
  • nquadelems number of entries in quadratic matrix to change
  • quadelems new elements in quadratic matrix (replacing already existing ones or adding new ones)

Definition at line 284 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGEXPRTREE

#define SCIP_DECL_NLPICHGEXPRTREE (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int idxcons, \
const int* exprvaridxs, const SCIP_EXPRTREE* exprtree)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_ExprTree
Definition: struct_expr.h:55
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

replaces the expression tree of a constraint or objective

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • idxcons index of constraint or -1 for objective
  • exprvaridxs indices of variables in expression tree, maps variable indices in expression tree to indices in nlp, or NULL
  • exprtree new expression tree for constraint or objective, or NULL to only remove previous tree

Definition at line 296 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGNONLINCOEF

#define SCIP_DECL_NLPICHGNONLINCOEF (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, int idxcons, int idxparam, \
SCIP_Real value)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

change the value of one parameter in the nonlinear part

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • idxcons index of constraint or -1 for objective
  • idxparam index of parameter
  • value new value for nonlinear parameter

return: Error if parameter does not exist

Definition at line 310 of file type_nlpi.h.

◆ SCIP_DECL_NLPICHGOBJCONSTANT

#define SCIP_DECL_NLPICHGOBJCONSTANT (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_Real objconstant)

change the constant offset in the objective

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • objconstant new value for objective constant

Definition at line 320 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETINITIALGUESS

#define SCIP_DECL_NLPISETINITIALGUESS (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_Real* primalvalues, \
SCIP_Real* consdualvalues, SCIP_Real* varlbdualvalues, SCIP_Real* varubdualvalues)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

sets initial guess for primal variables

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • primalvalues initial primal values for variables, or NULL to clear previous values
  • consdualvalues initial dual values for constraints, or NULL to clear previous values
  • varlbdualvalues initial dual values for variable lower bounds, or NULL to clear previous values
  • varubdualvalues initial dual values for variable upper bounds, or NULL to clear previous values

Definition at line 332 of file type_nlpi.h.

◆ SCIP_DECL_NLPISOLVE

#define SCIP_DECL_NLPISOLVE (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)

tries to solve NLP

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance

Definition at line 341 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETSOLSTAT

#define SCIP_DECL_NLPIGETSOLSTAT (   x)    SCIP_NLPSOLSTAT x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)

gives solution status

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance

return: Solution Status

Definition at line 351 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETTERMSTAT

#define SCIP_DECL_NLPIGETTERMSTAT (   x)    SCIP_NLPTERMSTAT x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem)

gives termination reason

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance

return: Termination Status

Definition at line 361 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETSOLUTION

#define SCIP_DECL_NLPIGETSOLUTION (   x)
Value:
SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_Real** primalvalues, \
SCIP_Real** consdualvalues, SCIP_Real** varlbdualvalues, SCIP_Real** varubdualvalues, SCIP_Real* objval)
SCIP_RETCODE
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
x
SCIP_VAR ** x
Definition: circlepacking.c:54
SCIP_Real
#define SCIP_Real
Definition: def.h:163
SCIP_NlpiProblem
Definition: nlpi_all.c:47
SCIP_Nlpi
Definition: struct_nlpi.h:35

gives primal and dual solution values

solver can return NULL in dual values if not available but if solver provides dual values for one side of variable bounds, then it must also provide those for the other side

for a ranged constraint, the dual variable is positive if the right hand side is active and negative if the left hand side is active

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • primalvalues buffer to store pointer to array to primal values, or NULL if not needed
  • consdualvalues buffer to store pointer to array to dual values of constraints, or NULL if not needed
  • varlbdualvalues buffer to store pointer to array to dual values of variable lower bounds, or NULL if not needed
  • varubdualvalues buffer to store pointer to array to dual values of variable lower bounds, or NULL if not needed
  • objval pointer to store the objective value, or NULL if not needed

Definition at line 379 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETSTATISTICS

#define SCIP_DECL_NLPIGETSTATISTICS (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPSTATISTICS* statistics)

gives solve statistics

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • statistics pointer to store statistics

output:

  • statistics solve statistics

Definition at line 392 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETWARMSTARTSIZE

#define SCIP_DECL_NLPIGETWARMSTARTSIZE (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, size_t* size)

gives required size of a buffer to store a warmstart object

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • size pointer to store required size for warmstart buffer

output:

  • size required size for warmstart buffer

Definition at line 404 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETWARMSTARTMEMO

#define SCIP_DECL_NLPIGETWARMSTARTMEMO (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, void* buffer)

stores warmstart information in buffer

required size of buffer should have been obtained by SCIPnlpiGetWarmstartSize before

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • buffer memory to store warmstart information

output:

  • buffer warmstart information in solver specific data structure

Definition at line 418 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETWARMSTARTMEMO

#define SCIP_DECL_NLPISETWARMSTARTMEMO (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, void* buffer)

sets warmstart information in solver

write warmstart to buffer

input:

  • nlpi datastructure for solver interface
  • problem datastructure for problem instance
  • buffer warmstart information

Definition at line 429 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETINTPAR

#define SCIP_DECL_NLPIGETINTPAR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, int* ival)

gets integer parameter of NLP

input:

  • nlpi NLP interface structure
  • problem datastructure for problem instance
  • type parameter number
  • ival pointer to store the parameter value

output:

  • ival parameter value

Definition at line 445 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETINTPAR

#define SCIP_DECL_NLPISETINTPAR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, int ival)

sets integer parameter of NLP

input:

  • nlpi NLP interface structure
  • problem datastructure for problem instance
  • type parameter number
  • ival parameter value

Definition at line 455 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETREALPAR

#define SCIP_DECL_NLPIGETREALPAR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, SCIP_Real* dval)

gets floating point parameter of NLP

input:

  • nlpi NLP interface structure
  • problem datastructure for problem instance, can be NULL only if type == SCIP_NLPPAR_INFINITY
  • type parameter number
  • dval pointer to store the parameter value

output:

  • dval parameter value

Definition at line 468 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETREALPAR

#define SCIP_DECL_NLPISETREALPAR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, SCIP_Real dval)

sets floating point parameter of NLP

input:

  • nlpi NLP interface structure
  • problem datastructure for problem instance, can be NULL only if type == SCIP_NLPPAR_INFINITY
  • type parameter number
  • dval parameter value

Definition at line 478 of file type_nlpi.h.

◆ SCIP_DECL_NLPIGETSTRINGPAR

#define SCIP_DECL_NLPIGETSTRINGPAR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, const char** sval)

gets string parameter of NLP

input:

  • nlpi NLP interface structure
  • problem datastructure for problem instance
  • type parameter number
  • sval pointer to store the string value, the user must not modify the string

output:

  • sval parameter value

Definition at line 491 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETSTRINGPAR

#define SCIP_DECL_NLPISETSTRINGPAR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_NLPIPROBLEM* problem, SCIP_NLPPARAM type, const char* sval)

sets string parameter of NLP

input:

  • nlpi NLP interface structure
  • problem datastructure for problem instance
  • type parameter number
  • sval parameter value

Definition at line 501 of file type_nlpi.h.

◆ SCIP_DECL_NLPISETMESSAGEHDLR

#define SCIP_DECL_NLPISETMESSAGEHDLR (   x)    SCIP_RETCODE x (SCIP_NLPI* nlpi, SCIP_MESSAGEHDLR* messagehdlr)

sets message handler for message output

input:

  • nlpi NLP interface structure
  • messagehdlr SCIP message handler, or NULL to suppress all output

Definition at line 509 of file type_nlpi.h.

Typedef Documentation

◆ SCIP_NLPI

typedef struct SCIP_Nlpi SCIP_NLPI

NLP solver interface

Definition at line 37 of file type_nlpi.h.

◆ SCIP_NLPIDATA

typedef struct SCIP_NlpiData SCIP_NLPIDATA

locally defined NLP solver interface data

Definition at line 38 of file type_nlpi.h.

◆ SCIP_NLPIPROBLEM

typedef struct SCIP_NlpiProblem SCIP_NLPIPROBLEM

locally defined NLP solver interface data for a specific problem instance

Definition at line 39 of file type_nlpi.h.

◆ SCIP_NLPSTATISTICS

typedef struct SCIP_NlpStatistics SCIP_NLPSTATISTICS

NLP solve statistics

Definition at line 40 of file type_nlpi.h.

◆ SCIP_NLPPARAM

typedef enum SCIP_NlpParam SCIP_NLPPARAM

NLP solver parameter

Definition at line 56 of file type_nlpi.h.

◆ SCIP_NLPSOLSTAT

typedef enum SCIP_NlpSolStat SCIP_NLPSOLSTAT

Definition at line 69 of file type_nlpi.h.

◆ SCIP_NLPTERMSTAT

typedef enum SCIP_NlpTermStat SCIP_NLPTERMSTAT

Definition at line 84 of file type_nlpi.h.

Enumeration Type Documentation

◆ SCIP_NlpParam

enum SCIP_NlpParam

NLP solver parameter

Enumerator
SCIP_NLPPAR_FROMSCRATCH 

solver should start from scratch at next call?: 0 no, 1 yes (int)

SCIP_NLPPAR_VERBLEVEL 

verbosity level of output of NLP solver to the screen: 0 off, 1 normal, 2 debug, > 2 more debug (int)

SCIP_NLPPAR_FEASTOL 

feasibility tolerance for primal variables and slacks (real)

SCIP_NLPPAR_RELOBJTOL 

relative objective tolerance (real)

SCIP_NLPPAR_LOBJLIM 

lower objective limit (cutoff) (real)

SCIP_NLPPAR_INFINITY 

value for infinity used to decide unbounded sides, unbounded variable and constraint bounds, and upper objective limit (real)

SCIP_NLPPAR_ITLIM 

NLP iteration limit (int)

SCIP_NLPPAR_TILIM 

NLP time limit (real)

SCIP_NLPPAR_OPTFILE 

name of a solver specific option file (string)

SCIP_NLPPAR_FASTFAIL 

should the NLP solver stop early if convergence is slow?: 0 no, 1 yes (int)

Definition at line 43 of file type_nlpi.h.

◆ SCIP_NlpSolStat

enum SCIP_NlpSolStat

NLP solution status

Enumerator
SCIP_NLPSOLSTAT_GLOBOPT 

solved to global optimality

SCIP_NLPSOLSTAT_LOCOPT 

solved to local optimality

SCIP_NLPSOLSTAT_FEASIBLE 

feasible solution found

SCIP_NLPSOLSTAT_LOCINFEASIBLE 

solution found is local infeasible

SCIP_NLPSOLSTAT_GLOBINFEASIBLE 

problem is proven infeasible

SCIP_NLPSOLSTAT_UNBOUNDED 

problem is unbounded

SCIP_NLPSOLSTAT_UNKNOWN 

unknown solution status (e.g., problem not solved yet)

Definition at line 59 of file type_nlpi.h.

◆ SCIP_NlpTermStat

enum SCIP_NlpTermStat

NLP solution status NLP solver termination status

Enumerator
SCIP_NLPTERMSTAT_OKAY 

terminated successfully

SCIP_NLPTERMSTAT_TILIM 

time limit exceeded

SCIP_NLPTERMSTAT_ITLIM 

iteration limit exceeded

SCIP_NLPTERMSTAT_LOBJLIM 

lower objective limit reached

SCIP_NLPTERMSTAT_NUMERR 

stopped on numerical error

SCIP_NLPTERMSTAT_EVALERR 

stopped on function evaluation error

SCIP_NLPTERMSTAT_MEMERR 

memory exceeded

SCIP_NLPTERMSTAT_LICERR 

licence error

SCIP_NLPTERMSTAT_OTHER 

other error (= this should never happen)

Definition at line 72 of file type_nlpi.h.