Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Nlpi Struct Reference

Detailed Description

NLP interface data

Definition at line 37 of file struct_nlpi.h.

#include <struct_nlpi.h>

Public Member Functions

 SCIP_DECL_NLPICOPY ((*nlpicopy))
 
 SCIP_DECL_NLPIFREE ((*nlpifree))
 
 SCIP_DECL_NLPIGETSOLVERPOINTER ((*nlpigetsolverpointer))
 
 SCIP_DECL_NLPICREATEPROBLEM ((*nlpicreateproblem))
 
 SCIP_DECL_NLPIFREEPROBLEM ((*nlpifreeproblem))
 
 SCIP_DECL_NLPIGETPROBLEMPOINTER ((*nlpigetproblempointer))
 
 SCIP_DECL_NLPIADDVARS ((*nlpiaddvars))
 
 SCIP_DECL_NLPIADDCONSTRAINTS ((*nlpiaddconstraints))
 
 SCIP_DECL_NLPISETOBJECTIVE ((*nlpisetobjective))
 
 SCIP_DECL_NLPICHGVARBOUNDS ((*nlpichgvarbounds))
 
 SCIP_DECL_NLPICHGCONSSIDES ((*nlpichgconssides))
 
 SCIP_DECL_NLPIDELVARSET ((*nlpidelvarset))
 
 SCIP_DECL_NLPIDELCONSSET ((*nlpidelconsset))
 
 SCIP_DECL_NLPICHGLINEARCOEFS ((*nlpichglinearcoefs))
 
 SCIP_DECL_NLPICHGEXPR ((*nlpichgexpr))
 
 SCIP_DECL_NLPICHGOBJCONSTANT ((*nlpichgobjconstant))
 
 SCIP_DECL_NLPISETINITIALGUESS ((*nlpisetinitialguess))
 
 SCIP_DECL_NLPISOLVE ((*nlpisolve))
 
 SCIP_DECL_NLPIGETSOLSTAT ((*nlpigetsolstat))
 
 SCIP_DECL_NLPIGETTERMSTAT ((*nlpigettermstat))
 
 SCIP_DECL_NLPIGETSOLUTION ((*nlpigetsolution))
 
 SCIP_DECL_NLPIGETSTATISTICS ((*nlpigetstatistics))
 

Data Fields

char * name
 
char * description
 
int priority
 
SCIP_NLPIDATAnlpidata
 
int nproblems
 
int nsolves
 
SCIP_CLOCKproblemtime
 
SCIP_Real solvetime
 
SCIP_Real evaltime
 
SCIP_Longint niter
 
int ntermstat [SCIP_NLPTERMSTAT_OTHER+1]
 
int nsolstat [SCIP_NLPSOLSTAT_UNKNOWN+1]
 

Member Function Documentation

◆ SCIP_DECL_NLPICOPY()

SCIP_Nlpi::SCIP_DECL_NLPICOPY ( nlpicopy)

copy an NLPI

◆ SCIP_DECL_NLPIFREE()

SCIP_Nlpi::SCIP_DECL_NLPIFREE ( nlpifree)

free NLPI user data

◆ SCIP_DECL_NLPIGETSOLVERPOINTER()

SCIP_Nlpi::SCIP_DECL_NLPIGETSOLVERPOINTER ( nlpigetsolverpointer)

get solver pointer

◆ SCIP_DECL_NLPICREATEPROBLEM()

SCIP_Nlpi::SCIP_DECL_NLPICREATEPROBLEM ( nlpicreateproblem)

create a new problem instance

◆ SCIP_DECL_NLPIFREEPROBLEM()

SCIP_Nlpi::SCIP_DECL_NLPIFREEPROBLEM ( nlpifreeproblem)

free a problem instance

◆ SCIP_DECL_NLPIGETPROBLEMPOINTER()

SCIP_Nlpi::SCIP_DECL_NLPIGETPROBLEMPOINTER ( nlpigetproblempointer)

get problem pointer

◆ SCIP_DECL_NLPIADDVARS()

SCIP_Nlpi::SCIP_DECL_NLPIADDVARS ( nlpiaddvars)

add variables to a problem

◆ SCIP_DECL_NLPIADDCONSTRAINTS()

SCIP_Nlpi::SCIP_DECL_NLPIADDCONSTRAINTS ( nlpiaddconstraints)

add constraints to a problem

◆ SCIP_DECL_NLPISETOBJECTIVE()

SCIP_Nlpi::SCIP_DECL_NLPISETOBJECTIVE ( nlpisetobjective)

set objective of a problem

◆ SCIP_DECL_NLPICHGVARBOUNDS()

SCIP_Nlpi::SCIP_DECL_NLPICHGVARBOUNDS ( nlpichgvarbounds)

change variable bounds in a problem

◆ SCIP_DECL_NLPICHGCONSSIDES()

SCIP_Nlpi::SCIP_DECL_NLPICHGCONSSIDES ( nlpichgconssides)

change constraint sides in a problem

◆ SCIP_DECL_NLPIDELVARSET()

SCIP_Nlpi::SCIP_DECL_NLPIDELVARSET ( nlpidelvarset)

delete a set of variables from a problem

