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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* 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 cons.h
* @ingroup INTERNALAPI
* @brief internal methods for constraints and constraint handlers
* @author Tobias Achterberg
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_CONS_H__
#define __SCIP_CONS_H__
#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_retcode.h"
#include "scip/type_result.h"
#include "scip/type_set.h"
#include "scip/type_stat.h"
#include "scip/type_mem.h"
#include "scip/type_misc.h"
#include "scip/type_timing.h"
#include "scip/type_lp.h"
#include "scip/type_var.h"
#include "scip/type_prob.h"
#include "scip/type_sol.h"
#include "scip/type_tree.h"
#include "scip/type_sepastore.h"
#include "scip/type_cons.h"
#include "scip/type_branch.h"
#include "scip/type_reopt.h"
#include "scip/pub_cons.h"
#ifndef NDEBUG
#include "scip/struct_cons.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* Constraint handler methods
*/
/** copies the given constraint handler to a new scip */
SCIP_RETCODE SCIPconshdlrCopyInclude(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_SET* set, /**< SCIP_SET of SCIP to copy to */
SCIP_Bool* valid /**< was the copying process valid? */
);
/** creates a constraint handler */
SCIP_RETCODE SCIPconshdlrCreate(
SCIP_CONSHDLR** conshdlr, /**< pointer to constraint handler data structure */
SCIP_SET* set, /**< global SCIP settings */
SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
BMS_BLKMEM* blkmem, /**< block memory for parameter settings */
const char* name, /**< name of constraint handler */
const char* desc, /**< description of constraint handler */
int sepapriority, /**< priority of the constraint handler for separation */
int enfopriority, /**< priority of the constraint handler for constraint enforcing */
int checkpriority, /**< priority of the constraint handler for checking feasibility (and propagation) */
int sepafreq, /**< frequency for separating cuts; zero means to separate only in the root node */
int propfreq, /**< frequency for propagating domains; zero means only preprocessing propagation */
int eagerfreq, /**< frequency for using all instead of only the useful constraints in separation,
* propagation and enforcement, -1 for no eager evaluations, 0 for first only */
int maxprerounds, /**< maximal number of presolving rounds the constraint handler participates in (-1: no limit) */
SCIP_Bool delaysepa, /**< should separation method be delayed, if other separators found cuts? */
SCIP_Bool delayprop, /**< should propagation method be delayed, if other propagators found reductions? */
SCIP_Bool needscons, /**< should the constraint handler be skipped, if no constraints are available? */
SCIP_PROPTIMING proptiming, /**< positions in the node solving loop where propagation method of constraint handlers should be executed */
SCIP_PRESOLTIMING presoltiming, /**< timing mask of the constraint handler's presolving method */
SCIP_DECL_CONSHDLRCOPY((*conshdlrcopy)), /**< copy method of constraint handler or NULL if you don't want to copy your plugin into sub-SCIPs */
SCIP_DECL_CONSFREE ((*consfree)), /**< destructor of constraint handler */
SCIP_DECL_CONSINIT ((*consinit)), /**< initialize constraint handler */
SCIP_DECL_CONSEXIT ((*consexit)), /**< deinitialize constraint handler */
SCIP_DECL_CONSINITPRE ((*consinitpre)), /**< presolving initialization method of constraint handler */
SCIP_DECL_CONSEXITPRE ((*consexitpre)), /**< presolving deinitialization method of constraint handler */
SCIP_DECL_CONSINITSOL ((*consinitsol)), /**< solving process initialization method of constraint handler */
SCIP_DECL_CONSEXITSOL ((*consexitsol)), /**< solving process deinitialization method of constraint handler */
SCIP_DECL_CONSDELETE ((*consdelete)), /**< free specific constraint data */
SCIP_DECL_CONSTRANS ((*constrans)), /**< transform constraint data into data belonging to the transformed problem */
SCIP_DECL_CONSINITLP ((*consinitlp)), /**< initialize LP with relaxations of "initial" constraints */
SCIP_DECL_CONSSEPALP ((*conssepalp)), /**< separate cutting planes for LP solution */
SCIP_DECL_CONSSEPASOL ((*conssepasol)), /**< separate cutting planes for arbitrary primal solution */
SCIP_DECL_CONSENFOLP ((*consenfolp)), /**< enforcing constraints for LP solutions */
SCIP_DECL_CONSENFORELAX ((*consenforelax)), /**< enforcing constraints for relaxation solutions */
SCIP_DECL_CONSENFOPS ((*consenfops)), /**< enforcing constraints for pseudo solutions */
SCIP_DECL_CONSCHECK ((*conscheck)), /**< check feasibility of primal solution */
SCIP_DECL_CONSPROP ((*consprop)), /**< propagate variable domains */
SCIP_DECL_CONSPRESOL ((*conspresol)), /**< presolving method */
SCIP_DECL_CONSRESPROP ((*consresprop)), /**< propagation conflict resolving method */
SCIP_DECL_CONSLOCK ((*conslock)), /**< variable rounding lock method */
SCIP_DECL_CONSACTIVE ((*consactive)), /**< activation notification method */
SCIP_DECL_CONSDEACTIVE((*consdeactive)), /**< deactivation notification method */
SCIP_DECL_CONSENABLE ((*consenable)), /**< enabling notification method */
SCIP_DECL_CONSDISABLE ((*consdisable)), /**< disabling notification method */
SCIP_DECL_CONSDELVARS ((*consdelvars)), /**< variable deletion method */
SCIP_DECL_CONSPRINT ((*consprint)), /**< constraint display method */
SCIP_DECL_CONSCOPY ((*conscopy)), /**< constraint copying method */
SCIP_DECL_CONSPARSE ((*consparse)), /**< constraint parsing method */
SCIP_DECL_CONSGETVARS ((*consgetvars)), /**< constraint get variables method */
SCIP_DECL_CONSGETNVARS((*consgetnvars)), /**< constraint get number of variable method */
SCIP_DECL_CONSGETDIVEBDCHGS((*consgetdivebdchgs)), /**< constraint handler diving solution enforcement method */
SCIP_CONSHDLRDATA* conshdlrdata /**< constraint handler data */
);
/** calls destructor and frees memory of constraint handler */
SCIP_RETCODE SCIPconshdlrFree(
SCIP_CONSHDLR** conshdlr, /**< pointer to constraint handler data structure */
SCIP_SET* set /**< global SCIP settings */
);
/** calls init method of constraint handler */
SCIP_RETCODE SCIPconshdlrInit(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** calls exit method of constraint handler */
SCIP_RETCODE SCIPconshdlrExit(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** informs constraint handler that the presolving process is being started */
SCIP_RETCODE SCIPconshdlrInitpre(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** informs constraint handler that the presolving is finished */
SCIP_RETCODE SCIPconshdlrExitpre(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** informs constraint handler that the branch and bound process is being started */
SCIP_RETCODE SCIPconshdlrInitsol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** informs constraint handler that the branch and bound process data is being freed */
SCIP_RETCODE SCIPconshdlrExitsol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_Bool restart /**< was this exit solve call triggered by a restart? */
);
/** calls LP initialization method of constraint handler to separate all initial active constraints */
SCIP_RETCODE SCIPconshdlrInitLP(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_TREE* tree, /**< branch and bound tree */
SCIP_Bool initkeptconss, /**< Also initialize constraints which are valid at a more global node,
* but were not activated there? Should be FALSE for repeated calls at
* one node or if the current focusnode is a child of the former one */
SCIP_Bool* cutoff /**< pointer to store whether infeasibility was detected while building the LP */
);
/** calls separator method of constraint handler to separate LP solution */
SCIP_RETCODE SCIPconshdlrSeparateLP(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_SEPASTORE* sepastore, /**< separation storage */
int depth, /**< depth of current node */
SCIP_Bool execdelayed, /**< execute separation method even if it is marked to be delayed */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls separator method of constraint handler to separate given primal solution */
SCIP_RETCODE SCIPconshdlrSeparateSol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_SEPASTORE* sepastore, /**< separation storage */
SCIP_SOL* sol, /**< primal solution that should be separated */
int depth, /**< depth of current node */
SCIP_Bool execdelayed, /**< execute separation method even if it is marked to be delayed */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls enforcing method of constraint handler for a relaxation solution for all constraints added after last
* conshdlrResetEnfo() call
*/
SCIP_RETCODE SCIPconshdlrEnforceRelaxSol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_TREE* tree, /**< branch and bound tree */
SCIP_SEPASTORE* sepastore, /**< separation storage */
SCIP_SOL* relaxsol, /**< solution to be enforced */
SCIP_Bool solinfeasible, /**< was the solution already found out to be infeasible? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls enforcing method of constraint handler for LP solution for all constraints added after last
* conshdlrReset() call
*/
SCIP_RETCODE SCIPconshdlrEnforceLPSol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_TREE* tree, /**< branch and bound tree */
SCIP_SEPASTORE* sepastore, /**< separation storage */
SCIP_Bool solinfeasible, /**< was the solution already found out to be infeasible? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls diving solution enforcement callback of constraint handler, if it exists */
SCIP_RETCODE SCIPconshdlrGetDiveBoundChanges(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_SET* set, /**< global SCIP settings */
SCIP_DIVESET* diveset, /**< diving settings to control scoring */
SCIP_SOL* sol, /**< current solution of diving mode */
SCIP_Bool* success, /**< pointer to store whether constraint handler successfully found a variable */
SCIP_Bool* infeasible /**< pointer to store whether the current node was detected to be infeasible */
);
/** calls enforcing method of constraint handler for pseudo solution for all constraints added after last
* conshdlrReset() call
*/
SCIP_RETCODE SCIPconshdlrEnforcePseudoSol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_TREE* tree, /**< branch and bound tree */
SCIP_BRANCHCAND* branchcand, /**< branching candidate storage */
SCIP_Bool solinfeasible, /**< was the solution already found out to be infeasible? */
SCIP_Bool objinfeasible, /**< is the solution infeasible anyway due to violating lower objective bound? */
SCIP_Bool forced, /**< should enforcement of pseudo solution be forced? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls feasibility check method of constraint handler */
SCIP_RETCODE SCIPconshdlrCheck(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_SOL* sol, /**< primal CIP solution */
SCIP_Bool checkintegrality, /**< Has integrality to be checked? */
SCIP_Bool checklprows, /**< Do constraints represented by rows in the current LP have to be checked? */
SCIP_Bool printreason, /**< Should the reason for the violation be printed? */
SCIP_Bool completely, /**< Should all violations be checked? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls propagation method of constraint handler */
SCIP_RETCODE SCIPconshdlrPropagate(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
int depth, /**< depth of current node; -1 if preprocessing domain propagation */
SCIP_Bool fullpropagation, /**< should all constraints be propagated (or only new ones)? */
SCIP_Bool execdelayed, /**< execute propagation method even if it is marked to be delayed */
SCIP_Bool instrongbranching, /**< are we currently doing strong branching? */
SCIP_PROPTIMING proptiming, /**< current point in the node solving process */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls presolving method of constraint handler */
SCIP_RETCODE SCIPconshdlrPresolve(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_PRESOLTIMING timing, /**< current presolving timing */
int nrounds, /**< number of presolving rounds already done */
int* nfixedvars, /**< pointer to total number of variables fixed of all presolvers */
int* naggrvars, /**< pointer to total number of variables aggregated of all presolvers */
int* nchgvartypes, /**< pointer to total number of variable type changes of all presolvers */
int* nchgbds, /**< pointer to total number of variable bounds tightened of all presolvers */
int* naddholes, /**< pointer to total number of domain holes added of all presolvers */
int* ndelconss, /**< pointer to total number of deleted constraints of all presolvers */
int* naddconss, /**< pointer to total number of added constraints of all presolvers */
int* nupgdconss, /**< pointer to total number of upgraded constraints of all presolvers */
int* nchgcoefs, /**< pointer to total number of changed coefficients of all presolvers */
int* nchgsides, /**< pointer to total number of changed left/right hand sides of all presolvers */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** enables or disables all clocks of \p conshdlr, depending on the value of the flag */
void SCIPconshdlrEnableOrDisableClocks(
SCIP_CONSHDLR* conshdlr, /**< the constraint handler for which all clocks should be enabled or disabled */
SCIP_Bool enable /**< should the clocks of the constraint handler be enabled? */
);
/** calls variable deletion method of constraint handler */
SCIP_RETCODE SCIPconshdlrDelVars(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** locks rounding of variables involved in the given constraint constraint handler that doesn't need constraints */
SCIP_RETCODE SCIPconshdlrLockVars(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_SET* set /**< global SCIP settings */
);
/** unlocks rounding of variables involved in the given constraint constraint handler that doesn't need constraints */
SCIP_RETCODE SCIPconshdlrUnlockVars(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_SET* set /**< global SCIP settings */
);
/**
* callback setter methods of constraint handlers
*/
/** sets copy method of both the constraint handler and each associated constraint */
void SCIPconshdlrSetCopy(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSHDLRCOPY((*conshdlrcopy)), /**< copy method of constraint handler or NULL if you don't want to copy your plugin into sub-SCIPs */
SCIP_DECL_CONSCOPY ((*conscopy)) /**< constraint copying method */
);
/** sets destructor method of constraint handler */
void SCIPconshdlrSetFree(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSFREE ((*consfree)) /**< destructor of constraint handler */
);
/** sets initialization method of constraint handler */
void SCIPconshdlrSetInit(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSINIT ((*consinit)) /**< initialize constraint handler */
);
/** sets deinitialization method of constraint handler */
void SCIPconshdlrSetExit(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSEXIT ((*consexit)) /**< deinitialize constraint handler */
);
/** sets solving process initialization method of constraint handler */
void SCIPconshdlrSetInitsol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSINITSOL((*consinitsol)) /**< solving process initialization method of constraint handler */
);
/** sets solving process deinitialization method of constraint handler */
void SCIPconshdlrSetExitsol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSEXITSOL ((*consexitsol)) /**< solving process deinitialization method of constraint handler */
);
/** sets preprocessing initialization method of constraint handler */
void SCIPconshdlrSetInitpre(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSINITPRE((*consinitpre)) /**< preprocessing initialization method of constraint handler */
);
/** sets preprocessing deinitialization method of constraint handler */
void SCIPconshdlrSetExitpre(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSEXITPRE((*consexitpre)) /**< preprocessing deinitialization method of constraint handler */
);
/** sets presolving method of constraint handler */
SCIP_RETCODE SCIPconshdlrSetPresol(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSPRESOL ((*conspresol)), /**< presolving method of constraint handler */
int maxprerounds, /**< maximal number of presolving rounds the constraint handler participates in (-1: no limit) */
SCIP_PRESOLTIMING presoltiming /**< timing mask of the constraint handler's presolving method */
);
/** sets method of constraint handler to free specific constraint data */
void SCIPconshdlrSetDelete(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSDELETE ((*consdelete)) /**< free specific constraint data */
);
/** sets method of constraint handler to transform constraint data into data belonging to the transformed problem */
void SCIPconshdlrSetTrans(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSTRANS ((*constrans)) /**< transform constraint data into data belonging to the transformed problem */
);
/** sets method of constraint handler to initialize LP with relaxations of "initial" constraints */
void SCIPconshdlrSetInitlp(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSINITLP ((*consinitlp)) /**< initialize LP with relaxations of "initial" constraints */
);
/** sets propagation conflict resolving method of constraint handler */
void SCIPconshdlrSetResprop(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSRESPROP ((*consresprop)) /**< propagation conflict resolving method */
);
/** sets activation notification method of constraint handler */
void SCIPconshdlrSetActive(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSACTIVE ((*consactive)) /**< activation notification method */
);
/** sets deactivation notification method of constraint handler */
void SCIPconshdlrSetDeactive(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSDEACTIVE((*consdeactive)) /**< deactivation notification method */
);
/** sets enabling notification method of constraint handler */
void SCIPconshdlrSetEnable(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSENABLE ((*consenable)) /**< enabling notification method */
);
/** sets disabling notification method of constraint handler */
void SCIPconshdlrSetDisable(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSDISABLE ((*consdisable)) /**< disabling notification method */
);
/** sets variable deletion method of constraint handler */
void SCIPconshdlrSetDelvars(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSDELVARS ((*consdelvars)) /**< variable deletion method */
);
/** sets constraint display method of constraint handler */
void SCIPconshdlrSetPrint(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSPRINT ((*consprint)) /**< constraint display method */
);
/** sets constraint parsing method of constraint handler */
void SCIPconshdlrSetParse(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSPARSE ((*consparse)) /**< constraint parsing method */
);
/** sets constraint variable getter method of constraint handler */
void SCIPconshdlrSetGetVars(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSGETVARS ((*consgetvars)) /**< constraint variable getter method */
);
/** sets constraint variable number getter method of constraint handler */
void SCIPconshdlrSetGetNVars(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSGETNVARS((*consgetnvars)) /**< constraint variable number getter method */
);
/** sets diving enforcement method of constraint handler */
void SCIPconshdlrSetGetDiveBdChgs(
SCIP_CONSHDLR* conshdlr, /**< constraint handler */
SCIP_DECL_CONSGETDIVEBDCHGS((*consgetdivebdchgs)) /**< constraint handler diving solution enforcement method */
);
/*
* Constraint set change methods
*/
/** frees constraint set change data and releases all included constraints */
SCIP_RETCODE SCIPconssetchgFree(
SCIP_CONSSETCHG** conssetchg, /**< pointer to constraint set change */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set /**< global SCIP settings */
);
/** adds constraint addition to constraint set changes, and captures constraint; activates constraint if the
* constraint set change data is currently active
*/
SCIP_RETCODE SCIPconssetchgAddAddedCons(
SCIP_CONSSETCHG** conssetchg, /**< pointer to constraint set change data structure */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_CONS* cons, /**< added constraint */
int depth, /**< depth of constraint set change's node */
SCIP_Bool focusnode, /**< does the constraint set change belong to the focus node? */
SCIP_Bool active /**< is the constraint set change currently active? */
);
/** adds constraint disabling to constraint set changes, and captures constraint */
SCIP_RETCODE SCIPconssetchgAddDisabledCons(
SCIP_CONSSETCHG** conssetchg, /**< pointer to constraint set change data structure */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_CONS* cons /**< disabled constraint */
);
/** applies constraint set change */
SCIP_RETCODE SCIPconssetchgApply(
SCIP_CONSSETCHG* conssetchg, /**< constraint set change to apply */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
int depth, /**< depth of constraint set change's node */
SCIP_Bool focusnode /**< does the constraint set change belong to the focus node? */
);
/** undoes constraint set change */
SCIP_RETCODE SCIPconssetchgUndo(
SCIP_CONSSETCHG* conssetchg, /**< constraint set change to undo */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** applies constraint set change to the global problem and deletes the constraint set change data */
SCIP_RETCODE SCIPconssetchgMakeGlobal(
SCIP_CONSSETCHG** conssetchg, /**< pointer to constraint set change data */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_PROB* prob, /**< problem data */
SCIP_REOPT* reopt /**< reoptimization data */
);
/** increase count of applied cuts */
void SCIPconshdlrIncNAppliedCuts(
SCIP_CONSHDLR* conshdlr /**< constraint handler */
);
/** increase count of found cuts */
void SCIPconshdlrIncNCutsFound(
SCIP_CONSHDLR* conshdlr /**< constraint handler */
);
/*
* Constraint methods
*/
/** creates and captures a constraint, and inserts it into the conss array of its constraint handler
*
* @warning If a constraint is marked to be checked for feasibility but not to be enforced, a LP or pseudo solution
* may be declared feasible even if it violates this particular constraint.
* This constellation should only be used, if no LP or pseudo solution can violate the constraint -- e.g. if a
* local constraint is redundant due to the variable's local bounds.
*/
SCIP_RETCODE SCIPconsCreate(
SCIP_CONS** cons, /**< pointer to constraint */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
const char* name, /**< name of constraint */
SCIP_CONSHDLR* conshdlr, /**< constraint handler for this constraint */
SCIP_CONSDATA* consdata, /**< data for this specific constraint */
SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
* Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
SCIP_Bool separate, /**< should the constraint be separated during LP processing?
* Usually set to TRUE. */
SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
* TRUE for model constraints, FALSE for additional, redundant constraints. */
SCIP_Bool check, /**< should the constraint be checked for feasibility?
* TRUE for model constraints, FALSE for additional, redundant constraints. */
SCIP_Bool propagate, /**< should the constraint be propagated during node processing?
* Usually set to TRUE. */
SCIP_Bool local, /**< is constraint only valid locally?
* Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
* Usually set to FALSE. In column generation applications, set to TRUE if pricing
* adds coefficients to this constraint. */
SCIP_Bool dynamic, /**< is constraint subject to aging?
* Usually set to FALSE. Set to TRUE for own cuts which
* are separated as constraints. */
SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup?
* Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */
SCIP_Bool stickingatnode, /**< should the constraint always be kept at the node where it was added, even
* if it may be moved to a more global node?
* Usually set to FALSE. Set to TRUE to for constraints that represent node data. */
SCIP_Bool original, /**< is constraint belonging to the original problem? */
SCIP_Bool deleteconsdata /**< has the constraint data to be deleted if constraint is freed? */
);
/** copies source constraint of source SCIP into the target constraint for the target SCIP, using the variable map for
* mapping the variables of the source SCIP to the variables of the target SCIP; if the copying process was successful
* a constraint is created and captured;
*
* @warning If a constraint is marked to be checked for feasibility but not to be enforced, an LP or pseudo solution
* may be declared feasible even if it violates this particular constraint.
* This constellation should only be used, if no LP or pseudo solution can violate the constraint -- e.g. if a
* local constraint is redundant due to the variable's local bounds.
*/
SCIP_RETCODE SCIPconsCopy(
SCIP_CONS** cons, /**< pointer to store the created target constraint */
SCIP_SET* set, /**< global SCIP settings of the target SCIP */
const char* name, /**< name of constraint, or NULL if the name of the source constraint should be used */
SCIP* sourcescip, /**< source SCIP data structure */
SCIP_CONSHDLR* sourceconshdlr, /**< source constraint handler for this constraint */
SCIP_CONS* sourcecons, /**< source constraint of the source SCIP */
SCIP_HASHMAP* varmap, /**< a SCIP_HASHMAP mapping variables of the source SCIP to corresponding
* variables of the target SCIP */
SCIP_HASHMAP* consmap, /**< a hashmap to store the mapping of source constraints to the corresponding
* target constraints, must not be NULL! */
SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP? */
SCIP_Bool separate, /**< should the constraint be separated during LP processing? */
SCIP_Bool enforce, /**< should the constraint be enforced during node processing? */
SCIP_Bool check, /**< should the constraint be checked for feasibility? */
SCIP_Bool propagate, /**< should the constraint be propagated during node processing? */
SCIP_Bool local, /**< is constraint only valid locally? */
SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)? */
SCIP_Bool dynamic, /**< is constraint subject to aging? */
SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup? */
SCIP_Bool stickingatnode, /**< should the constraint always be kept at the node where it was added, even
* if it may be moved to a more global node? */
SCIP_Bool global, /**< create a global or a local copy? */
SCIP_Bool* valid /**< pointer to store whether the copying was valid or not */
);
/** parses constraint information (in cip format) out of a string; if the parsing process was successful a constraint is
* created, captured, and inserted into the conss array of its constraint handler.
*
* @warning If a constraint is marked to be checked for feasibility but not to be enforced, an LP or pseudo solution
* may be declared feasible even if it violates this particular constraint.
* This constellation should only be used, if no LP or pseudo solution can violate the constraint -- e.g. if a
* local constraint is redundant due to the variable's local bounds.
*/
SCIP_RETCODE SCIPconsParse(
SCIP_CONS** cons, /**< pointer to constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_MESSAGEHDLR* messagehdlr, /**< message handler of target SCIP */
const char* str, /**< name of constraint */
SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
* Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
SCIP_Bool separate, /**< should the constraint be separated during LP processing?
* Usually set to TRUE. */
SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
* TRUE for model constraints, FALSE for additional, redundant constraints. */
SCIP_Bool check, /**< should the constraint be checked for feasibility?
* TRUE for model constraints, FALSE for additional, redundant constraints. */
SCIP_Bool propagate, /**< should the constraint be propagated during node processing?
* Usually set to TRUE. */
SCIP_Bool local, /**< is constraint only valid locally?
* Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
* Usually set to FALSE. In column generation applications, set to TRUE if pricing
* adds coefficients to this constraint. */
SCIP_Bool dynamic, /**< is constraint subject to aging?
* Usually set to FALSE. Set to TRUE for own cuts which
* are separated as constraints. */
SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup?
* Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */
SCIP_Bool stickingatnode, /**< should the constraint always be kept at the node where it was added, even
* if it may be moved to a more global node?
* Usually set to FALSE. Set to TRUE to for constraints that represent node data. */
SCIP_Bool* success /**< pointer store if the paring process was successful */
);
/** change name of given constraint */
SCIP_RETCODE SCIPconsChgName(
SCIP_CONS* cons, /**< problem constraint */
BMS_BLKMEM* blkmem, /**< block memory buffer */
const char* name /**< new name of constraint */
);
/** frees a constraint and removes it from the conss array of its constraint handler */
SCIP_RETCODE SCIPconsFree(
SCIP_CONS** cons, /**< constraint to free */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set /**< global SCIP settings */
);
/** increases usage counter of constraint */
void SCIPconsCapture(
SCIP_CONS* cons /**< constraint */
);
/** decreases usage counter of constraint, and frees memory if necessary */
SCIP_RETCODE SCIPconsRelease(
SCIP_CONS** cons, /**< pointer to constraint */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set /**< global SCIP settings */
);
/** outputs constraint information to file stream */
SCIP_RETCODE SCIPconsPrint(
SCIP_CONS* cons, /**< constraint to print */
SCIP_SET* set, /**< global SCIP settings */
SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
FILE* file /**< output file (or NULL for standard output) */
);
/** checks single constraint for feasibility of the given solution */
SCIP_RETCODE SCIPconsCheck(
SCIP_CONS* cons, /**< constraint to check */
SCIP_SET* set, /**< global SCIP settings */
SCIP_SOL* sol, /**< primal CIP solution */
SCIP_Bool checkintegrality, /**< Has integrality to be checked? */
SCIP_Bool checklprows, /**< Do constraints represented by rows in the current LP have to be checked? */
SCIP_Bool printreason, /**< Should the reason for the violation be printed? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** enforces single constraint for a given pseudo solution */
SCIP_RETCODE SCIPconsEnfops(
SCIP_CONS* cons, /**< constraint to enforce */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool solinfeasible, /**< was the solution already declared infeasible by a constraint handler? */
SCIP_Bool objinfeasible, /**< is the solution infeasible anyway due to violating lower objective bound? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** enforces single constraint for a given LP solution */
SCIP_RETCODE SCIPconsEnfolp(
SCIP_CONS* cons, /**< constraint to enforce */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool solinfeasible, /**< was the solution already declared infeasible by a constraint handler? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** enforces single constraint for a given relaxation solution */
SCIP_RETCODE SCIPconsEnforelax(
SCIP_CONS* cons, /**< constraint to enforce */
SCIP_SET* set, /**< global SCIP settings */
SCIP_SOL* sol, /**< solution to be enforced */
SCIP_Bool solinfeasible, /**< was the solution already declared infeasible by a constraint handler? */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls LP initialization method for single constraint */
SCIP_RETCODE SCIPconsInitlp(
SCIP_CONS* cons, /**< constraint to initialize */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool* infeasible /**< pointer to store whether infeasibility was detected while building the LP */
);
/** calls separation method of single constraint for LP solution */
SCIP_RETCODE SCIPconsSepalp(
SCIP_CONS* cons, /**< constraint to separate */
SCIP_SET* set, /**< global SCIP settings */
SCIP_RESULT* result /**< pointer to store the result of the separation call */
);
/** calls separation method of single constraint for given primal solution */
SCIP_RETCODE SCIPconsSepasol(
SCIP_CONS* cons, /**< constraint to separate */
SCIP_SET* set, /**< global SCIP settings */
SCIP_SOL* sol, /**< primal solution that should be separated */
SCIP_RESULT* result /**< pointer to store the result of the separation call */
);
/** calls domain propagation method of single constraint */
SCIP_RETCODE SCIPconsProp(
SCIP_CONS* cons, /**< constraint to propagate */
SCIP_SET* set, /**< global SCIP settings */
SCIP_PROPTIMING proptiming, /**< current point in the node solving loop */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** resolves propagation conflict of single constraint */
SCIP_RETCODE SCIPconsResprop(
SCIP_CONS* cons, /**< constraint to resolve conflict for */
SCIP_SET* set, /**< global SCIP settings */
SCIP_VAR* infervar, /**< the conflict variable whose bound change has to be resolved */
int inferinfo, /**< the user information passed to the corresponding SCIPinferVarLbCons() or SCIPinferVarUbCons() call */
SCIP_BOUNDTYPE boundtype, /**< the type of the changed bound (lower or upper bound) */
SCIP_BDCHGIDX* bdchgidx, /**< the index of the bound change, representing the point of time where the change took place */
SCIP_Real relaxedbd, /**< the relaxed bound which is sufficient to be explained */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** presolves single constraint */
SCIP_RETCODE SCIPconsPresol(
SCIP_CONS* cons, /**< constraint to presolve */
SCIP_SET* set, /**< global SCIP settings */
int nrounds, /**< number of presolving rounds already done */
SCIP_PRESOLTIMING timing, /**< current presolving timing */
int nnewfixedvars, /**< number of variables fixed since the last call to the presolving method */
int nnewaggrvars, /**< number of variables aggregated since the last call to the presolving method */
int nnewchgvartypes, /**< number of variable type changes since the last call to the presolving method */
int nnewchgbds, /**< number of variable bounds tightened since the last call to the presolving method */
int nnewholes, /**< number of domain holes added since the last call to the presolving method */
int nnewdelconss, /**< number of deleted constraints since the last call to the presolving method */
int nnewaddconss, /**< number of added constraints since the last call to the presolving method */
int nnewupgdconss, /**< number of upgraded constraints since the last call to the presolving method */
int nnewchgcoefs, /**< number of changed coefficients since the last call to the presolving method */
int nnewchgsides, /**< number of changed left or right hand sides since the last call to the presolving method */
int* nfixedvars, /**< pointer to count total number of variables fixed of all presolvers */
int* naggrvars, /**< pointer to count total number of variables aggregated of all presolvers */
int* nchgvartypes, /**< pointer to count total number of variable type changes of all presolvers */
int* nchgbds, /**< pointer to count total number of variable bounds tightened of all presolvers */
int* naddholes, /**< pointer to count total number of domain holes added of all presolvers */
int* ndelconss, /**< pointer to count total number of deleted constraints of all presolvers */
int* naddconss, /**< pointer to count total number of added constraints of all presolvers */
int* nupgdconss, /**< pointer to count total number of upgraded constraints of all presolvers */
int* nchgcoefs, /**< pointer to count total number of changed coefficients of all presolvers */
int* nchgsides, /**< pointer to count total number of changed left/right hand sides of all presolvers */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** calls constraint activation notification method of single constraint */
SCIP_RETCODE SCIPconsActive(
SCIP_CONS* cons, /**< constraint to notify */
SCIP_SET* set /**< global SCIP settings */
);
/** calls constraint deactivation notification method of single constraint */
SCIP_RETCODE SCIPconsDeactive(
SCIP_CONS* cons, /**< constraint to notify */
SCIP_SET* set /**< global SCIP settings */
);
/** method to collect the variables of a constraint
*
* If the number of variables is greater than the available slots in the variable array, nothing happens except that
* the success point is set to FALSE. With the method SCIPgetConsNVars() it is possible to get the number of variables
* a constraint has in its scope.
*
* @note The success pointer indicates if all variables were copied into the vars arrray.
*
* @note It might be that a constraint handler does not support this functionality, in that case the success pointer is
* set to FALSE.
*/
SCIP_RETCODE SCIPconsGetVars(
SCIP_CONS* cons, /**< constraint to print */
SCIP_SET* set, /**< global SCIP settings */
SCIP_VAR** vars, /**< array to store the involved variable of the constraint */
int varssize, /**< available slots in vars array which is needed to check if the array is large enough */
SCIP_Bool* success /**< pointer to store whether the variables are successfully copied */
);
/** method to collect the number of variables of a constraint
*
* @note The success pointer indicates if the contraint handler was able to return the number of variables
*
* @note It might be that a constraint handler does not support this functionality, in that case the success pointer is
* set to FALSE
*/
SCIP_RETCODE SCIPconsGetNVars(
SCIP_CONS* cons, /**< constraint to print */
SCIP_SET* set, /**< global SCIP settings */
int* nvars, /**< pointer to store the number of variables */
SCIP_Bool* success /**< pointer to store whether the constraint successfully returned the number of variables */
);
/** globally removes constraint from all subproblems; removes constraint from the constraint set change data of the
* node, where it was created, or from the problem, if it was a problem constraint
*/
SCIP_RETCODE SCIPconsDelete(
SCIP_CONS* cons, /**< constraint to delete */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_PROB* prob, /**< problem data */
SCIP_REOPT* reopt /**< reoptimization data */
);
/** gets and captures transformed constraint of a given constraint; if the constraint is not yet transformed,
* a new transformed constraint for this constraint is created
*/
SCIP_RETCODE SCIPconsTransform(
SCIP_CONS* origcons, /**< original constraint */
BMS_BLKMEM* blkmem, /**< block memory buffer */
SCIP_SET* set, /**< global SCIP settings */
SCIP_CONS** transcons /**< pointer to store the transformed constraint */
);
/** sets the initial flag of the given constraint */
SCIP_RETCODE SCIPconsSetInitial(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_Bool initial /**< new value */
);
/** sets the separate flag of the given constraint */
SCIP_RETCODE SCIPconsSetSeparated(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool separate /**< new value */
);
/** sets the enforce flag of the given constraint */
SCIP_RETCODE SCIPconsSetEnforced(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool enforce /**< new value */
);
/** sets the check flag of the given constraint */
SCIP_RETCODE SCIPconsSetChecked(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool check /**< new value */
);
/** sets the propagate flag of the given constraint */
SCIP_RETCODE SCIPconsSetPropagated(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_Bool propagate /**< new value */
);
/** sets the local flag of the given constraint */
void SCIPconsSetLocal(
SCIP_CONS* cons, /**< constraint */
SCIP_Bool local /**< new value */
);
/** sets the modifiable flag of the given constraint */
void SCIPconsSetModifiable(
SCIP_CONS* cons, /**< constraint */
SCIP_Bool modifiable /**< new value */
);
/** sets the dynamic flag of the given constraint */
void SCIPconsSetDynamic(
SCIP_CONS* cons, /**< constraint */
SCIP_Bool dynamic /**< new value */
);
/** sets the removable flag of the given constraint */
void SCIPconsSetRemovable(
SCIP_CONS* cons, /**< constraint */
SCIP_Bool removable /**< new value */
);
/** sets the stickingatnode flag of the given constraint */
void SCIPconsSetStickingAtNode(
SCIP_CONS* cons, /**< constraint */
SCIP_Bool stickingatnode /**< new value */
);
/** gives the constraint a new name; ATTENTION: to old pointer is over written that might
* result in a memory leakage */
void SCIPconsSetNamePointer(
SCIP_CONS* cons, /**< constraint */
const char* name /**< new name of constraint */
);
/** gets associated transformed constraint of an original constraint, or NULL if no associated transformed constraint
* exists
*/
SCIP_CONS* SCIPconsGetTransformed(
SCIP_CONS* cons /**< constraint */
);
/** activates constraint or marks constraint to be activated in next update */
SCIP_RETCODE SCIPconsActivate(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
int depth, /**< depth in the tree where the constraint activation takes place, or -1 for global problem */
SCIP_Bool focusnode /**< does the constraint activation take place at the focus node? */
);
/** deactivates constraint or marks constraint to be deactivated in next update */
SCIP_RETCODE SCIPconsDeactivate(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** enables constraint's separation, enforcing, and propagation capabilities or marks them to be enabled in next update */
SCIP_RETCODE SCIPconsEnable(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** disables constraint's separation, enforcing, and propagation capabilities or marks them to be disabled in next update */
SCIP_RETCODE SCIPconsDisable(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat /**< dynamic problem statistics */
);
/** enables constraint's separation capabilities or marks them to be enabled in next update */
SCIP_RETCODE SCIPconsEnableSeparation(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** disables constraint's separation capabilities or marks them to be disabled in next update */
SCIP_RETCODE SCIPconsDisableSeparation(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** enables constraint's propagation capabilities or marks them to be enabled in next update */
SCIP_RETCODE SCIPconsEnablePropagation(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** disables constraint's propagation capabilities or marks them to be disabled in next update */
SCIP_RETCODE SCIPconsDisablePropagation(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** marks the constraint to be a conflict */
void SCIPconsMarkConflict(
SCIP_CONS* cons /**< constraint */
);
/** marks the constraint to be propagated (update might be delayed) */
SCIP_EXPORT
SCIP_RETCODE SCIPconsMarkPropagate(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** unmarks the constraint to be propagated (update might be delayed) */
SCIP_RETCODE SCIPconsUnmarkPropagate(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** adds given value to age of constraint, but age can never become negative;
* should be called
* - in constraint separation, if no cut was found for this constraint,
* - in constraint enforcing, if constraint was feasible, and
* - in constraint propagation, if no domain reduction was deduced;
* if it's age exceeds the constraint age limit, makes constraint obsolete or marks constraint to be made obsolete
* in next update
*/
SCIP_RETCODE SCIPconsAddAge(
SCIP_CONS* cons, /**< constraint */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_PROB* prob, /**< problem data */
SCIP_Real deltaage, /**< value to add to the constraint's age */
SCIP_REOPT* reopt /**< reoptimization data */
);
/** increases age of constraint by 1.0;
* should be called
* - in constraint separation, if no cut was found for this constraint,
* - in constraint enforcing, if constraint was feasible, and
* - in constraint propagation, if no domain reduction was deduced;
* if it's age exceeds the constraint age limit, makes constraint obsolete or marks constraint to be made obsolete
* in next update
*/
SCIP_RETCODE SCIPconsIncAge(
SCIP_CONS* cons, /**< constraint */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_SET* set, /**< global SCIP settings */
SCIP_STAT* stat, /**< dynamic problem statistics */
SCIP_PROB* prob, /**< problem data */
SCIP_REOPT* reopt /**< reoptimization data */
);
/** resets age of constraint to zero;
* should be called
* - in constraint separation, if a cut was found for this constraint,
* - in constraint enforcing, if the constraint was violated, and
* - in constraint propagation, if a domain reduction was deduced;
* if it was obsolete, makes constraint useful again or marks constraint to be made useful again in next update
*/
SCIP_RETCODE SCIPconsResetAge(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set /**< global SCIP settings */
);
/** resolves the given conflicting bound, that was deduced by the given constraint, by putting all "reason" bounds
* leading to the deduction into the conflict queue with calls to SCIPaddConflictLb(), SCIPaddConflictUb(), SCIPaddConflictBd(),
* SCIPaddConflictRelaxedLb(), SCIPaddConflictRelaxedUb(), SCIPaddConflictRelaxedBd(), or SCIPaddConflictBinvar();
*
* @note it is sufficient to explain the relaxed bound change
*/
SCIP_RETCODE SCIPconsResolvePropagation(
SCIP_CONS* cons, /**< constraint that deduced the assignment */
SCIP_SET* set, /**< global SCIP settings */
SCIP_VAR* infervar, /**< variable whose bound was deduced by the constraint */
int inferinfo, /**< user inference information attached to the bound change */
SCIP_BOUNDTYPE inferboundtype, /**< bound that was deduced (lower or upper bound) */
SCIP_BDCHGIDX* bdchgidx, /**< bound change index, representing the point of time where change took place */
SCIP_Real relaxedbd, /**< the relaxed bound */
SCIP_RESULT* result /**< pointer to store the result of the callback method */
);
/** adds given values to lock status of the constraint and updates the locks of the given locktype of the involved variables */
SCIP_RETCODE SCIPconsAddLocks(
SCIP_CONS* cons, /**< constraint */
SCIP_SET* set, /**< global SCIP settings */
SCIP_LOCKTYPE locktype, /**< type of variable locks */
int nlockspos, /**< increase in number of rounding locks for constraint */
int nlocksneg /**< increase in number of rounding locks for constraint's negation */
);
/*
* Hash functions
*/
/** gets the key (i.e. the name) of the given constraint */
SCIP_DECL_HASHGETKEY(SCIPhashGetKeyCons);
/*
* method for arrays of contraint handlers
*/
/** stores all constraints marked for propagation away when probing is started */
SCIP_RETCODE SCIPconshdlrsStorePropagationStatus(
SCIP_SET* set, /**< global SCIP settings */
SCIP_CONSHDLR** conshdlrs, /**< all constraint handlers */
int nconshdlrs /**< number of contraint handlers */
);
/** reset all constraints marked for propagation when probing was finished */
SCIP_RETCODE SCIPconshdlrsResetPropagationStatus(
SCIP_SET* set, /**< global SCIP settings */
BMS_BLKMEM* blkmem, /**< block memory */
SCIP_CONSHDLR** conshdlrs, /**< all constraint handlers */
int nconshdlrs /**< number of contraint handlers */
);
#ifdef __cplusplus
}
#endif
#endif