CouenneObject.hpp

Go to the documentation of this file.

/* $Id: CouenneObject.hpp 793 2012-01-26 03:07:16Z pbelotti $
 *
 * Name:    CouenneObject.hpp
 * Authors: Pierre Bonami, IBM Corp.
 *          Pietro Belotti, Carnegie Mellon University
 * Purpose: Object for auxiliary variables
 *
 * (C) Carnegie-Mellon University, 2006-11.
 * This file is licensed under the Eclipse Public License (EPL)
 */

#ifndef COUENNEOBJECT_HPP
#define COUENNEOBJECT_HPP

#include "BonBabSetupBase.hpp"

#include "CouenneExprVar.hpp"
#include "CouenneJournalist.hpp"
#include "OsiBranchingObject.hpp"

namespace Couenne {

const CouNumber default_alpha  = 0.25;
const CouNumber default_clamp  = 0.2;
const CouNumber max_pseudocost = 1000.;

const double large_bound = 1e9;

#define AGGR_MUL 2
#define THRES_ZERO_SYMM 0.8

const CouNumber closeToBounds = .05;


enum {TWO_LEFT,                 TWO_RIGHT,   TWO_RAND,
      THREE_LEFT, THREE_CENTER, THREE_RIGHT, THREE_RAND, BRANCH_NONE};

class funtriplet;
class CouenneProblem;
class CouenneCutGenerator;

CouNumber minMaxDelta (funtriplet *ft, CouNumber lb, CouNumber ub);
CouNumber maxHeight   (funtriplet *ft, CouNumber lb, CouNumber ub);



  class CouenneObject: public OsiObject {

public:

    enum pseudocostMult {INFEASIBILITY, 
                       INTERVAL_LP, INTERVAL_LP_REV,
                       INTERVAL_BR, INTERVAL_BR_REV,
                       PROJECTDIST};

  enum branch_obj {EXPR_OBJ, VAR_OBJ, VT_OBJ};

  enum brSelStrat {NO_STRATEGY, NO_BRANCH, MID_INTERVAL, MIN_AREA, BALANCED, LP_CENTRAL, LP_CLAMPED};

  CouenneObject ();

  CouenneObject (CouenneCutGenerator *cutgen,
                 CouenneProblem *p, 
                 exprVar *ref, Bonmin::BabSetupBase *base, JnlstPtr jnlst);

  CouenneObject (exprVar *ref, Bonmin::BabSetupBase *base, JnlstPtr jnlst);

  ~CouenneObject () {}

  CouenneObject (const CouenneObject &src);

  virtual CouenneObject * clone () const
  {return new CouenneObject (*this);}

  void setParameters (Bonmin::BabSetupBase *base);

  virtual double infeasibility (const OsiBranchingInformation *info, int &way) const;

  virtual double checkInfeasibility (const OsiBranchingInformation * info) const;

  virtual double feasibleRegion (OsiSolverInterface*, const OsiBranchingInformation*) const;

  virtual OsiBranchingObject *createBranch (OsiSolverInterface*, 
                                            const OsiBranchingInformation*, int) const;

  exprVar *Reference () const
  {return reference_;}

  enum brSelStrat Strategy ()  const
  {return strategy_;}

  CouNumber getBrPoint (funtriplet *ft, CouNumber x0, CouNumber l, CouNumber u, const OsiBranchingInformation *info = NULL) const;

  CouNumber midInterval (CouNumber x, CouNumber l, CouNumber u, const OsiBranchingInformation *info = NULL) const;

  virtual double downEstimate () const
  {//if (jnlst_ -> ProduceOutput (J_MATRIX, J_BRANCHING)) {
    //printf ("DOWN EST = %g for ", downEstimate_); 
    //reference_ -> print (); 
    //printf ("\n");
    //}
  return downEstimate_;}

  virtual double upEstimate () const
  {//if (jnlst_ -> ProduceOutput (J_MATRIX, J_BRANCHING)) {
    //printf ("UP EST = %g for ", upEstimate_); 
    //reference_ -> print (); 
    //printf ("\n");
    //}
  return upEstimate_;}

  void setEstimate (double est, int direction)
  {(direction ? upEstimate_ : downEstimate_) = est;}

  void setEstimates (const OsiBranchingInformation *info,
                     CouNumber *infeasibility,
                     CouNumber *brpt) const;

  virtual bool isCuttable () const {
    return (reference_ -> Image ()) ? 
      ((!(reference_ -> isInteger ())) &&
       reference_ -> Image () -> isCuttable (problem_, reference_ -> Index ())) :
      (!(reference_ -> isInteger ()));
  }

  virtual double intInfeasibility (double value, double lb, double ub) const;

  CouNumber lp_clamp () const
  {return lp_clamp_;}

  virtual int columnNumber () const
  {return (reference_ ? reference_ -> Index () : -1);}

protected:

  CouenneCutGenerator *cutGen_;

  CouenneProblem *problem_;

  exprVar *reference_;

  enum brSelStrat strategy_;

  JnlstPtr jnlst_;

  CouNumber alpha_;

  CouNumber lp_clamp_;

  CouNumber feas_tolerance_;

  bool doFBBT_;

  bool doConvCuts_;

  mutable double downEstimate_;

  mutable double upEstimate_;

  enum pseudocostMult pseudoMultType_;
};

}

#endif