Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Nlhdlr Struct Reference

Detailed Description

generic data and callback methods of a nonlinear handler

Definition at line 34 of file struct_nlhdlr.h.

#include <struct_nlhdlr.h>

Public Member Functions

 SCIP_DECL_NLHDLRFREEHDLRDATA ((*freehdlrdata))
 
 SCIP_DECL_NLHDLRFREEEXPRDATA ((*freeexprdata))
 
 SCIP_DECL_NLHDLRCOPYHDLR ((*copyhdlr))
 
 SCIP_DECL_NLHDLRINIT ((*init))
 
 SCIP_DECL_NLHDLREXIT ((*exit))
 
 SCIP_DECL_NLHDLRDETECT ((*detect))
 
 SCIP_DECL_NLHDLREVALAUX ((*evalaux))
 
 SCIP_DECL_NLHDLRINITSEPA ((*initsepa))
 
 SCIP_DECL_NLHDLRENFO ((*enfo))
 
 SCIP_DECL_NLHDLRESTIMATE ((*estimate))
 
 SCIP_DECL_NLHDLREXITSEPA ((*exitsepa))
 
 SCIP_DECL_NLHDLRINTEVAL ((*inteval))
 
 SCIP_DECL_NLHDLRREVERSEPROP ((*reverseprop))
 

Data Fields

char * name
 
char * desc
 
SCIP_NLHDLRDATAdata
 
int detectpriority
 
int enfopriority
 
SCIP_Bool enabled
 
SCIP_Longint nenfocalls
 
SCIP_Longint nintevalcalls
 
SCIP_Longint npropcalls
 
SCIP_Longint nseparated
 
SCIP_Longint ncutoffs
 
SCIP_Longint ndomreds
 
SCIP_Longint ndetections
 
SCIP_Longint ndetectionslast
 
SCIP_Longint nbranchscores
 
SCIP_CLOCKdetecttime
 
SCIP_CLOCKenfotime
 
SCIP_CLOCKproptime
 
SCIP_CLOCKintevaltime
 

Member Function Documentation

◆ SCIP_DECL_NLHDLRFREEHDLRDATA()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRFREEHDLRDATA ( freehdlrdata)

callback to free data of handler (can be NULL)

◆ SCIP_DECL_NLHDLRFREEEXPRDATA()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRFREEEXPRDATA ( freeexprdata)

callback to free expression specific data (can be NULL)

◆ SCIP_DECL_NLHDLRCOPYHDLR()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRCOPYHDLR ( copyhdlr)

callback to copy nonlinear handler (can be NULL)

◆ SCIP_DECL_NLHDLRINIT()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRINIT ( init)

initialization callback (can be NULL)

◆ SCIP_DECL_NLHDLREXIT()

SCIP_Nlhdlr::SCIP_DECL_NLHDLREXIT ( exit)

deinitialization callback (can be NULL)

◆ SCIP_DECL_NLHDLRDETECT()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRDETECT ( detect)

structure detection callback

◆ SCIP_DECL_NLHDLREVALAUX()

SCIP_Nlhdlr::SCIP_DECL_NLHDLREVALAUX ( evalaux)

auxiliary evaluation callback

◆ SCIP_DECL_NLHDLRINITSEPA()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRINITSEPA ( initsepa)

separation initialization callback (can be NULL)

◆ SCIP_DECL_NLHDLRENFO()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRENFO ( enfo)

enforcement callback (can be NULL)

◆ SCIP_DECL_NLHDLRESTIMATE()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRESTIMATE ( estimate)

estimator callback (can be NULL)

◆ SCIP_DECL_NLHDLREXITSEPA()

SCIP_Nlhdlr::SCIP_DECL_NLHDLREXITSEPA ( exitsepa)

separation deinitialization callback (can be NULL)

◆ SCIP_DECL_NLHDLRINTEVAL()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRINTEVAL ( inteval)

interval evaluation callback (can be NULL)

◆ SCIP_DECL_NLHDLRREVERSEPROP()

SCIP_Nlhdlr::SCIP_DECL_NLHDLRREVERSEPROP ( reverseprop)

reverse propagation callback (can be NULL)

Field Documentation

◆ name

char* SCIP_Nlhdlr::name

nonlinear handler name

