AlpsDecompModel.h

Go to the documentation of this file.

//===========================================================================//
// This file is part of the DIP Solver Framework.                            //
//                                                                           //
// DIP is distributed under the Eclipse Public License as part of the        //
// COIN-OR repository (http://www.coin-or.org).                              //
//                                                                           //
// Authors: Matthew Galati, SAS Institute Inc. (matthew.galati@sas.com)      //
//          Ted Ralphs, Lehigh University (ted@lehigh.edu)                   //
//          Jiadong Wang, Lehigh University (jiw408@lehigh.edu)              //
//                                                                           //
// Copyright (C) 2002-2019, Lehigh University, Matthew Galati, Ted Ralphs    //
// All Rights Reserved.                                                      //
//===========================================================================//

//===========================================================================//
#ifndef AlpsDecompModel_h_
#define AlpsDecompModel_h_

//===========================================================================//
#include "Alps.h"
#include "AlpsModel.h"
#include "AlpsDecompParam.h"


//===========================================================================//
#include "DecompAlgo.h"
#include "DecompConstraintSet.h"

//===========================================================================//
#include <string>

//===========================================================================//
class AlpsTreeNode;

//===========================================================================//
//===========================================================================//

//===========================================================================//
class AlpsDecompModel : public AlpsModel {


private:

   //----------------------------------------------------------------------//
   //----------------------------------------------------------------------//
   std::string m_classTag;

   AlpsDecompParam m_param;

   DecompAlgo* m_decompAlgo;

   double m_bestLB;
   double m_bestUB;
   int    m_nodesProcessed;
   int    m_alpsStatus;

   //-----------------------------------------------------------------------//
   //-----------------------------------------------------------------------//
public:
   AlpsDecompModel() :
      AlpsModel    (),
      m_classTag   ("ALPSM"),
      m_param      (),
      m_decompAlgo (NULL) {
   }

   AlpsDecompModel(UtilParameters& utilParam,
                   DecompAlgo*      decompAlgo) :
      AlpsModel   (),
      m_classTag  ("ALPSM"),
      m_param     (utilParam),
      m_decompAlgo(decompAlgo) {
      if (decompAlgo == NULL)
         throw UtilException("No DecompAlgo algorithm has been set.",
                             "AlpsDecompModel", "AlpsDecompModel");

      setAlpsSettings();
   }

   virtual ~AlpsDecompModel() {}
   //-----------------------------------------------------------------------//
   //-----------------------------------------------------------------------//
   virtual AlpsTreeNode* createRoot();

   virtual bool fathomAllNodes();
   //-----------------------------------------------------------------------//
   //-----------------------------------------------------------------------//
   AlpsExitStatus solve();

   void setAlpsSettings();

   inline void setDecompAlgo(DecompAlgo* decompAlgo) {
      m_decompAlgo = decompAlgo;
   }
   //-----------------------------------------------------------------------//
   //-----------------------------------------------------------------------//
   //THINK: return ref?
   inline DecompAlgo* getDecompAlgo() {
      return m_decompAlgo;
   }

   inline AlpsDecompParam& getParam() {
      return m_param;
   }


   inline const int getNumCoreRows() const {
      return m_decompAlgo->getModelCore().getModel()->getNumRows();
   }

   inline const int getNumCoreCols() const {
      return m_decompAlgo->getModelCore().getModel()->getNumCols();
   }

   inline const std::vector<std::string>& getColNames() const {
      return m_decompAlgo->getModelCore().getModel()->getColNames();
   }

   inline const std::vector<std::string>& getRowNames() const {
      return m_decompAlgo->getModelCore().getModel()->getRowNames();
   }

   inline const DecompSolution* getBestSolution() const {
      return m_decompAlgo->getXhatIPBest();
   }

   const double getGlobalLB() const {
      return m_bestLB;
   }
   const double getGlobalUB() const {
      return m_bestUB;
   }
   const int    getSolStatus() const {
      return m_alpsStatus;
   }
   const int    getNumNodesProcessed() const {
      return m_nodesProcessed;
   }

};

#endif