-
Notifications
You must be signed in to change notification settings - Fork 111
/
CbcParameters.hpp
2508 lines (1908 loc) · 75.3 KB
/
CbcParameters.hpp
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
/*
Copyright (C) 2007, Lou Hafer, International Business Machines Corporation
and others. All Rights Reserved.
This code is licensed under the terms of the Eclipse Public License (EPL).
*/
#ifndef CbcParameters_H
#define CbcParameters_H
/* \file CbcParameters.hpp
\brief Declarations for parameters of Cbc.
*/
#include "CbcConfig.h"
#include "CoinMessageHandler.hpp"
#include "CoinParam.hpp"
#include "ClpParam.hpp"
#include "ClpParameters.hpp"
#include "CglClique.hpp"
#include "CglCutGenerator.hpp"
#include "CglFlowCover.hpp"
#include "CglGMI.hpp"
#include "CglGomory.hpp"
#include "CglKnapsackCover.hpp"
#include "CglLandP.hpp"
#include "CglMixedIntegerRounding2.hpp"
#include "CglOddWheel.hpp"
#include "CglProbing.hpp"
#include "CglRedSplit.hpp"
#include "CglRedSplit2.hpp"
#include "CglResidualCapacity.hpp"
#include "CglTwomir.hpp"
#include "CglZeroHalf.hpp"
#include "CbcModel.hpp"
#include "CbcHeuristic.hpp"
#include "CbcHeuristicDINS.hpp"
#include "CbcHeuristicDW.hpp"
#include "CbcHeuristicDive.hpp"
#include "CbcHeuristicDiveCoefficient.hpp"
#include "CbcHeuristicDiveFractional.hpp"
#include "CbcHeuristicDiveGuided.hpp"
#include "CbcHeuristicDiveLineSearch.hpp"
#include "CbcHeuristicDivePseudoCost.hpp"
#include "CbcHeuristicDiveVectorLength.hpp"
#include "CbcHeuristicFPump.hpp"
#include "CbcHeuristicGreedy.hpp"
#include "CbcHeuristicLocal.hpp"
#include "CbcHeuristicPivotAndFix.hpp"
#include "CbcHeuristicRENS.hpp"
#include "CbcHeuristicRINS.hpp"
#include "CbcHeuristicRandRound.hpp"
#include "CbcHeuristicVND.hpp"
#include "CbcParam.hpp"
#include "CbcTreeLocal.hpp"
#include "CbcGenMessages.hpp"
// For now, we need this by default. It will be removed later.
#define CBC_CLUMSY_CODING
/*
It turns out that doxygen is not good with anonymous structures. Hence the
`struct name_struct' style used for structured fields in CbcParameters.
*/
/*
*/
/* \brief Cbc algorithm parameters class
This class defines and stores the parameters used to control the operation
of Cbc.
*/
class CBCLIB_EXPORT CbcParameters {
public:
/*! \name Constructors and destructors */
//@{
/*! \brief Constructors */
CbcParameters();
CbcParameters(int strategy);
void init(int strategy);
/*! \brief Destructor */
~CbcParameters();
//@}
/*! \name Enumeration types used for Cbc keyword parameters */
//@{
/*! \brief Codes to specify overall strategies */
enum CbcStrategy { DefaultStrategy = 0 };
/*! \brief Codes to control integer preprocessing
- IPPOff: Integer preprocessing is off.
- IPPOn: Integer preprocessing is on.
- IPPSave: IPPOn, plus preprocessed system will be saved to presolved.mps.
- IPPEqual: IPPOn, plus `<=' cliques are converted to `=' cliques.
- IPPSOS: IPPOn, plus will create SOS sets (see below).
- IPPTrySOS: IPPOn, plus will create SOS sets (see below).
- IPPEqualAll: IPPOn, plus turns all valid inequalities into equalities
with integer slacks.
- IPPStrategy: look to CbcStrategy object for instructions.
- IPPAggregate: ?.
- IPPForceSOS try even harder/
- IPPStopAfterSaving :.
- IPPEqualAllStop:.
IPPSOS will create SOS sets if all binary variables (except perhaps one)
can be covered by SOS sets with no overlap between sets. IPPTrySOS will
allow any number of binary variables to be uncovered.
*/
enum IPPMode {
IPPOff = 0,
IPPOn,
IPPSave,
IPPEqual,
IPPSOS,
IPPTrySOS,
IPPEqualAll,
IPPStrategy,
IPPAggregate,
IPPForceSOS,
IPPStopAfterSaving,
IPPEqualAllStop,
IPPEndMarker
};
/*! \brief What parameters to print
- displayAll:
- displayLowHigh:
- displayHigh:
- displayEndMarker
*/
enum CommandDisplayMode {
displayAll = 0,
displayLowHigh,
displayHigh,
displayEndMarker };
/*! \brief When to do clique strengthening
- ClqOff:
- ClqAfter:
- ClqBefore:
- ClqEndMarker:
*/
enum ClqStrMode { ClqStrOff = 0, ClqStrBefore, ClqStrAfter, ClqStrEndMarker };
/*! \brief What node strategy to use
- NSHybrid:
- NSFewest:
- NSDepth:
- NSUpFewest:
- NSUpDepth:
- NSDownDepth
*/
enum NodeStrategy {
NSHybrid = 0,
NSFewest,
NSDepth,
NSUpFewest,
NSDownFewest,
NSUpDepth,
NSDownDepth
};
/*! \brief What orbital branching strategy to use
- OBOff:
- OBSlowish:
- OBStrong:
- OBForce:
- OBSimple:
- OBOn:
- OBLightweight:
- OBMorePrinting:
- OBEndMarker
*/
enum OrbitalStrategy {
OBOff = 0,
OBSlowish,
OBStrong,
OBForce,
OBSimple,
OBOn,
OBLightweight,
OBMorePrinting,
OBEndMarker
};
/*! \brief What SOS prioritization strategy to use
- SOSOff:
- SOSHigh:
- SOSLow:
- SOSOrderHigh:
- SOSOrderLow:
- SOSEndMarker
*/
enum SOSStrategy {
SOSOff = 0,
SOSHigh,
SOSLow,
SOSOrderHigh,
SOSOrderLow,
SOSEndMarker
};
/*! \brief What overall strategy to use
- StrategyDefaulty = 0,
- StrategyEasy,
- StrategyAggressive,
- StrategyEndMarker
*/
enum StrategyMode {
StrategyEasy = 0,
StrategyDefault,
StrategyAggressive,
StrategyEndMarker
};
/*! \brief What clock type to use
- Clock Cpu: Use CPU time
- ClockElapsed: Use elapsed time
*/
enum ClockType { ClockCpu = 0, ClockElapsed, ClockEndMarker };
/*! \brief What clock type to use
- CGraphOff:
- CGraphOn:
- CGraphClique:
- CGraphEndMarker
*/
enum CGraphMode { CGraphOff = 0, CGraphOn, CGraphClique, CGraphEndMarker };
/*
In order for initialisation to work properly, the order of declaration of
the enum constants here must match the order of keyword declaration for
the various cut and heuristic control parameters in
CbcGenParamUtils::addCbcGenParams
*/
/*! \brief Codes to control the use of cut generators and heuristics
- CGOff: the cut generator will not be installed
- CGOn: the cut generator will be installed; exactly how often it's
activated depends on the settings at installation
- CGRoot: the cut generator will be installed with settings that restrict
it to activation at the root node only.
- CGIfMove: the cut generator will be installed with settings that allow
it to remain active only so long as it's generating cuts that
tighten the relaxation.
- CGForceOn: the cut generator will be installed with settings that force
it to be called at every node
- CGForceOnBut: the cut generator will be installed with settings that
force it to be called at every node, but more active at root (probing only)
- CGEndOnly:
- CGEndClean:
- CGEndBoth:
- CGLlong:
- CGLongRoot:
- CGLongIfMove:
- CGForceLongOn:
- CGLongEndOnly:
- CGOnlyAsWell:
- CGOnlyAsWellRoot:
- CGCleanAsWell:
- CGCleanAsWellRoot:
- CGBothAsWell:
- CGBothAsWellRoot:
- CGOnlyInstead:
- CGCleanInstead:
- CGBothInstead:
- CGOnGlobal:
- CGForceAndGlobal:
- CGShorter:
- CGEndMarker: a convenience to mark the end of the codes.
*/
enum CGMode {
CGOff = 0,
CGOn,
CGRoot,
CGIfMove,
CGForceOn,
CGForceOnBut,
CGForceOnButStrong,
CGEndOnly,
CGEndOnlyRoot,
CGEndClean,
CGEndCleanRoot,
CGEndBoth,
CGEndBothRoot,
CGLong,
CGLongOn,
CGLongRoot,
CGLongIfMove,
CGForceAndGlobal,
CGForceLongOn,
CGForceOnGlobal,
CGForceOnStrong,
CGLongEndOnly,
CGOnlyAsWell,
CGOnlyAsWellRoot,
CGCleanAsWell,
CGCleanAsWellRoot,
CGBothAsWell,
CGBothAsWellRoot,
CGCleanBothAsWellRoot,
CGOnlyInstead,
CGCleanInstead,
CGBothInstead,
CGOnGlobal,
CGLonger,
CGShorter,
CGStrongRoot,
CGIfLongOn,
CGEndMarker
};
/*! \brief Codes to specify whether to use a cutoff constraint
*/
enum CutoffMode {
COOff = 0,
COOn,
COVariable,
COForceVariable,
COConflict,
COEndMarker
};
/*! \brief Codes to specify the assignment of branching priorities
- HeurOff:
- HeurOn:
- HeurBoth,
- HeurBefore,
- HuerOften,
- HeurTen,
- HeurOneHundred,
- HeurTwoHundred,
- HeurThreeHundred,
- HeurOneThousand,
- HeurTenThousand,
- HeurDj,
- HeurDjBefore,
- HeurUseSolution,
- HeurInTree,
*/
enum HeurMode {
HeurOff = 0,
HeurOn,
HeurRoot,
HeurBoth,
HeurBefore,
HeurOften,
HeurOneQuick,
HeurBothQuick,
HeurBeforeQuick,
HeurTen,
HeurOneHundred,
HeurTwoHundred,
HeurThreeHundred,
HeurOneThousand,
HeurTenThousand,
HeurDj,
HeurDjBefore,
HeurUseSolution,
HeurInTree,
HeurEndMarker
};
/*! \brief Codes to specify one or off for boolean parameters
- ParamOff: Capability is switched off
- ParamOn: Capability is switched on
*/
enum OnOffMode { ParamOff = 0, ParamOn, ParamEndMarker };
/*! \brief Codes to specify the assignment of branching priorities
- BPOff: no priorities are passed to cbc
- BPCost: a priority vector is constructed based on objective coefficients
- BPOrder: a priority vector is constructed based on column order
- BPExt: the user has provided a priority vector
*/
enum BPMode {
BPOff = 0,
BPCost,
BPOrder,
BPBinaryFirst,
BPBinaryLast,
BPLength,
BPSingleton,
BPNonzero,
BPGeneral,
BPEndMarker };
/*! \brief Codes tos pecify mode for printing integers
- PMNormal = 0,
- PMInteger,
- PMSpecial,
- PMRows,
- PMAll,
- PMEndMarker
*/
enum IntPrintMode {
PMNormal = 0,
PMInteger,
PMSpecial,
PMRows,
PMAll,
PMCsv,
PMBoundRanging,
PMRhsRanging,
PMObjectiveRanging,
PMStats,
PMBoundsInt,
PMBoundsAll,
PMFixInt,
PMFixAll,
PMEndMarker
};
/*! \brief Major status codes for branch-and-cut
- BACInvalid: status not yet set
- BACNotRun: branch-and-cut has not yet run for the current problem
- BACFinish: branch-and-cut has finished normally
- BACStop: branch-and-cut has stopped on a limit
- BACAbandon: branch-and-cut abandoned the problem
- BACUser: branch-and-cut stopped on user signal
Consult minorStatus_ for details.
These codes are (mostly) set to match the codes used by CbcModel.
Additions to CbcModel codes should be reflected here and in translateMajor.
*/
enum BACMajorStatus {
BACInvalid = -1,
BACFinish = 0,
BACStop = 1,
BACAbandon = 2,
BACNotRun,
BACUser = 5,
BacEndMarker
};
/*! \brief Minor status codes
- BACmInvalid status not yet set
- BACmFinish search exhausted the tree; optimal solution
found
- BACmInfeas problem is infeasible
- BACmUbnd problem is unbounded
- BACmGap stopped on integrality gap
- BACmNodeLimit stopped on node limit
- BACmTimeLimit stopped on time limit
- BACmSolnLimit stopped on number of solutions limit
- BACmUser stopped due to user event
- BACmOther nothing else is appropriate
It's not possible to make these codes agree with CbcModel. The meaning
varies according to context: if the BACWhere code specifies a relaxation,
then the minor status reflects the underlying OSI solver. Otherwise, it
reflects the integer problem.
*/
enum BACMinorStatus {
BACmInvalid = -1,
BACmFinish = 0,
BACmInfeas,
BACmUbnd,
BACmGap,
BACmNodeLimit,
BACmTimeLimit,
BACmSolnLimit,
BACmUser,
BACmOther,
BACmEndMarker
};
/*! \brief Codes to specify where branch-and-cut stopped
- BACwNotStarted stopped before we ever got going
- BACwBareRoot stopped after initial solve of root relaxation
- BACwIPP stopped after integer preprocessing
- BACwIPPRelax stopped after initial solve of preprocessed problem
- BACwBAC stopped at some point in branch-and-cut
*/
enum BACWhere {
BACwInvalid = -1,
BACwNotStarted = 0,
BACwBareRoot,
BACwIPP,
BACwIPPRelax,
BACwBAC,
BACwEndMarker
};
enum OptimizationDirection {
OptDirMaximize = 0,
OptDirMinimize,
OptDirZero,
OptDireEndMarker
};
//@}
/*! \name Operators
\brief Functions that define operators to allow access by [].
*/
//@{
CbcParam *operator[](std::size_t idx){
return getParam(idx);
}
//@}
/*! \name Functions for Setting Up Parameters
\brief Functions that populate the parameters objects.
*/
//@{
/*! set up the solver parameter vector */
void addCbcParams();
void addCbcSolverStrParams();
void addCbcSolverDirParams();
void addCbcSolverFileParams();
void addCbcSolverHelpParams();
void addCbcSolverActionParams();
void addCbcSolverKwdParams();
void addCbcSolverDblParams();
void addCbcSolverIntParams();
void addCbcSolverBoolParams();
void addCbcSolverCutParams();
void addCbcSolverHeurParams();
void addCbcModelParams();
/*! set up the default */
void setDefaults(int strategy);
//@}
/*! \name Access and Control Functions for Cut Generators
\brief Control functions, plus lazy creation functions for cut
generators
Cbc avoids creating objects for cut generators and heuristics
unless they're actually used. For cut generators, a prototype is created
and reused. For heuristics, the default is to create a new object with
each call, because the model may have changed. The object is returned
through the reference parameter. The return value of the function is the
current mode.
Cut generator and heuristic objects created by these calls will be
deleted with the destruction of the CbcParameters object.
*/
//@{
/*! \brief Get cut depth setting
The name is a bit of a misnomer. Essentially, this overrides the
`every so many nodes' control with `execute when (depth in tree)
mod (cut depth) == 0'.
*/
inline int getCutDepth() { return cutDepth_; }
/*! \brief Get cut length setting */
inline int getCutLength() { return cutLength_; }
/*! \brief Get cut length setting */
inline int getCutPassInTree() { return cutPassInTree_; }
/*! \brief Set cut depth setting.
See comments for getCutDepth().
*/
inline void setCutDepth(int cutDepth) { cutDepth_ = cutDepth; }
/*! \brief Set cut length setting. */
inline void setCutLength(int cutLength) { cutLength_ = cutLength; }
/*! \brief Set cut pass in tree setting. */
inline void setCutPassInTree(int cutPassInTree) {
cutPassInTree_ = cutPassInTree;
}
/*! \brief Obtain a prototype for a clique cut generator. */
CbcParameters::CGMode getClique(CglCutGenerator *&gen);
/*! \brief Set mode for use of clique cut generator. */
inline void setCliqueMode(CbcParameters::CGMode mode) {
clique_.mode_ = mode;
}
/*! \brief Get mode for use of clique cut generator. */
inline CbcParameters::CGMode getCliqueMode() { return (clique_.mode_); }
/*! \brief Obtain a prototype for a flow cover cut generator. */
CbcParameters::CGMode getFlow(CglCutGenerator *&gen);
/*! \brief Set mode for use of flow cover cut generator. */
inline void setFlowMode(CbcParameters::CGMode mode) { flow_.mode_ = mode; }
/*! \brief Get mode for use of flow cover cut generator. */
inline CbcParameters::CGMode getFlowMode() { return (flow_.mode_); }
/*! \brief Obtain a prototype for a GMI cut generator. */
CbcParameters::CGMode getGMI(CglCutGenerator *&gen);
/*! \brief Set mode for use of GMI cut generator. */
inline void setGMIMode(CbcParameters::CGMode mode) { gmi_.mode_ = mode; }
/*! \brief Get mode for use of GMI cut generator. */
inline CbcParameters::CGMode getGMIMode() { return (gmi_.mode_); }
/*! \brief Obtain a prototype for a Gomory cut generator. */
CbcParameters::CGMode getGomory(CglCutGenerator *&gen);
/*! \brief Set mode for use of Gomory cut generator. */
inline void setGomoryMode(CbcParameters::CGMode mode) {
gomory_.mode_ = mode;
}
/*! \brief Get mode for use of Gomory cut generator. */
inline CbcParameters::CGMode getGomoryMode() { return (gomory_.mode_); }
/*! \brief Obtain a prototype for a knapsack cover cut generator. */
CbcParameters::CGMode getKnapsack(CglCutGenerator *&gen);
/*! \brief Set mode for use of knapsack cut generator. */
inline void setKnapsackMode(CbcParameters::CGMode mode) {
knapsack_.mode_ = mode;
}
/*! \brief Get mode for use of knapsack cut generator. */
inline CbcParameters::CGMode getKnapsackMode() { return (knapsack_.mode_); }
/*! \brief Obtain a prototype for a LaGomory cut generator. */
CbcParameters::CGMode getLaGomory(CglCutGenerator *&gen);
/*! \brief Set mode for use of LaGomory cut generator. */
inline void setLaGomoryMode(CbcParameters::CGMode mode) {
laGomory_.mode_ = mode;
}
/*! \brief Get mode for use of LaGomory cut generator. */
inline CbcParameters::CGMode getLaGomoryMode() { return (laGomory_.mode_); }
/* \brief Obtain a prototype for a lift-and-project cut generator. */
CbcParameters::CGMode getLandP(CglCutGenerator *&gen);
/* \brief Set mode for use of lift-and-project cut generator. */
inline void setLandPMode(CbcParameters::CGMode mode) { landP_.mode_ = mode; }
/*! \brief Get mode for use of lift-and-project cut generator. */
inline CbcParameters::CGMode getLandPMode() { return (landP_.mode_); }
/*! \brief Obtain a prototype for a LaTwomir cut generator. */
CbcParameters::CGMode getLaTwomir(CglCutGenerator *&gen);
/*! \brief Set mode for use of LaTwomir cut generator. */
inline void setLaTwomirMode(CbcParameters::CGMode mode) {
laTwomir_.mode_ = mode;
}
/*! \brief Get mode for use of LaTwomir cut generator. */
inline CbcParameters::CGMode getLaTwomirMode() { return (laTwomir_.mode_); }
/*! \brief Obtain a prototype for a mixed integer rounding (MIR)
cut generator.
*/
CbcParameters::CGMode getMir(CglCutGenerator *&gen);
/*! \brief Set mode for use of MIR cut generator. */
inline void setMirMode(CbcParameters::CGMode mode) { mir_.mode_ = mode; }
/*! \brief Get mode for use of MIR cut generator. */
inline CbcParameters::CGMode getMirMode() { return (mir_.mode_); }
/*! \brief Obtain a prototype for an odd wheel cut generator. */
CbcParameters::CGMode getOddWheel(CglCutGenerator *&gen);
/*! \brief Set mode for use of odd wheel cut generator. */
inline void setOddWheelMode(CbcParameters::CGMode mode) {
oddWheel_.mode_ = mode;
}
/*! \brief Get mode for use of odd wheel cut generator. */
inline CbcParameters::CGMode getOddWheelMode() { return (oddWheel_.mode_); }
/*! \brief Obtain a prototype for a probing cut generator. */
CbcParameters::CGMode getProbing(CglCutGenerator *&gen);
/*! \brief Set mode for use of probing cut generator. */
inline void setProbingMode(CbcParameters::CGMode mode) {
probing_.mode_ = mode;
}
/*! \brief Get mode for use of probing cut generator. */
inline CbcParameters::CGMode getProbingMode() { return (probing_.mode_); }
/*! \brief Obtain a prototype for a reduce and split cut generator. */
CbcParameters::CGMode getRedSplit(CglCutGenerator *&gen);
/*! \brief Set mode for use of reduce and split cut generator. */
inline void setRedSplitMode(CbcParameters::CGMode mode) {
redSplit_.mode_ = mode;
}
/*! \brief Get mode for use of reduce and split cut generator. */
inline CbcParameters::CGMode getRedSplitMode() { return (redSplit_.mode_); }
/*! \brief Obtain a prototype for a reduce and split 2 cut generator. */
CbcParameters::CGMode getRedSplit2(CglCutGenerator *&gen);
/*! \brief Set mode for use of reduce and split 2 cut generator. */
inline void setRedSplit2Mode(CbcParameters::CGMode mode) {
redSplit2_.mode_ = mode;
}
/*! \brief Get mode for use of reduce and split 2 cut generator. */
inline CbcParameters::CGMode getRedSplit2Mode() {
return (redSplit2_.mode_);
}
/*! \brief Obtain a prototype for a residual capacity cut generator. */
CbcParameters::CGMode getResidCap(CglCutGenerator *&gen);
/*! \brief Set mode for use of residual capacity cut generator. */
inline void setResidCapMode(CbcParameters::CGMode mode) {
residCap_.mode_ = mode;
}
/*! \brief Get mode for use of residual capacity cut generator. */
inline CbcParameters::CGMode getResidCapMode() { return (residCap_.mode_); }
/*! \brief Obtain a prototype for a 2-MIR cut generator. */
CbcParameters::CGMode getTwomir(CglCutGenerator *&gen);
/*! \brief Set mode for use of 2-MIR cut generator. */
inline void setTwomirMode(CbcParameters::CGMode mode) {
twomir_.mode_ = mode;
}
/*! \brief Get mode for use of Twomir cut generator. */
inline CbcParameters::CGMode getTwomirMode() { return (twomir_.mode_); }
/*! \brief Obtain a prototype for a zero-half cut generator. */
CbcParameters::CGMode getZeroHalf(CglCutGenerator *&gen);
/*! \brief Set mode for use of zero-half cut generator. */
inline void setZeroHalfMode(CbcParameters::CGMode mode) {
zeroHalf_.mode_ = mode;
}
/*! \brief Get mode for use of reduce and split cut generator. */
inline CbcParameters::CGMode getZeroHalfMode() { return (zeroHalf_.mode_); }
//@}
/*! \name Access and Control Functions for Heuristics
\brief Control functions, plus lazy creation functions for cut
generators
CBC avoids creating objects for heuristics
unless they're actually used. For cut generators, a prototype is created
and reused. For heuristics, the default is to create a new object with
each call, because the model may have changed. The object is returned
through the reference parameter. The return value of the function is the
current mode.
Heuristic objects created by these calls will be deleted
with the destruction of the CbcParameters object.
*/
//@{
/*! \brief Set mode for overall control of heuristics. */
inline CbcParameters::OnOffMode getDoHeuristicMode() {
return (doHeuristicMode_);
}
/*! \brief Get mode for overall control of heuristics. */
inline void
setDoHeuristicMode(CbcParameters::OnOffMode mode) {
doHeuristicMode_ = mode;
}
/*! \brief Obtain a local search/combine heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getCombine(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of local search/combine heuristic. */
inline void setCombineMode(CbcParameters::HeurMode mode) {
combine_.mode_ = mode;
}
/*! \brief Get mode for use of local search/combine heuristic. */
CbcParameters::HeurMode getCombineMode() { return (combine_.mode_); }
/*! \brief Obtain a crossover heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getCrossover(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of crossover heuristic. */
inline void setCrossoverMode(CbcParameters::HeurMode mode) {
crossover_.mode_ = mode;
}
/*! \brief Get mode for use of crossover heuristic. */
CbcParameters::HeurMode getCrossoverMode() { return (crossover_.mode_); }
/*! \brief Obtain a DINS heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDins(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of DINS heuristic. */
inline void setDinsMode(CbcParameters::HeurMode mode) { dins_.mode_ = mode; }
/*! \brief Get mode for use of DINS heuristic. */
CbcParameters::HeurMode getDinsMode() { return (dins_.mode_); }
/*! \brief Obtain a Diving Coefficient heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDiveCofficient(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of Diving Coefficient heuristic. */
inline void setDiveCoefficientMode(CbcParameters::HeurMode mode) {
divingc_.mode_ = mode;
}
/*! \brief Get mode for use of Diving Coefficient heuristic. */
CbcParameters::HeurMode getDiveCoefficientMode() { return (divingc_.mode_); }
/*! \brief Obtain a Diving Fractional heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDiveFractional(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of Diving Coefficient heuristic. */
inline void setDiveFractionalMode(CbcParameters::HeurMode mode) {
divingf_.mode_ = mode;
}
/*! \brief Get mode for use of Diving Fractional heuristic. */
CbcParameters::HeurMode getDiveFractionalMode() { return (divingf_.mode_); }
/*! \brief Obtain a Diving Guided heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDiveGuided(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of Diving Guided heuristic. */
inline void setDiveGuidedMode(CbcParameters::HeurMode mode) {
divingg_.mode_ = mode;
}
/*! \brief Get mode for use of Diving Guided heuristic. */
CbcParameters::HeurMode getDiveGuidedMode() { return (divingg_.mode_); }
/*! \brief Obtain a Diving Line Search heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDiveLineSearch(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of Diving Line Search heuristic. */
inline void setDiveLineSearchMode(CbcParameters::HeurMode mode) {
divingl_.mode_ = mode;
}
/*! \brief Get mode for use of Diving LineSearch heuristic. */
CbcParameters::HeurMode getDiveLineSearchMode() { return (divingl_.mode_); }
/*! \brief Obtain a Diving Pseudocost heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDivePseudocost(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of Diving Pseudocost heuristic. */
inline void setDivePseudocostMode(CbcParameters::HeurMode mode) {
divingp_.mode_ = mode;
}
/*! \brief Get mode for use of Diving Pseudocost heuristic. */
CbcParameters::HeurMode getDivePseudocostMode() { return (divingp_.mode_); }
/*! \brief Set mode for use of rand. */
inline void setDiveRandomMode(CbcParameters::HeurMode mode) {
randomDivingMode_ = mode;
}
/*! \brief Get mode for use of Diving Pseudocost heuristic. */
CbcParameters::HeurMode getDiveRandomMode() { return (randomDivingMode_); }
/*! \brief Obtain a Diving Vector Length heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing
object if one exists.
*/
CbcParameters::HeurMode getDiveVectorLength(CbcHeuristic *&gen,
bool alwaysCreate = true);
/*! \brief Set mode for use of Diving Vector Length heuristic. */
inline void setDiveVectorLengthMode(CbcParameters::HeurMode mode) {
divingv_.mode_ = mode;
}
/*! \brief Get mode for use of Diving Vector Length heuristic. */
CbcParameters::HeurMode getDiveVectorLengthMode() {
return (divingv_.mode_);
}
/*! \brief Obtain a DW heuristic.
By default, any existing object is deleted and a new object is created and
loaded with \c model. Set alwaysCreate = false to return an existing