AbcCutGenerator.h

Go to the documentation of this file.

/*===========================================================================*
 * This file is part of the Abstract Library for Parallel Search (ALPS).     *
 *                                                                           *
 * ALPS is distributed under the Eclipse Public License as part of the       *
 * COIN-OR repository (http://www.coin-or.org).                              *
 *                                                                           *
 * Authors:                                                                  *
 *                                                                           *
 *          Yan Xu, Lehigh University                                        *
 *          Ted Ralphs, Lehigh University                                    *
 *                                                                           *
 * Conceptual Design:                                                        *
 *                                                                           *
 *          Yan Xu, Lehigh University                                        *
 *          Ted Ralphs, Lehigh University                                    *
 *          Laszlo Ladanyi, IBM T.J. Watson Research Center                  *
 *          Matthew Saltzman, Clemson University                             *
 *                                                                           * 
 *                                                                           *
 * Copyright (C) 2001-2013, Lehigh University, Yan Xu, and Ted Ralphs.       *
 *===========================================================================*/

//#############################################################################
// This file is modified from SbbCutGenerator.hpp
//#############################################################################

#ifndef AbcCutGenerator_h_
#define AbcCutGenerator_h_

#include "OsiSolverInterface.hpp"
#include "OsiCuts.hpp"

class AbcModel;
class OsiRowCut;
class OsiRowCutDebugger;
class CglCutGenerator;

//#############################################################################

class AbcCutGenerator  {
    
 public:
    
    bool generateCuts( OsiCuts &cs, bool fullScan); 

    
    AbcCutGenerator (); 
    
    AbcCutGenerator(AbcModel * model,CglCutGenerator * generator,
                    int howOften=1, const char * name=NULL,
                    bool normal=true, bool atSolution=false, 
                    bool infeasible=false);
    
    AbcCutGenerator (const AbcCutGenerator &);
    
    AbcCutGenerator & operator=(const AbcCutGenerator& rhs);
    
    ~AbcCutGenerator ();

    void refreshModel(AbcModel * model);
    
    inline const char * cutGeneratorName() const
        { 
            return generatorName_; 
        }
    
    void setHowOften(int value) ;
    
    inline int howOften() const
        { return whenCutGenerator_; }
    
    inline bool normal() const
        { return normal_; }
    inline void setNormal(bool value) 
        { normal_=value; }
    inline bool atSolution() const
        { return atSolution_; }
    inline void setAtSolution(bool value) 
        { atSolution_=value; }
    inline bool whenInfeasible() const
        { return whenInfeasible_; }
    inline void setWhenInfeasible(bool value) 
        { whenInfeasible_=value; }
    inline CglCutGenerator * generator() const
        { return generator_; }
  
 private:
    AbcModel *model_;

    // The CglCutGenerator object
    CglCutGenerator * generator_;

    int whenCutGenerator_;
    
    char * generatorName_;
    
    bool normal_;

    bool atSolution_;

    bool whenInfeasible_;  
};

#endif