source: stable/2.7/Cbc/src/CbcCutGenerator.hpp @ 1577

Last change on this file since 1577 was 1573, checked in by lou, 8 years ago

Change to EPL license notice.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.0 KB
Line 
1/* $Id: CbcCutGenerator.hpp 1573 2011-01-05 01:12:36Z lou $ */
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
169    /// Get whether the cut generator should be called in the normal place
170    inline bool normal() const {
171        return (switches_&1) != 0;
172    }
173    /// Set whether the cut generator should be called in the normal place
174    inline void setNormal(bool value) {
175        switches_ &= ~1;
176        switches_ |= value ? 1 : 0;
177    }
178    /// Get whether the cut generator should be called when a solution is found
179    inline bool atSolution() const {
180        return (switches_&2) != 0;
181    }
182    /// Set whether the cut generator should be called when a solution is found
183    inline void setAtSolution(bool value) {
184        switches_ &= ~2;
185        switches_ |= value ? 2 : 0;
186    }
187    /** Get whether the cut generator should be called when the subproblem is
188        found to be infeasible.
189    */
190    inline bool whenInfeasible() const {
191        return (switches_&4) != 0;
192    }
193    /** Set whether the cut generator should be called when the subproblem is
194        found to be infeasible.
195    */
196    inline void setWhenInfeasible(bool value) {
197        switches_ &= ~4;
198        switches_ |= value ? 4 : 0;
199    }
200    /// Get whether the cut generator is being timed
201    inline bool timing() const {
202        return (switches_&64) != 0;
203    }
204    /// Set whether the cut generator is being timed
205    inline void setTiming(bool value) {
206        switches_ &= ~64;
207        switches_ |= value ? 64 : 0;
208        timeInCutGenerator_ = 0.0;
209    }
210    /// Return time taken in cut generator
211    inline double timeInCutGenerator() const {
212        return timeInCutGenerator_;
213    }
214    inline void incrementTimeInCutGenerator(double value) {
215        timeInCutGenerator_ += value;
216    }
217    /// Get the \c CglCutGenerator corresponding to this \c CbcCutGenerator.
218    inline CglCutGenerator * generator() const {
219        return generator_;
220    }
221    /// Number times cut generator entered
222    inline int numberTimesEntered() const {
223        return numberTimes_;
224    }
225    inline void setNumberTimesEntered(int value) {
226        numberTimes_ = value;
227    }
228    inline void incrementNumberTimesEntered(int value = 1) {
229        numberTimes_ += value;
230    }
231    /// Total number of cuts added
232    inline int numberCutsInTotal() const {
233        return numberCuts_;
234    }
235    inline void setNumberCutsInTotal(int value) {
236        numberCuts_ = value;
237    }
238    inline void incrementNumberCutsInTotal(int value = 1) {
239        numberCuts_ += value;
240    }
241    /// Total number of elements added
242    inline int numberElementsInTotal() const {
243        return numberElements_;
244    }
245    inline void setNumberElementsInTotal(int value) {
246        numberElements_ = value;
247    }
248    inline void incrementNumberElementsInTotal(int value = 1) {
249        numberElements_ += value;
250    }
251    /// Total number of column cuts
252    inline int numberColumnCuts() const {
253        return numberColumnCuts_;
254    }
255    inline void setNumberColumnCuts(int value) {
256        numberColumnCuts_ = value;
257    }
258    inline void incrementNumberColumnCuts(int value = 1) {
259        numberColumnCuts_ += value;
260    }
261    /// Total number of cuts active after (at end of n cut passes at each node)
262    inline int numberCutsActive() const {
263        return numberCutsActive_;
264    }
265    inline void setNumberCutsActive(int value) {
266        numberCutsActive_ = value;
267    }
268    inline void incrementNumberCutsActive(int value = 1) {
269        numberCutsActive_ += value;
270    }
271    inline void setSwitchOffIfLessThan(int value) {
272        switchOffIfLessThan_ = value;
273    }
274    inline int switchOffIfLessThan() const {
275        return switchOffIfLessThan_;
276    }
277    /// Say if optimal basis needed
278    inline bool needsOptimalBasis() const {
279        return (switches_&128) != 0;
280    }
281    /// Set if optimal basis needed
282    inline void setNeedsOptimalBasis(bool yesNo) {
283        switches_ &= ~128;
284        switches_ |= yesNo ? 128 : 0;
285    }
286    /// Whether generator MUST be called again if any cuts (i.e. ignore break from loop)
287    inline bool mustCallAgain() const {
288        return (switches_&8) != 0;
289    }
290    /// Set whether generator MUST be called again if any cuts (i.e. ignore break from loop)
291    inline void setMustCallAgain(bool yesNo) {
292        switches_ &= ~8;
293        switches_ |= yesNo ? 8 : 0;
294    }
295    /// Whether generator switched off for moment
296    inline bool switchedOff() const {
297        return (switches_&16) != 0;
298    }
299    /// Set whether generator switched off for moment
300    inline void setSwitchedOff(bool yesNo) {
301        switches_ &= ~16;
302        switches_ |= yesNo ? 16 : 0;
303    }
304    /// Whether last round of cuts did little
305    inline bool ineffectualCuts() const {
306        return (switches_&512) != 0;
307    }
308    /// Set whether last round of cuts did little
309    inline void setIneffectualCuts(bool yesNo) {
310        switches_ &= ~512;
311        switches_ |= yesNo ? 512 : 0;
312    }
313    /// Whether to use if any cuts generated
314    inline bool whetherToUse() const {
315        return (switches_&1024) != 0;
316    }
317    /// Set whether to use if any cuts generated
318    inline void setWhetherToUse(bool yesNo) {
319        switches_ &= ~1024;
320        switches_ |= yesNo ? 1024 : 0;
321    }
322    /// Number of cuts generated at root
323    inline int numberCutsAtRoot() const {
324        return numberCutsAtRoot_;
325    }
326    inline void setNumberCutsAtRoot(int value) {
327        numberCutsAtRoot_ = value;
328    }
329    /// Number of cuts active at root
330    inline int numberActiveCutsAtRoot() const {
331        return numberActiveCutsAtRoot_;
332    }
333    inline void setNumberActiveCutsAtRoot(int value) {
334        numberActiveCutsAtRoot_ = value;
335    }
336    /// Number of short cuts at root
337    inline int numberShortCutsAtRoot() const {
338        return numberShortCutsAtRoot_;
339    }
340    /// Set model
341    inline void setModel(CbcModel * model) {
342        model_ = model;
343    }
344    /// Whether global cuts at root
345    inline bool globalCutsAtRoot() const {
346        return (switches_&32) != 0;
347    }
348    /// Set whether global cuts at root
349    inline void setGlobalCutsAtRoot(bool yesNo) {
350        switches_ &= ~32;
351        switches_ |= yesNo ? 32 : 0;
352    }
353    /// Whether global cuts
354    inline bool globalCuts() const {
355        return (switches_&256) != 0;
356    }
357    /// Set whether global cuts
358    inline void setGlobalCuts(bool yesNo) {
359        switches_ &= ~256;
360        switches_ |= yesNo ? 256 : 0;
361    }
362    //@}
363
364private:
365    /**@name Private gets and sets */
366    //@{
367    //@}
368    /// Saved cuts
369    OsiCuts savedCuts_;
370    /// Time in cut generator
371    double timeInCutGenerator_;
372    /// The client model
373    CbcModel *model_;
374
375    // The CglCutGenerator object
376    CglCutGenerator * generator_;
377
378    /// Name of generator
379    char * generatorName_;
380
381    /** Number of nodes between calls to the CglCutGenerator::generateCuts
382       routine.
383    */
384    int whenCutGenerator_;
385    /** Number of nodes between calls to the CglCutGenerator::generateCuts
386       routine in sub tree.
387    */
388    int whenCutGeneratorInSub_;
389    /** If first pass at root produces fewer than this cuts then switch off
390     */
391    int switchOffIfLessThan_;
392
393    /** Depth at which to call the CglCutGenerator::generateCuts
394       routine (If >0 then overrides when and is called if depth%depthCutGenerator==0).
395    */
396    int depthCutGenerator_;
397
398    /** Depth at which to call the CglCutGenerator::generateCuts
399       routine (If >0 then overrides when and is called if depth%depthCutGenerator==0).
400       In sub tree.
401    */
402    int depthCutGeneratorInSub_;
403
404    /// Level of cut inaccuracy (0 means exact e.g. cliques)
405    int inaccuracy_;
406    /// Number times cut generator entered
407    int numberTimes_;
408    /// Total number of cuts added
409    int numberCuts_;
410    /// Total number of elements added
411    int numberElements_;
412    /// Total number of column cuts added
413    int numberColumnCuts_;
414    /// Total number of cuts active after (at end of n cut passes at each node)
415    int numberCutsActive_;
416    /// Number of cuts generated at root
417    int numberCutsAtRoot_;
418    /// Number of cuts active at root
419    int numberActiveCutsAtRoot_;
420    /// Number of short cuts at root
421    int numberShortCutsAtRoot_;
422    /// Switches - see gets and sets
423    int switches_;
424};
425
426// How often to do if mostly switched off (A)
427# define SCANCUTS 1000
428// How often to do if mostly switched off (probing B)
429# define SCANCUTS_PROBING 1000
430
431#endif
432
Note: See TracBrowser for help on using the repository browser.