23 #ifndef AlpsKnowledgeBroker_h_
24 #define AlpsKnowledgeBroker_h_
31 #include "CoinMessageHandler.hpp"
56 std::map<int, AlpsKnowledge*> decodeMap_;
81 std::map<AlpsKnowledgeType, AlpsKnowledgePool*>*
pools_;
232 std::map<int, AlpsKnowledge*>::iterator pos, pos1;
233 pos = decodeMap_.find(name);
234 pos1 = decodeMap_.end();
238 decodeMap_.erase(pos);
242 decodeMap_[name] = userKnowledge;
254 return decodeMap_[name];
315 (std::pair<AlpsKnowledgeType, AlpsKnowledgePool*>(kt, kp));
318 throw CoinError(
"Broker doesn't manage this type of knowledge",
319 "addKnowledgePool()",
"AlpsKnowledgeBroker");
326 return (*pools_)[kt];
329 throw CoinError(
"Broker doesn't manage this type of knowledge",
330 "getKnowledgePool()",
"AlpsKnowledgeBroker");
344 throw CoinError(
"Broker doesn't manage this type of knowledge",
345 "getMaxNumKnowledges()",
"AlpsKnowledgeBroker");
356 throw CoinError(
"Broker doesn't manage this type of knowledge",
357 "setMaxNumKnowledges()",
"AlpsKnowledgeBroker");
367 throw CoinError(
"Broker doesn't manage this type of knowledge",
368 "hasKnowledge()",
"AlpsKnowledgeBroker");
372 virtual std::pair<AlpsKnowledge*, double>
378 throw CoinError(
"Broker doesn't manage this type of knowledge",
379 "getKnowledge()",
"AlpsKnowledgeBroker");
389 throw CoinError(
"Broker doesn't manage this type of knowledge",
390 "popKnowledge()",
"AlpsKnowledgeBroker");
395 virtual std::pair<AlpsKnowledge*, double>
401 double> >& kls)
const {
406 throw CoinError(
"Broker doesn't manage this type of knowledge",
407 "popKnowledge()",
"AlpsKnowledgeBroker");
419 throw CoinError(
"Broker doesn't manage this type of knowledge",
420 "popKnowledge()",
"AlpsKnowledgeBroker");
466 exitStatus_ = status;
583 rampUpNodeSelection_ = nc;
int workerMsgLevel_
The leve of printing message to screen of workers.
CoinMessages messages_
Alps messages.
int getTreeDepth()
Get tree depth.
AlpsNodeIndex_t maxIndex_
The maximum index can been assigned on this process.
void newLanguage(CoinMessages::Language language)
Set language.
virtual void initializeSearch(int argc, char *argv[], AlpsModel &model)=0
Do some initialization for search.
std::map< AlpsKnowledgeType, AlpsKnowledgePool * > * pools_
The collection of pools managed by the knowledge broker.
int hubMsgLevel_
The leve of printing message to screen of hubs.
virtual ~AlpsKnowledgeBroker()
Destructor.
int getNumNodeLog() const
Get times that node log has been printed.
virtual void addKnowledge(AlpsKnowledgeType kt, AlpsKnowledge *kl, double value)
Add a knowledge in the given type of knowledge pools.
int getlogFileLevel()
Return log file level.
virtual void popKnowledge(AlpsKnowledgeType kt)
Remove the a knowledge from the given type of knowledge pools.
int getNumNodesBranched() const
Query the number of node processed by this process.
AlpsNodeIndex_t nextNodeIndex()
Query the next index assigned to a newly created node, and then increment the nextIndex_ by 1...
virtual int getMaxNumKnowledges(AlpsKnowledgeType kt) const
Query the max number of knowledge can be stored in a given type of knowledge pools.
const AlpsKnowledge * decoderObject(int name)
This method returns the pointer to an empty object of the registered class name.
int nodeLeftNum_
The number of nodes left.
AlpsSearchStrategy< AlpsTreeNode * > * nodeSelection_
Node selection criterion.
int treeDepth_
The depth of the tree.
int systemNodeProcessed_
To record how many nodes processed by the system (used in parallel code).
int nodeBranchedNum_
The number of nodes that have been branched.
void setMaxNodeIndex(AlpsNodeIndex_t s)
Set the upper bound of node indices.
The abstract base class of any user-defined class that Alps has to know about in order to encode/deco...
CoinMessageHandler * handler_
Message handler.
AlpsSearchStrategy< AlpsTreeNode * > * rampUpNodeSelection_
Node selection criterion.
void setNextNodeIndex(AlpsNodeIndex_t s)
Set nextIndex_.
The base class of knowledge broker class.
AlpsTimer & tempTimer()
Query secondary timer.
This class holds one node of the search tree.
void setModel(AlpsModel *m)
int getHubMsgLevel()
Return msg level.
void setRampUpNodeSelection(AlpsSearchStrategy< AlpsTreeNode * > *nc)
virtual void addKnowledge(AlpsKnowledge *nk, double priority)=0
Add a knowledge to pool.
double getPeakMemory()
Get peak memory usage.
AlpsSolutionPool * solPool_
A solution pool containing the solutions found.
CoinMessages * messagesPointer()
Return pointer to messages.
AlpsNodeIndex_t getMaxNodeIndex() const
Queriy the upper bound of node indices.
void setNodeProcessingTime(double npTime)
virtual int updateNumNodesLeft()
Update the number of left nodes on this process.
double getNodeProcessingTime()
The subtree pool is used to store subtrees.
AlpsTimer timer_
Main timer.
void setPeakMemory(double size)
Set peak memory usage.
AlpsExitStatus getSolStatus() const
Query search termination status.
int bestSolNode_
The number of nodes pocessed to find the solution.
AlpsSubTree * workingSubTree_
Point to the subtree that being explored.
virtual double getBestQuality() const =0
The process (serial) / the master (parallel) queries the quality of the best solution that it knows...
double nodeProcessingTime_
The approximately CPU time to process a node.
void setExitStatus(AlpsExitStatus status)
Set terminate status.
int logFileLevel_
The degree of log file.
virtual void setMaxNumKnowledges(int num)
Set the quantity limit of knowledges that can be stored in the pool.
virtual bool hasKnowledge() const
Check whether the pool has knowledge.
virtual std::pair< AlpsKnowledge *, double > getKnowledge(AlpsKnowledgeType kt) const
Get a knowledge, but doesn't remove it from the pool.
CoinMessageHandler * messageHandler() const
Return handler.
AlpsSearchStrategy< AlpsTreeNode * > * getRampUpNodeSelection() const
AlpsNodeIndex_t nextIndex_
The index to be assigned to a new search tree node.
int getNumNodesDiscarded() const
Query the number of node processed by this process.
AlpsKnowledgeBroker()
Default constructor.
AlpsPhase phase_
Alps phase.
AlpsModel * model_
Pointer to model.
virtual void searchLog()=0
Search statistics log.
AlpsProcessType
This enumerative constant describes the various process types.
int getMasterMsgLevel()
Return msg level.
double peakMemory_
Peak memory usage.
virtual int getMaxNumKnowledges() const
Query the quantity limit of knowledges.
bool needWorkingSubTree_
Indicate whether need a new subtree.
void setNodeMemSize(int ms)
virtual std::pair< AlpsKnowledge *, double > getBestKnowledge(AlpsKnowledgeType kt) const
Get the best knowledge in the given type of knowledge pools.
AlpsSearchStrategy< AlpsSubTree * > * getSubTreeSelection() const
virtual std::pair< AlpsKnowledge *, double > getKnowledge() const =0
Query a knowledge, but doesn't remove it from the pool.
int largeSize_
The size of largest message buffer can be sent or received.
virtual double getBestEstimateQuality()
Get best estimalted quality in system.
void setPhase(AlpsPhase ph)
std::string instanceName_
The instance name.
bool userBalancePeriod_
Has user input balance period.
virtual int getNumKnowledges(AlpsKnowledgeType kt) const
Query the number of knowledge in the given type of a knowledge pool.
void passInMessageHandler(CoinMessageHandler *handler)
Pass in Message handler (not deleted at end).
AlpsSearchStrategy< AlpsSubTree * > * treeSelection_
Tree selection criterion.
virtual int getMasterRank() const
Query the global rank of the Master.
AlpsSearchStrategy< AlpsTreeNode * > * getNodeSelection() const
virtual void getAllKnowledges(AlpsKnowledgeType kt, std::vector< std::pair< AlpsKnowledge *, double > > &kls) const
Get all knowledges in the given type of knowledge pools.
void setupKnowledgePools()
Set up knowledge pools for this broker.
AlpsTimer tempTimer_
Secondary timer.
virtual AlpsTreeNode * createRoot()
Create the root node.
virtual AlpsProcessType getProcType() const
Query the type (master, hub, or worker) of the process.
virtual void search(AlpsModel *model)
Search best solution for a given model.
int numNodeLog_
Times that node log is printed.
virtual void getAllKnowledges(std::vector< std::pair< AlpsKnowledge *, double > > &kls) const
Get a reference to all the knowledges in the pool.
AlpsNodeIndex_t getNextNodeIndex() const
Query the next index assigned to a newly created node.
void setSubTreeSelection(AlpsSearchStrategy< AlpsSubTree * > *tc)
virtual bool hasKnowledge(AlpsKnowledgeType kt) const
Query whether there are knowledges in the given type of knowledge pools.
virtual void popKnowledge()
Remove the queried knowledge from the pool.
virtual int getNumNodeLeftSystem()
int nodeDiscardedNum_
The number of nodes that have been discarded before processing.
virtual void printBestSolution(char *outputFile=0) const =0
The process (serial) / the master (parallel) outputs the best solution that it knows to a file or std...
int nodePartialNum_
The number of nodes that are pregnant.
virtual void rootSearch(AlpsTreeNode *root)=0
Explore the tree rooted as the given root.
AlpsExitStatus exitStatus_
The status of search when terminated.
virtual int getProcRank() const
Qeury the global rank of process.
virtual void setMaxNumKnowledges(AlpsKnowledgeType kt, int num)
Set the max number of knowledge can be stored in a given type o fknowledge pools. ...
CoinMessages messages()
Return messages.
void setComparison(AlpsSearchStrategy< AlpsSubTree * > &compare)
Set comparison function and resort heap.
int nodeProcessedNum_
The number of nodes that have been processed.
int getNumNodesPartial() const
Query the number of node in the queue that are pregnant.
int getNumNodesProcessedSystem() const
Query the number of node processed by the system.
AlpsKnowledgePool * getKnowledgePool(AlpsKnowledgeType kt) const
Retrieve a knowledge pool in the Knowledge base.
AlpsTimer & timer()
Query timer.
int nodeMemSize_
The approximate memory size (bytes) of a node with full description.
std::string logfile_
The log file.
AlpsTimer subTreeTimer_
Subtree timer.
void setNodeSelection(AlpsSearchStrategy< AlpsTreeNode * > *nc)
int getMsgLevel()
Return msg level.
int getNumNodesProcessed() const
Query the number of node processed by this process.
In the solution pool we assume that the lower the priority value the more desirable the solution is...
void setLanguage(CoinMessages::Language language)
void setNumNodeLog(int num)
Get times that node log has been printed.
void addKnowledgePool(AlpsKnowledgeType kt, AlpsKnowledgePool *kp)
Add a knowledge pool into the Knowledge pools.
This class contains the data pertaining to a particular subtree in the search tree.
int solNum_
The number of solutions found.
AlpsTimer & subTreeTimer()
Query subtree timer.
virtual AlpsTreeNode * getBestNode() const
Query the best node in the subtree pool.
virtual double getIncumbentValue() const =0
The process queries the objective value of the incumbent that it stores.
void registerClass(int name, AlpsKnowledge *userKnowledge)
Every user derived knowledge class must register.
int msgLevel_
The leve of printing message to screen of the master and general message.
AlpsSubTreePool * subTreePool_
A subtree pool holding a collection of subtrees.