AlpsNodePool.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 AlpsNodePool_h_
#define AlpsNodePool_h_
 
#include <vector>
 
#include "AlpsHelperFunctions.h"
#include "AlpsPriorityQueue.h"
#include "AlpsTreeNode.h"
#include "AlpsKnowledgePool.h"
 
class AlpsNodePool: public AlpsKnowledgePool {
  AlpsPriorityQueue<AlpsTreeNode*> candidateList_;
 
  AlpsSearchType searchStrategy_;
 
public:
 
  AlpsNodePool();
  AlpsNodePool(AlpsSearchType type);
  virtual ~AlpsNodePool();
 
 
  virtual int getNumKnowledges() const;
  virtual std::pair<AlpsKnowledge*, double> getKnowledge() const;
  virtual bool hasKnowledge() const { return !(candidateList_.empty()); }
  virtual int getMaxNumKnowledges() const { return INT_MAX; };
  virtual std::pair<AlpsKnowledge*, double> getBestKnowledge() const;
  virtual void getAllKnowledges (std::vector<std::pair<AlpsKnowledge*,
                                 double> >& kls) const;
 
 
  virtual void addKnowledge(AlpsKnowledge* node, double priority);
  virtual void popKnowledge() { candidateList_.pop(); }
 
 
  virtual void setMaxNumKnowledges(int num);
  double getBestKnowledgeValue() const;
  //Sahar: changed the following line
  AlpsTreeNode * getBestNode() const;
  AlpsPriorityQueue<AlpsTreeNode*> const & getCandidateList() const;
  void setNodeSelection(AlpsSearchStrategy<AlpsTreeNode*> & compare);
  void deleteGuts();
  void clear() { candidateList_.clear(); }
 
private:
  AlpsNodePool(AlpsNodePool const &);
  AlpsNodePool & operator=(AlpsNodePool const &);
};
 
#endif