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