◆ SCIP_DECL_NLPIDELCONSSET()

SCIP_Nlpi::SCIP_DECL_NLPIDELCONSSET ( nlpidelconsset)

delete a set of constraints from a problem

◆ SCIP_DECL_NLPICHGLINEARCOEFS()

SCIP_Nlpi::SCIP_DECL_NLPICHGLINEARCOEFS ( nlpichglinearcoefs)

change coefficients in linear part of a constraint or objective

◆ SCIP_DECL_NLPICHGEXPR()

SCIP_Nlpi::SCIP_DECL_NLPICHGEXPR ( nlpichgexpr)

change nonlinear expression a constraint or objective

◆ SCIP_DECL_NLPICHGOBJCONSTANT()

SCIP_Nlpi::SCIP_DECL_NLPICHGOBJCONSTANT ( nlpichgobjconstant)

change the constant offset in the objective

◆ SCIP_DECL_NLPISETINITIALGUESS()

SCIP_Nlpi::SCIP_DECL_NLPISETINITIALGUESS ( nlpisetinitialguess)

set initial guess

◆ SCIP_DECL_NLPISOLVE()

SCIP_Nlpi::SCIP_DECL_NLPISOLVE ( nlpisolve)

solve a problem

◆ SCIP_DECL_NLPIGETSOLSTAT()

SCIP_Nlpi::SCIP_DECL_NLPIGETSOLSTAT ( nlpigetsolstat)

get solution status for a problem

◆ SCIP_DECL_NLPIGETTERMSTAT()

SCIP_Nlpi::SCIP_DECL_NLPIGETTERMSTAT ( nlpigettermstat)

get termination status for a problem

◆ SCIP_DECL_NLPIGETSOLUTION()

SCIP_Nlpi::SCIP_DECL_NLPIGETSOLUTION ( nlpigetsolution)

get solution of a problem

◆ SCIP_DECL_NLPIGETSTATISTICS()

SCIP_Nlpi::SCIP_DECL_NLPIGETSTATISTICS ( nlpigetstatistics)

get solve statistics for a problem

Field Documentation

◆ name

char* SCIP_Nlpi::name

name of NLP solver

Definition at line 39 of file struct_nlpi.h.

Referenced by SCIPnlpiGetName().

◆ description

char* SCIP_Nlpi::description

description of NLP solver

Definition at line 40 of file struct_nlpi.h.

Referenced by SCIPnlpiGetDesc().

◆ priority

int SCIP_Nlpi::priority

priority of NLP interface

Definition at line 41 of file struct_nlpi.h.

Referenced by SCIPnlpiGetPriority(), and SCIPnlpiSetPriority().

◆ nlpidata

SCIP_NLPIDATA* SCIP_Nlpi::nlpidata

NLP interface local data

Definition at line 64 of file struct_nlpi.h.

Referenced by SCIPnlpiFree(), and SCIPnlpiGetData().

◆ nproblems

int SCIP_Nlpi::nproblems

number of problems created

Definition at line 67 of file struct_nlpi.h.

Referenced by SCIPnlpiCreateProblem(), SCIPnlpiGetNProblems(), SCIPnlpiInit(), and SCIPnlpiMergeStatistics().

◆ nsolves

int SCIP_Nlpi::nsolves

number of solves

Definition at line 68 of file struct_nlpi.h.

Referenced by SCIPnlpiGetNSolves(), SCIPnlpiInit(), SCIPnlpiMergeStatistics(), and SCIPnlpiSolve().

◆ problemtime

◆ solvetime

SCIP_Real SCIP_Nlpi::solvetime

time spend in solve as reported by solver

Definition at line 70 of file struct_nlpi.h.

Referenced by SCIPnlpiGetSolveTime(), SCIPnlpiInit(), SCIPnlpiMergeStatistics(), and SCIPnlpiSolve().

◆ evaltime

SCIP_Real SCIP_Nlpi::evaltime

time spend in function evaluation during solve

Definition at line 71 of file struct_nlpi.h.

Referenced by SCIPnlpiGetEvalTime(), SCIPnlpiInit(), SCIPnlpiMergeStatistics(), and SCIPnlpiSolve().

◆ niter

SCIP_Longint SCIP_Nlpi::niter

total number of iterations

Definition at line 72 of file struct_nlpi.h.

Referenced by SCIPnlpiGetNIterations(), SCIPnlpiInit(), SCIPnlpiMergeStatistics(), and SCIPnlpiSolve().

◆ ntermstat

int SCIP_Nlpi::ntermstat[SCIP_NLPTERMSTAT_OTHER+1]

number of times a specific termination status occurred

Definition at line 73 of file struct_nlpi.h.

Referenced by SCIPnlpiGetNTermStat(), SCIPnlpiInit(), SCIPnlpiMergeStatistics(), and SCIPnlpiSolve().

◆ nsolstat

int SCIP_Nlpi::nsolstat[SCIP_NLPSOLSTAT_UNKNOWN+1]

number of times a specific solution status occurred

Definition at line 74 of file struct_nlpi.h.

Referenced by SCIPnlpiGetNSolStat(), SCIPnlpiInit(), SCIPnlpiMergeStatistics(), and SCIPnlpiSolve().