AlpsModel.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                                        *
 *          Aykut Bulut, 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-2023, Lehigh University, Yan Xu, Aykut Bulut, and      *
 *                          Ted Ralphs.                                      *
 * All Rights Reserved.                                                      *
 *===========================================================================*/
 
 
#ifndef AlpsModel_h_
#define AlpsModel_h_
 
#include <string>
 
#include "CoinError.hpp"
 
#include "AlpsKnowledge.h"
#include "AlpsTreeNode.h"
#include "AlpsParams.h"
 
class AlpsKnowledgeBroker;
 
class AlpsModel : public AlpsKnowledge {
 
private:
 
  AlpsModel(const AlpsModel&);
  AlpsModel& operator=(const AlpsModel&);
 
protected:
  std::string dataFile_;
  AlpsParams * AlpsPar_;
 
public:
 
 
 
  AlpsModel() :
    AlpsKnowledge(AlpsKnowledgeTypeModel),
    AlpsPar_(new AlpsParams) { }
  virtual ~AlpsModel() { delete AlpsPar_; }
 
 
 
  inline std::string getDataFile() const { return dataFile_; }
  AlpsParams * AlpsPar() { return AlpsPar_; }
 
 
 
  inline void setDataFile(std::string infile) { dataFile_ = infile; }
 
 
 
  virtual void readInstance(const char* dateFile) {
    throw CoinError("readInstance() is not defined.", "readData",
                    "AlpsModel");
  }
  virtual void readParameters(const int argnum, const char * const * arglist);
  void writeParameters(std::ostream& outstream) const;
  virtual bool setupSelf() { return true; }
  virtual void preprocess() {}
  virtual void postprocess() {}
  virtual AlpsTreeNode * createRoot() = 0;
  virtual void modelLog() {}
  virtual void nodeLog(AlpsTreeNode *node, bool force);
  virtual bool fathomAllNodes() { return false; }
 
 
  using AlpsKnowledge::encode;
  virtual AlpsReturnStatus encode(AlpsEncoded * encoded) const;
  virtual AlpsReturnStatus decodeToSelf(AlpsEncoded & encoded);
  virtual void registerKnowledge() { /* Default does nothing */ }
  virtual void sendGeneratedKnowledge() { /* Default does nothing */ }
  virtual void receiveGeneratedKnowledge() { /* Default does nothing */ }
  virtual AlpsEncoded* packSharedKnowlege() {
    /* Default does nothing */
    AlpsEncoded* encoded = NULL;
    return encoded;
  }
  virtual void unpackSharedKnowledge(AlpsEncoded&)
  { /* Default does nothing */ }
};
#endif