1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file struct_nlhdlr.h
* @ingroup INTERNALAPI
* @brief structure definitions related to nonlinear handlers of nonlinear constraints
* @author Ksenia Bestuzheva
* @author Benjamin Mueller
* @author Felipe Serrano
* @author Stefan Vigerske
*/
#ifndef SCIP_STRUCT_NLHLDR_H_
#define SCIP_STRUCT_NLHLDR_H_
#include "scip/def.h"
#include "scip/type_scip.h"
#include "scip/type_nlhdlr.h"
#include "scip/type_clock.h"
/** generic data and callback methods of a nonlinear handler */
struct SCIP_Nlhdlr
{
char* name; /**< nonlinear handler name */
char* desc; /**< nonlinear handler description (can be NULL) */
SCIP_NLHDLRDATA* data; /**< data of handler */
int detectpriority; /**< detection priority of nonlinear handler */
int enfopriority; /**< enforcement priority of nonlinear handler */
SCIP_Bool enabled; /**< whether the nonlinear handler should be used */
/* callbacks */
SCIP_DECL_NLHDLRFREEHDLRDATA((*freehdlrdata)); /**< callback to free data of handler (can be NULL) */
SCIP_DECL_NLHDLRFREEEXPRDATA((*freeexprdata)); /**< callback to free expression specific data (can be NULL) */
SCIP_DECL_NLHDLRCOPYHDLR((*copyhdlr)); /**< callback to copy nonlinear handler (can be NULL) */
SCIP_DECL_NLHDLRINIT((*init)); /**< initialization callback (can be NULL) */
SCIP_DECL_NLHDLREXIT((*exit)); /**< deinitialization callback (can be NULL) */
SCIP_DECL_NLHDLRDETECT((*detect)); /**< structure detection callback */
SCIP_DECL_NLHDLREVALAUX((*evalaux)); /**< auxiliary evaluation callback */
SCIP_DECL_NLHDLRINITSEPA((*initsepa)); /**< separation initialization callback (can be NULL) */
SCIP_DECL_NLHDLRENFO((*enfo)); /**< enforcement callback (can be NULL) */
SCIP_DECL_NLHDLRESTIMATE((*estimate)); /**< estimator callback (can be NULL) */
SCIP_DECL_NLHDLREXITSEPA((*exitsepa)); /**< separation deinitialization callback (can be NULL) */
SCIP_DECL_NLHDLRINTEVAL((*inteval)); /**< interval evaluation callback (can be NULL) */
SCIP_DECL_NLHDLRREVERSEPROP((*reverseprop)); /**< reverse propagation callback (can be NULL) */
/* statistics */
SCIP_Longint nenfocalls; /**< number of times, the enforcement or estimation callback was called */
SCIP_Longint nintevalcalls; /**< number of times, the interval evaluation callback was called */
SCIP_Longint npropcalls; /**< number of times, the propagation callback was called */
SCIP_Longint nseparated; /**< number of times, the nonlinear handler enforced by separation */
SCIP_Longint ncutoffs; /**< number of cutoffs found so far by this nonlinear handler */
SCIP_Longint ndomreds; /**< number of domain reductions found so far by this nonlinear handler */
SCIP_Longint ndetections; /**< number of detect calls in which structure was detected (success returned by detect call) (over all runs) */
SCIP_Longint ndetectionslast; /**< number of detect calls in which structure was detected (success returned by detect call) (in last round) */
SCIP_Longint nbranchscores; /**< number of times, branching scores were added by this nonlinear handler */
SCIP_CLOCK* detecttime; /**< time used for detection */
SCIP_CLOCK* enfotime; /**< time used for enforcement or estimation */
SCIP_CLOCK* proptime; /**< time used for reverse propagation */
SCIP_CLOCK* intevaltime; /**< time used for interval evaluation */
};
#endif /* SCIP_STRUCT_NLHLDR_H_ */