CglCutGenerator.hpp

Go to the documentation of this file.

// Copyright (C) 2000, International Business Machines
// Corporation and others.  All Rights Reserved.
// This code is licensed under the terms of the Eclipse Public License (EPL).

#ifndef CglCutGenerator_H
#define CglCutGenerator_H

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

//-------------------------------------------------------------------
//
// Abstract base class for generating cuts.
//
//-------------------------------------------------------------------

class CglCutGenerator {

public:
  virtual void generateCuts(const OsiSolverInterface &si, OsiCuts &cs,
    const CglTreeInfo info = CglTreeInfo())
    = 0;

  CglCutGenerator();

  CglCutGenerator(const CglCutGenerator &);

  virtual CglCutGenerator *clone() const = 0;

  CglCutGenerator &operator=(const CglCutGenerator &rhs);

  virtual ~CglCutGenerator();

  virtual std::string generateCpp(FILE *) { return ""; }

  virtual void refreshSolver(OsiSolverInterface *) {}

  inline int getAggressiveness() const
  {
    return aggressive_;
  }

  inline void setAggressiveness(int value)
  {
    aggressive_ = value;
  }
  inline void setGlobalCuts(bool trueOrFalse)
  {
    canDoGlobalCuts_ = trueOrFalse;
  }
  inline bool canDoGlobalCuts() const
  {
    return canDoGlobalCuts_;
  }
  virtual bool mayGenerateRowCutsInTree() const;
  virtual bool needsOptimalBasis() const;
  virtual int maximumLengthOfCutInTree() const
  {
    return COIN_INT_MAX;
  }

  // test this class
  //static void unitTest();

  // private:

  int aggressive_;
  bool canDoGlobalCuts_;
};

#endif

/* vi: softtabstop=2 shiftwidth=2 expandtab tabstop=2
*/