AlpsSolution.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 AlpsSolution_h_
#define AlpsSolution_h_
 
#include <iosfwd>
#include <map>
#include <vector>
 
#include "AlpsKnowledge.h"
#include "AlpsTreeNode.h" // to get AlpsNodeIndex_t
 
//#############################################################################
 
class AlpsSolution : public AlpsKnowledge {
 
private:
  AlpsSolution(const AlpsSolution&);
  AlpsSolution& operator=(const AlpsSolution&);
 
  int index_;
 
  int depth_;
 
public:
 
  AlpsSolution(): AlpsKnowledge(AlpsKnowledgeTypeSolution),
                index_(-1), depth_(-1) {
  }
 
  AlpsSolution(const AlpsNodeIndex_t i, const int d): index_(i), depth_(d) {
    setType(AlpsKnowledgeTypeSolution);
  }
 
  virtual ~AlpsSolution() {}
 
  AlpsNodeIndex_t getIndex() { return index_; }
 
  void setIndex(const AlpsNodeIndex_t i) { index_ = i; }
 
  int getDepth() { return depth_; }
 
  void setDepth(const int d) { depth_ = d; }
 
  virtual void print(std::ostream& os) const{
    os << "WARNING: No solution print function is defined." << std::endl;
  }
 
  using AlpsKnowledge::encode;
 
  virtual AlpsReturnStatus encode(AlpsEncoded * encoded) const {
    encoded->writeRep(index_);
    encoded->writeRep(depth_);
    return AlpsReturnStatusOk;
  }
 
  virtual AlpsReturnStatus decodeToSelf(AlpsEncoded & encoded) {
    encoded.readRep(index_);
    encoded.readRep(depth_);
    return AlpsReturnStatusOk;
  }
 
};
 
#endif