source: trunk/Cbc/src/CbcCutGenerator.hpp @ 2081

Last change on this file since 2081 was 2081, checked in by forrest, 4 years ago

zerohalf thread safety plus restart with deterministic parallel

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.6 KB
Line 
1/* $Id: CbcCutGenerator.hpp 2081 2014-09-25 11:31:17Z forrest $ */
2// Copyright (C) 2003, International Business Machines
3// Corporation and others.  All Rights Reserved.
4// This code is licensed under the terms of the Eclipse Public License (EPL).
5
6#ifndef CbcCutGenerator_H
7#define CbcCutGenerator_H
8
9#include "OsiSolverInterface.hpp"
10#include "OsiCuts.hpp"
11#include "CglCutGenerator.hpp"
12#include "CbcCutModifier.hpp"
13
14class CbcModel;
15class OsiRowCut;
16class OsiRowCutDebugger;
17
18//#############################################################################
19
20/** Interface between Cbc and Cut Generation Library.
21
22  \c CbcCutGenerator is intended to provide an intelligent interface between
23  Cbc and the cutting plane algorithms in the CGL. A \c CbcCutGenerator is
24  bound to a \c CglCutGenerator and to an \c CbcModel. It contains parameters
25  which control when and how the \c generateCuts method of the
26  \c CglCutGenerator will be called.
27
28  The builtin decision criteria available to use when deciding whether to
29  generate cuts are limited: every <i>X</i> nodes, when a solution is found,
30  and when a subproblem is found to be infeasible. The idea is that the class
31  will grow more intelligent with time.
32
33  \todo Add a pointer to function member which will allow a client to install
34        their own decision algorithm to decide whether or not to call the CGL
35        \p generateCuts method. Create a default decision method that looks
36        at the builtin criteria.
37
38  \todo It strikes me as not good that generateCuts contains code specific to
39        individual CGL algorithms. Another set of pointer to function members,
40        so that the client can specify the cut generation method as well as
41        pre- and post-generation methods? Taken a bit further, should this
42        class contain a bunch of pointer to function members, one for each
43        of the places where the cut generator might be referenced?
44        Initialization, root node, search tree node, discovery of solution,
45        and termination all come to mind. Initialization and termination would
46        also be useful for instrumenting cbc.
47*/
48
49class CbcCutGenerator  {
50
51public:
52
53    /** \name Generate Cuts */
54    //@{
55    /** Generate cuts for the client model.
56
57      Evaluate the state of the client model and decide whether to generate cuts.
58      The generated cuts are inserted into and returned in the collection of cuts
59      \p cs.
60
61      If \p fullScan is !=0, the generator is obliged to call the CGL
62      \c generateCuts routine.  Otherwise, it is free to make a local decision.
63      Negative fullScan says things like at integer solution
64      The current implementation uses \c whenCutGenerator_ to decide.
65
66      The routine returns true if reoptimisation is needed (because the state of
67      the solver interface has been modified).
68
69      If node then can find out depth
70    */
71    bool generateCuts( OsiCuts &cs, int fullScan, OsiSolverInterface * solver,
72                       CbcNode * node);
73    //@}
74
75
76    /**@name Constructors and destructors */
77    //@{
78    /// Default constructor
79    CbcCutGenerator ();
80
81    /// Normal constructor
82    CbcCutGenerator(CbcModel * model, CglCutGenerator * generator,
83                    int howOften = 1, const char * name = NULL,
84                    bool normal = true, bool atSolution = false,
85                    bool infeasible = false, int howOftenInsub = -100,
86                    int whatDepth = -1, int whatDepthInSub = -1, int switchOffIfLessThan = 0);
87
88    /// Copy constructor
89    CbcCutGenerator (const CbcCutGenerator &);
90
91    /// Assignment operator
92    CbcCutGenerator & operator=(const CbcCutGenerator& rhs);
93
94    /// Destructor
95    ~CbcCutGenerator ();
96    //@}
97
98    /**@name Gets and sets */
99    //@{
100    /** Set the client model.
101
102      In addition to setting the client model, refreshModel also calls
103      the \c refreshSolver method of the CglCutGenerator object.
104    */
105    void refreshModel(CbcModel * model);
106
107    /// return name of generator
108    inline const char * cutGeneratorName() const {
109        return generatorName_;
110    }
111
112    /// Create C++ lines to show how to tune
113    void generateTuning( FILE * fp);
114    /** Set the cut generation interval
115
116      Set the number of nodes evaluated between calls to the Cgl object's
117      \p generateCuts routine.
118
119      If \p value is positive, cuts will always be generated at the specified
120      interval.
121      If \p value is negative, cuts will initially be generated at the specified
122      interval, but Cbc may adjust the value depending on the success of cuts
123      produced by this generator.
124
125      A value of -100 disables the generator, while a value of -99 means
126      just at root.
127    */
128    void setHowOften(int value) ;
129
130    /// Get the cut generation interval.
131    inline int howOften() const {
132        return whenCutGenerator_;
133    }
134    /// Get the cut generation interval.in sub tree
135    inline int howOftenInSub() const {
136        return whenCutGeneratorInSub_;
137    }
138    /// Get level of cut inaccuracy (0 means exact e.g. cliques)
139    inline int inaccuracy() const {
140        return inaccuracy_;
141    }
142    /// Set level of cut inaccuracy (0 means exact e.g. cliques)
143    inline void setInaccuracy(int level) {
144        inaccuracy_ = level;
145    }
146
147    /** Set the cut generation depth
148
149      Set the depth criterion for calls to the Cgl object's
150      \p generateCuts routine.  Only active if > 0.
151
152      If whenCutGenerator is positive and this is positive then this overrides.
153      If whenCutGenerator is -1 then this is used as criterion if any cuts
154      were generated at root node.
155      If whenCutGenerator is anything else this is ignored.
156    */
157    void setWhatDepth(int value) ;
158    /// Set the cut generation depth in sub tree
159    void setWhatDepthInSub(int value) ;
160    /// Get the cut generation depth criterion.
161    inline int whatDepth() const {
162        return depthCutGenerator_;
163    }
164    /// Get the cut generation depth criterion.in sub tree
165    inline int whatDepthInSub() const {
166        return depthCutGeneratorInSub_;
167    }
168    /// Set maximum number of times to enter
169    inline void setMaximumTries(int value)
170    { maximumTries_ = value;}
171    /// Get maximum number of times to enter
172    inline int maximumTries() const
173    { return maximumTries_;}
174
175    /// Get switches
176    inline int switches() const {
177        return switches_;
178    }
179    /// Set switches (for copying from virgin state)
180    inline void setSwitches(int value) {
181        switches_ = value;
182    }
183    /// Get whether the cut generator should be called in the normal place
184    inline bool normal() const {
185        return (switches_&1) != 0;
186    }
187    /// Set whether the cut generator should be called in the normal place
188    inline void setNormal(bool value) {
189        switches_ &= ~1;
190        switches_ |= value ? 1 : 0;
191    }
192    /// Get whether the cut generator should be called when a solution is found
193    inline bool atSolution() const {
194        return (switches_&2) != 0;
195    }
196    /// Set whether the cut generator should be called when a solution is found
197    inline void setAtSolution(bool value) {
198        switches_ &= ~2;
199        switches_ |= value ? 2 : 0;
200    }
201    /** Get whether the cut generator should be called when the subproblem is
202        found to be infeasible.
203    */
204    inline bool whenInfeasible() const {
205        return (switches_&4) != 0;
206    }
207    /** Set whether the cut generator should be called when the subproblem is
208        found to be infeasible.
209    */
210    inline void setWhenInfeasible(bool value) {
211        switches_ &= ~4;
212        switches_ |= value ? 4 : 0;
213    }
214    /// Get whether the cut generator is being timed
215    inline bool timing() const {
216        return (switches_&64) != 0;
217    }
218    /// Set whether the cut generator is being timed
219    inline void setTiming(bool value) {
220        switches_ &= ~64;
221        switches_ |= value ? 64 : 0;
222        timeInCutGenerator_ = 0.0;
223    }
224    /// Return time taken in cut generator
225    inline double timeInCutGenerator() const {
226        return timeInCutGenerator_;
227    }
228    inline void incrementTimeInCutGenerator(double value) {
229        timeInCutGenerator_ += value;
230    }
231    /// Get the \c CglCutGenerator corresponding to this \c CbcCutGenerator.
232    inline CglCutGenerator * generator() const {
233        return generator_;
234    }
235    /// Number times cut generator entered
236    inline int numberTimesEntered() const {
237        return numberTimes_;
238    }
239    inline void setNumberTimesEntered(int value) {
240        numberTimes_ = value;
241    }
242    inline void incrementNumberTimesEntered(int value = 1) {
243        numberTimes_ += value;
244    }
245    /// Total number of cuts added
246    inline int numberCutsInTotal() const {
247        return numberCuts_;
248    }
249    inline void setNumberCutsInTotal(int value) {
250        numberCuts_ = value;
251    }
252    inline void incrementNumberCutsInTotal(int value = 1) {
253        numberCuts_ += value;
254    }
255    /// Total number of elements added
256    inline int numberElementsInTotal() const {
257        return numberElements_;
258    }
259    inline void setNumberElementsInTotal(int value) {
260        numberElements_ = value;
261    }
262    inline void incrementNumberElementsInTotal(int value = 1) {
263        numberElements_ += value;
264    }
265    /// Total number of column cuts
266    inline int numberColumnCuts() const {
267        return numberColumnCuts_;
268    }
269    inline void setNumberColumnCuts(int value) {
270        numberColumnCuts_ = value;
271    }
272    inline void incrementNumberColumnCuts(int value = 1) {
273        numberColumnCuts_ += value;
274    }
275    /// Total number of cuts active after (at end of n cut passes at each node)
276    inline int numberCutsActive() const {
277        return numberCutsActive_;
278    }
279    inline void setNumberCutsActive(int value) {
280        numberCutsActive_ = value;
281    }
282    inline void incrementNumberCutsActive(int value = 1) {
283        numberCutsActive_ += value;
284    }
285    inline void setSwitchOffIfLessThan(int value) {
286        switchOffIfLessThan_ = value;
287    }
288    inline int switchOffIfLessThan() const {
289        return switchOffIfLessThan_;
290    }
291    /// Say if optimal basis needed
292    inline bool needsOptimalBasis() const {
293        return (switches_&128) != 0;
294    }
295    /// Set if optimal basis needed
296    inline void setNeedsOptimalBasis(bool yesNo) {
297        switches_ &= ~128;
298        switches_ |= yesNo ? 128 : 0;
299    }
300    /// Whether generator MUST be called again if any cuts (i.e. ignore break from loop)
301    inline bool mustCallAgain() const {
302        return (switches_&8) != 0;
303    }
304    /// Set whether generator MUST be called again if any cuts (i.e. ignore break from loop)
305    inline void setMustCallAgain(bool yesNo) {
306        switches_ &= ~8;
307        switches_ |= yesNo ? 8 : 0;
308    }
309    /// Whether generator switched off for moment
310    inline bool switchedOff() const {
311        return (switches_&16) != 0;
312    }
313    /// Set whether generator switched off for moment
314    inline void setSwitchedOff(bool yesNo) {
315        switches_ &= ~16;
316        switches_ |= yesNo ? 16 : 0;
317    }
318    /// Whether last round of cuts did little
319    inline bool ineffectualCuts() const {
320        return (switches_&512) != 0;
321    }
322    /// Set whether last round of cuts did little
323    inline void setIneffectualCuts(bool yesNo) {
324        switches_ &= ~512;
325        switches_ |= yesNo ? 512 : 0;
326    }
327    /// Whether to use if any cuts generated
328    inline bool whetherToUse() const {
329        return (switches_&1024) != 0;
330    }
331    /// Set whether to use if any cuts generated
332    inline void setWhetherToUse(bool yesNo) {
333        switches_ &= ~1024;
334        switches_ |= yesNo ? 1024 : 0;
335    }
336    /// Whether in must call again mode (or after others)
337    inline bool whetherInMustCallAgainMode() const {
338        return (switches_&2048) != 0;
339    }
340    /// Set whether in must call again mode (or after others)
341    inline void setWhetherInMustCallAgainMode(bool yesNo) {
342        switches_ &= ~2048;
343        switches_ |= yesNo ? 2048 : 0;
344    }
345    /// Whether to call at end
346    inline bool whetherCallAtEnd() const {
347        return (switches_&4096) != 0;
348    }
349    /// Set whether to call at end
350    inline void setWhetherCallAtEnd(bool yesNo) {
351        switches_ &= ~4096;
352        switches_ |= yesNo ? 4096 : 0;
353    }
354    /// Whether needs refresh on copy
355    inline bool needsRefresh() const {
356        return (switches_&8192) != 0;
357    }
358    /// Set whether needs refresh on copy
359    inline void setNeedsRefresh(bool yesNo) {
360        switches_ &= ~8192;
361        switches_ |= yesNo ? 8192 : 0;
362    }
363    /// Number of cuts generated at root
364    inline int numberCutsAtRoot() const {
365        return numberCutsAtRoot_;
366    }
367    inline void setNumberCutsAtRoot(int value) {
368        numberCutsAtRoot_ = value;
369    }
370    /// Number of cuts active at root
371    inline int numberActiveCutsAtRoot() const {
372        return numberActiveCutsAtRoot_;
373    }
374    inline void setNumberActiveCutsAtRoot(int value) {
375        numberActiveCutsAtRoot_ = value;
376    }
377    /// Number of short cuts at root
378    inline int numberShortCutsAtRoot() const {
379        return numberShortCutsAtRoot_;
380    }
381    inline void setNumberShortCutsAtRoot(int value) {
382        numberShortCutsAtRoot_ = value;
383    }
384    /// Set model
385    inline void setModel(CbcModel * model) {
386        model_ = model;
387    }
388    /// Whether global cuts at root
389    inline bool globalCutsAtRoot() const {
390        return (switches_&32) != 0;
391    }
392    /// Set whether global cuts at root
393    inline void setGlobalCutsAtRoot(bool yesNo) {
394        switches_ &= ~32;
395        switches_ |= yesNo ? 32 : 0;
396    }
397    /// Whether global cuts
398    inline bool globalCuts() const {
399        return (switches_&256) != 0;
400    }
401    /// Set whether global cuts
402    inline void setGlobalCuts(bool yesNo) {
403        switches_ &= ~256;
404        switches_ |= yesNo ? 256 : 0;
405    }
406    /// Add in statistics from other
407    void addStatistics(const CbcCutGenerator * other);
408    /// Scale back statistics by factor
409    void scaleBackStatistics(int factor);
410    //@}
411
412private:
413    /**@name Private gets and sets */
414    //@{
415    //@}
416    /// Saved cuts
417    OsiCuts savedCuts_;
418    /// Time in cut generator
419    double timeInCutGenerator_;
420    /// The client model
421    CbcModel *model_;
422
423    // The CglCutGenerator object
424    CglCutGenerator * generator_;
425
426    /// Name of generator
427    char * generatorName_;
428
429    /** Number of nodes between calls to the CglCutGenerator::generateCuts
430       routine.
431    */
432    int whenCutGenerator_;
433    /** Number of nodes between calls to the CglCutGenerator::generateCuts
434       routine in sub tree.
435    */
436    int whenCutGeneratorInSub_;
437    /** If first pass at root produces fewer than this cuts then switch off
438     */
439    int switchOffIfLessThan_;
440
441    /** Depth at which to call the CglCutGenerator::generateCuts
442       routine (If >0 then overrides when and is called if depth%depthCutGenerator==0).
443    */
444    int depthCutGenerator_;
445
446    /** Depth at which to call the CglCutGenerator::generateCuts
447       routine (If >0 then overrides when and is called if depth%depthCutGenerator==0).
448       In sub tree.
449    */
450    int depthCutGeneratorInSub_;
451
452    /// Level of cut inaccuracy (0 means exact e.g. cliques)
453    int inaccuracy_;
454    /// Number times cut generator entered
455    int numberTimes_;
456    /// Total number of cuts added
457    int numberCuts_;
458    /// Total number of elements added
459    int numberElements_;
460    /// Total number of column cuts added
461    int numberColumnCuts_;
462    /// Total number of cuts active after (at end of n cut passes at each node)
463    int numberCutsActive_;
464    /// Number of cuts generated at root
465    int numberCutsAtRoot_;
466    /// Number of cuts active at root
467    int numberActiveCutsAtRoot_;
468    /// Number of short cuts at root
469    int numberShortCutsAtRoot_;
470    /// Switches - see gets and sets
471    int switches_;
472    /// Maximum number of times to enter
473    int maximumTries_;
474};
475
476// How often to do if mostly switched off (A)
477# define SCANCUTS 1000
478// How often to do if mostly switched off (probing B)
479# define SCANCUTS_PROBING 1000
480
481#endif
482
Note: See TracBrowser for help on using the repository browser.