Scippy

SCIP

Solving Constraint Integer Programs

type_objprobcloneable.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2021 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file type_objprobcloneable.h
17  * @ingroup TYPEDEFINITIONS
18  * @brief function type definitions for clonable classes which define problem data
19  * @author Marc Pfetsch
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_TYPE_OBJPROBCLONEABLE_H__
25 #define __SCIP_TYPE_OBJPROBCLONEABLE_H__
26 
27 /** clone method which will be used to copy constraint handler and variable pricer objects
28  *
29  * input:
30  * - scip : SCIP main data structure
31  *
32  * output:
33  * - valid : pointer to store whether to copy is valid w.r.t. copying dual reductions
34  */
35 #define SCIP_DECL_OBJPROBCLONE(x) x (SCIP* scip, SCIP_Bool* valid) const
36 #define SCIP_DECL_CONSHDLRCLONE(x) x (SCIP* scip, SCIP_Bool* valid) const
37 #define SCIP_DECL_PRICERCLONE(x) x (SCIP* scip, SCIP_Bool* valid) const
38 #define SCIP_DECL_BENDERSCLONE(x) x (SCIP* scip, SCIP_Bool* valid) const
39 
40 /** returns whether the plugin object is copyable
41  *
42  * return value : whether object is copyable
43  */
44 #define SCIP_DECL_OBJPROBISCLONEABLE(x) SCIP_Bool x (void) const
45 #define SCIP_DECL_CONSHDLRISCLONEABLE(x) SCIP_Bool x (void) const
46 #define SCIP_DECL_PRICERISCLONEABLE(x) SCIP_Bool x (void) const
47 #define SCIP_DECL_BENDERSISCLONEABLE(x) SCIP_Bool x (void) const
48 
49 #endif