Scippy

SCIP

Solving Constraint Integer Programs

SCIP_Exprhdlr Struct Reference

Detailed Description

generic data and callback methods of an expression handler

Definition at line 34 of file struct_expr.h.

#include <struct_expr.h>

Public Member Functions

 SCIP_DECL_EXPRCOPYHDLR ((*copyhdlr))
 
 SCIP_DECL_EXPRFREEHDLR ((*freehdlr))
 
 SCIP_DECL_EXPRCOPYDATA ((*copydata))
 
 SCIP_DECL_EXPRFREEDATA ((*freedata))
 
 SCIP_DECL_EXPRSIMPLIFY ((*simplify))
 
 SCIP_DECL_EXPRCOMPARE ((*compare))
 
 SCIP_DECL_EXPRPRINT ((*print))
 
 SCIP_DECL_EXPRPARSE ((*parse))
 
 SCIP_DECL_EXPREVAL ((*eval))
 
 SCIP_DECL_EXPRBWDIFF ((*bwdiff))
 
 SCIP_DECL_EXPRFWDIFF ((*fwdiff))
 
 SCIP_DECL_EXPRBWFWDIFF ((*bwfwdiff))
 
 SCIP_DECL_EXPRINTEVAL ((*inteval))
 
 SCIP_DECL_EXPRESTIMATE ((*estimate))
 
 SCIP_DECL_EXPRINITESTIMATES ((*initestimates))
 
 SCIP_DECL_EXPRREVERSEPROP ((*reverseprop))
 
 SCIP_DECL_EXPRHASH ((*hash))
 
 SCIP_DECL_EXPRCURVATURE ((*curvature))
 
 SCIP_DECL_EXPRMONOTONICITY ((*monotonicity))
 
 SCIP_DECL_EXPRINTEGRALITY ((*integrality))
 

Data Fields

char * name
 
char * desc
 
SCIP_EXPRHDLRDATAdata
 
unsigned int precedence
 
unsigned int ncreated
 
SCIP_Longint nestimatecalls
 
SCIP_Longint nintevalcalls
 
SCIP_Longint npropcalls
 
SCIP_Longint ncutoffs
 
SCIP_Longint ndomreds
 
SCIP_Longint nsimplifycalls
 
SCIP_Longint nsimplified
 
SCIP_Longint nbranchscores
 
SCIP_CLOCKestimatetime
 
SCIP_CLOCKintevaltime
 
SCIP_CLOCKproptime
 
SCIP_CLOCKsimplifytime
 

Member Function Documentation

◆ SCIP_DECL_EXPRCOPYHDLR()

SCIP_Exprhdlr::SCIP_DECL_EXPRCOPYHDLR ( copyhdlr)

handler copy callback (can be NULL)

◆ SCIP_DECL_EXPRFREEHDLR()

SCIP_Exprhdlr::SCIP_DECL_EXPRFREEHDLR ( freehdlr)

handler free callback (can be NULL)

◆ SCIP_DECL_EXPRCOPYDATA()

SCIP_Exprhdlr::SCIP_DECL_EXPRCOPYDATA ( copydata)

data copy callback, or NULL for expressions that have no data

◆ SCIP_DECL_EXPRFREEDATA()

SCIP_Exprhdlr::SCIP_DECL_EXPRFREEDATA ( freedata)

data free callback, or NULL for expressions that have no data or which data does not need to be freed

◆ SCIP_DECL_EXPRSIMPLIFY()

SCIP_Exprhdlr::SCIP_DECL_EXPRSIMPLIFY ( simplify)

simplify callback (can be NULL)

◆ SCIP_DECL_EXPRCOMPARE()

SCIP_Exprhdlr::SCIP_DECL_EXPRCOMPARE ( compare)

compare callback (can be NULL)

◆ SCIP_DECL_EXPRPRINT()

SCIP_Exprhdlr::SCIP_DECL_EXPRPRINT ( print)

print callback (can be NULL)

◆ SCIP_DECL_EXPRPARSE()

SCIP_Exprhdlr::SCIP_DECL_EXPRPARSE ( parse)

parse callback (can be NULL)

◆ SCIP_DECL_EXPREVAL()

SCIP_Exprhdlr::SCIP_DECL_EXPREVAL ( eval)

point evaluation callback (can never be NULL)

◆ SCIP_DECL_EXPRBWDIFF()

SCIP_Exprhdlr::SCIP_DECL_EXPRBWDIFF ( bwdiff)

backward derivative evaluation callback (can be NULL)

◆ SCIP_DECL_EXPRFWDIFF()

SCIP_Exprhdlr::SCIP_DECL_EXPRFWDIFF ( fwdiff)

forward derivative evaluation callback (can be NULL)

◆ SCIP_DECL_EXPRBWFWDIFF()

SCIP_Exprhdlr::SCIP_DECL_EXPRBWFWDIFF ( bwfwdiff)

backward over forward derivative evaluation callback (can be NULL)

◆ SCIP_DECL_EXPRINTEVAL()

SCIP_Exprhdlr::SCIP_DECL_EXPRINTEVAL ( inteval)

interval evaluation callback (can be NULL)

◆ SCIP_DECL_EXPRESTIMATE()

SCIP_Exprhdlr::SCIP_DECL_EXPRESTIMATE ( estimate)

estimation callback (can be NULL)

◆ SCIP_DECL_EXPRINITESTIMATES()

SCIP_Exprhdlr::SCIP_DECL_EXPRINITESTIMATES ( initestimates)

initial estimators callback (can be NULL)

◆ SCIP_DECL_EXPRREVERSEPROP()

SCIP_Exprhdlr::SCIP_DECL_EXPRREVERSEPROP ( reverseprop)