Definition at line 36 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), and SCIPnlhdlrGetName().

◆ desc

char* SCIP_Nlhdlr::desc

nonlinear handler description (can be NULL)

Definition at line 37 of file struct_nlhdlr.h.

Referenced by SCIPnlhdlrGetDesc().

◆ data

SCIP_NLHDLRDATA* SCIP_Nlhdlr::data

data of handler

Definition at line 38 of file struct_nlhdlr.h.

Referenced by SCIPnlhdlrFree(), and SCIPnlhdlrGetData().

◆ detectpriority

int SCIP_Nlhdlr::detectpriority

detection priority of nonlinear handler

Definition at line 40 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), and SCIPnlhdlrGetDetectPriority().

◆ enfopriority

int SCIP_Nlhdlr::enfopriority

enforcement priority of nonlinear handler

Definition at line 41 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_SORTPTRCOMP(), and SCIPnlhdlrGetEnfoPriority().

◆ enabled

SCIP_Bool SCIP_Nlhdlr::enabled

whether the nonlinear handler should be used

Definition at line 42 of file struct_nlhdlr.h.

Referenced by SCIPnlhdlrIsEnabled().

◆ nenfocalls

SCIP_Longint SCIP_Nlhdlr::nenfocalls

number of times, the enforcement or estimation callback was called

Definition at line 60 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRINITSEPA().

◆ nintevalcalls

SCIP_Longint SCIP_Nlhdlr::nintevalcalls

number of times, the interval evaluation callback was called

Definition at line 61 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRINTEVAL().

◆ npropcalls

SCIP_Longint SCIP_Nlhdlr::npropcalls

number of times, the propagation callback was called

Definition at line 62 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRREVERSEPROP().

◆ nseparated

SCIP_Longint SCIP_Nlhdlr::nseparated

number of times, the nonlinear handler enforced by separation

Definition at line 63 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRINIT(), and SCIPnlhdlrIncrementNSeparated().

◆ ncutoffs

SCIP_Longint SCIP_Nlhdlr::ncutoffs

number of cutoffs found so far by this nonlinear handler

Definition at line 64 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRINIT(), SCIP_DECL_NLHDLRINITSEPA(), SCIP_DECL_NLHDLRREVERSEPROP(), and SCIPnlhdlrIncrementNCutoffs().

◆ ndomreds

SCIP_Longint SCIP_Nlhdlr::ndomreds

number of domain reductions found so far by this nonlinear handler

Definition at line 65 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRREVERSEPROP().

◆ ndetections

SCIP_Longint SCIP_Nlhdlr::ndetections

number of detect calls in which structure was detected (success returned by detect call) (over all runs)

Definition at line 66 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRDETECT(), and SCIP_DECL_NLHDLRINIT().

◆ ndetectionslast

SCIP_Longint SCIP_Nlhdlr::ndetectionslast

number of detect calls in which structure was detected (success returned by detect call) (in last round)

Definition at line 67 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRDETECT(), SCIP_DECL_NLHDLRINIT(), and SCIPnlhdlrResetNDetectionslast().

◆ nbranchscores

SCIP_Longint SCIP_Nlhdlr::nbranchscores

number of times, branching scores were added by this nonlinear handler

Definition at line 68 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRENFO(), and SCIP_DECL_NLHDLRINIT().

◆ detecttime

SCIP_CLOCK* SCIP_Nlhdlr::detecttime

time used for detection

Definition at line 70 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRDETECT(), and SCIP_DECL_NLHDLRINIT().

◆ enfotime

SCIP_CLOCK* SCIP_Nlhdlr::enfotime

time used for enforcement or estimation

Definition at line 71 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRENFO(), SCIP_DECL_NLHDLRESTIMATE(), SCIP_DECL_NLHDLREXITSEPA(), SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRINITSEPA().

◆ proptime

SCIP_CLOCK* SCIP_Nlhdlr::proptime

time used for reverse propagation

Definition at line 72 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRREVERSEPROP().

◆ intevaltime

SCIP_CLOCK* SCIP_Nlhdlr::intevaltime

time used for interval evaluation

Definition at line 73 of file struct_nlhdlr.h.

Referenced by SCIP_DECL_NLHDLRINIT(), and SCIP_DECL_NLHDLRINTEVAL().