AlpsSolutionPool.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 AlpsSolutionPool_h_
#define AlpsSolutionPool_h_
 
#include "AlpsKnowledgePool.h"
#include "AlpsSolution.h"
 
// todo(aykut) we do want to allow solutions with the same priority, but do
// todo(aykut) we want to allow identical solutions?
 
class AlpsSolutionPool: public AlpsKnowledgePool {
  std::multimap<double, AlpsSolution*> solutions_;
  int maxNumSolutions_;
 
public:
 
  AlpsSolutionPool(int maxsols=1);
  virtual ~AlpsSolutionPool();
 
 
  virtual int getNumKnowledges() const;
  virtual std::pair<AlpsKnowledge*, double> getKnowledge() const;
  virtual bool hasKnowledge() const;
  virtual int getMaxNumKnowledges() const { return maxNumSolutions_; }
  virtual std::pair<AlpsKnowledge*, double> getBestKnowledge() const;
  virtual void getAllKnowledges (std::vector<std::pair<AlpsKnowledge*,
                                double> >& sols) const;
 
 
  virtual void addKnowledge(AlpsKnowledge* sol, double priority);
  virtual void popKnowledge();
 
 
  virtual void setMaxNumKnowledges(int maxsols);
  void clean();
 
private:
  AlpsSolutionPool(const AlpsSolutionPool&);
  AlpsSolutionPool& operator=(const AlpsSolutionPool&);
};
 
#define AlpsSolutionInterface(ref)                                      \
int getNumSolutions() const {                                           \
   (ref).getNumSolutions();                                             \
}                                                                       \
int getMaxNumSolutions() const {                                        \
   return (ref).getMaxNumSolutions();                                   \
}                                                                       \
void setMaxNumSolutions(int num) {                                      \
   (ref).setMaxNumSolutions(num);                                       \
}                                                                       \
bool hasSolution() const {                                              \
   return (ref).hasSolution();                                          \
}                                                                       \
std::pair<const AlpsSolution*, double> getBestSolution() const {        \
   return (ref).getBestSolution();                                      \
}                                                                       \
void getAllSolutions                                                    \
   (std::vector<std::pair<const AlpsSolution*, double> >& sols) {       \
   return (ref).getAllSolutions(sols);                                  \
}                                                                       \
void addSolution(const AlpsSolution* sol, double priority) {            \
   (ref).addSolution(sol, priority);                                    \
}
 
#endif