reverse propagation callback (can be NULL)

◆ SCIP_DECL_EXPRHASH()

SCIP_Exprhdlr::SCIP_DECL_EXPRHASH ( hash)

hash callback (can be NULL)

◆ SCIP_DECL_EXPRCURVATURE()

SCIP_Exprhdlr::SCIP_DECL_EXPRCURVATURE ( curvature)

curvature detection callback (can be NULL)

◆ SCIP_DECL_EXPRMONOTONICITY()

SCIP_Exprhdlr::SCIP_DECL_EXPRMONOTONICITY ( monotonicity)

monotonicity detection callback (can be NULL)

◆ SCIP_DECL_EXPRINTEGRALITY()

SCIP_Exprhdlr::SCIP_DECL_EXPRINTEGRALITY ( integrality)

integrality detection callback (can be NULL)

Field Documentation

◆ name

char* SCIP_Exprhdlr::name

expression handler name

Definition at line 36 of file struct_expr.h.

Referenced by SCIPexprCopy(), SCIPexprDismantle(), SCIPexprhdlrGetName(), SCIPexprhdlrHashExpr(), and SCIPexprPrintDot().

◆ desc

char* SCIP_Exprhdlr::desc

expression handler description (can be NULL)

Definition at line 37 of file struct_expr.h.

Referenced by SCIPexprhdlrGetDescription().

◆ data

SCIP_EXPRHDLRDATA* SCIP_Exprhdlr::data

data of handler

Definition at line 38 of file struct_expr.h.

Referenced by SCIPexprhdlrFree(), and SCIPexprhdlrGetData().

◆ precedence

unsigned int SCIP_Exprhdlr::precedence

precedence of expression operation relative to other expression (used for printing)

Definition at line 39 of file struct_expr.h.

Referenced by SCIPexprhdlrGetPrecedence().

◆ ncreated

unsigned int SCIP_Exprhdlr::ncreated

number of times expression has been created

Definition at line 64 of file struct_expr.h.

Referenced by SCIPexprCreate(), SCIPexprhdlrGetNCreated(), and SCIPexprhdlrInit().

◆ nestimatecalls

SCIP_Longint SCIP_Exprhdlr::nestimatecalls

number of times the estimation callback was called

Definition at line 65 of file struct_expr.h.

Referenced by SCIPexprhdlrEstimateExpr(), SCIPexprhdlrGetNEstimateCalls(), SCIPexprhdlrInit(), and SCIPexprhdlrInitEstimatesExpr().

◆ nintevalcalls

SCIP_Longint SCIP_Exprhdlr::nintevalcalls

number of times the interval evaluation callback was called

Definition at line 66 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNIntevalCalls(), SCIPexprhdlrInit(), and SCIPexprhdlrIntEvalExpr().

◆ npropcalls

SCIP_Longint SCIP_Exprhdlr::npropcalls

number of times the propagation callback was called

Definition at line 67 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNReversepropCalls(), SCIPexprhdlrInit(), and SCIPexprhdlrReversePropExpr().

◆ ncutoffs

SCIP_Longint SCIP_Exprhdlr::ncutoffs

number of cutoffs found so far by this expression handler

Definition at line 68 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNCutoffs(), SCIPexprhdlrInit(), and SCIPexprhdlrReversePropExpr().

◆ ndomreds

SCIP_Longint SCIP_Exprhdlr::ndomreds

number of domain reductions found so far by this expression handler

Definition at line 69 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNDomainReductions(), SCIPexprhdlrIncrementNDomainReductions(), and SCIPexprhdlrInit().

◆ nsimplifycalls

SCIP_Longint SCIP_Exprhdlr::nsimplifycalls

number of times the simplification callback was called

Definition at line 70 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNSimplifyCalls(), SCIPexprhdlrInit(), and SCIPexprhdlrSimplifyExpr().

◆ nsimplified

SCIP_Longint SCIP_Exprhdlr::nsimplified

number of times the simplification callback simplified

Definition at line 71 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNSimplifications(), SCIPexprhdlrInit(), and SCIPexprhdlrSimplifyExpr().

◆ nbranchscores

SCIP_Longint SCIP_Exprhdlr::nbranchscores

number of times branching scores were added by (or for) this expression handler

Definition at line 72 of file struct_expr.h.

Referenced by SCIPexprhdlrGetNBranchings(), SCIPexprhdlrIncrementNBranchings(), and SCIPexprhdlrInit().

◆ estimatetime

SCIP_CLOCK* SCIP_Exprhdlr::estimatetime

time used for estimation

Definition at line 74 of file struct_expr.h.

Referenced by SCIPexprhdlrEstimateExpr(), SCIPexprhdlrGetEstimateTime(), SCIPexprhdlrInit(), and SCIPexprhdlrInitEstimatesExpr().

◆ intevaltime

SCIP_CLOCK* SCIP_Exprhdlr::intevaltime

time used for interval evaluation

Definition at line 75 of file struct_expr.h.

Referenced by SCIPexprhdlrGetIntevalTime(), SCIPexprhdlrInit(), and SCIPexprhdlrIntEvalExpr().

◆ proptime

SCIP_CLOCK* SCIP_Exprhdlr::proptime

time used for propagation

Definition at line 76 of file struct_expr.h.

Referenced by SCIPexprhdlrGetReversepropTime(), SCIPexprhdlrInit(), and SCIPexprhdlrReversePropExpr().

◆ simplifytime

SCIP_CLOCK* SCIP_Exprhdlr::simplifytime

time used for expression simplification

Definition at line 77 of file struct_expr.h.

Referenced by SCIPexprhdlrGetSimplifyTime(), SCIPexprhdlrInit(), and SCIPexprhdlrSimplifyExpr().