CbcBranchDecision.hpp

Go to the documentation of this file.

// $Id: CbcBranchDecision.hpp 2465 2019-01-03 19:26:52Z unxusr $
// Copyright (C) 2002, International Business Machines
// Corporation and others.  All Rights Reserved.
// This code is licensed under the terms of the Eclipse Public License (EPL).

// Edwin 11/12/2009 carved from CbcBranchBase

#ifndef CbcBranchDecision_H
#define CbcBranchDecision_H

#include "CbcBranchBase.hpp"

class CbcModel;
class OsiChooseVariable;

class CbcBranchDecision {
public:
  CbcBranchDecision();

  // Copy constructor
  CbcBranchDecision(const CbcBranchDecision &);

  virtual ~CbcBranchDecision();

  virtual CbcBranchDecision *clone() const = 0;

  virtual void initialize(CbcModel *model) = 0;

  virtual int
  betterBranch(CbcBranchingObject *thisOne,
    CbcBranchingObject *bestSoFar,
    double changeUp, int numberInfeasibilitiesUp,
    double changeDown, int numberInfeasibilitiesDown)
    = 0;

  virtual int
  bestBranch(CbcBranchingObject **objects, int numberObjects, int numberUnsatisfied,
    double *changeUp, int *numberInfeasibilitiesUp,
    double *changeDown, int *numberInfeasibilitiesDown,
    double objectiveValue);

  virtual int whichMethod()
  {
    return 2;
  }

  virtual void saveBranchingObject(OsiBranchingObject *) {}
  virtual void updateInformation(OsiSolverInterface *,
    const CbcNode *) {}
  virtual void setBestCriterion(double) {}
  virtual double getBestCriterion() const
  {
    return 0.0;
  }
  virtual void generateCpp(FILE *) {}
  inline CbcModel *cbcModel() const
  {
    return model_;
  }
  /* If chooseMethod_ id non-null then the rest is fairly pointless
       as choosemethod_ will be doing all work
     This comment makes more sense if you realise that there's a conversion in
     process from the Cbc branching classes to Osi branching classes. The test
     for use of the Osi branching classes is CbcModel::branchingMethod_
     non-null (i.e., it points to one of these CbcBranchDecision objects) and
     that branch decision object has an OsiChooseVariable method set. In which
     case, we'll use it, rather than the choose[*]Variable methods defined in
     CbcNode.
    */

  OsiChooseVariable *chooseMethod() const
  {
    return chooseMethod_;
  }
  void setChooseMethod(const OsiChooseVariable &method);

protected:
  // Clone of branching object
  CbcBranchingObject *object_;
  CbcModel *model_;
  /* If chooseMethod_ id non-null then the rest is fairly pointless
       as choosemethod_ will be doing all work
    */
  OsiChooseVariable *chooseMethod_;

private:
  CbcBranchDecision &operator=(const CbcBranchDecision &rhs);
};
#endif

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