src/engine/OptimizerLoop.cxx

   1 // Copyright (C) 2006-2015  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "OptimizerLoop.hxx"
  21 #include "OutputPort.hxx"
  22 #include "Visitor.hxx"
  23
  24 #include <iostream>
  25
  26 //#define _DEVDEBUG_
  27 #include "YacsTrace.hxx"
  28
  29 using namespace YACS::ENGINE;
  30 using namespace std;
  31
  32 const char FakeNodeForOptimizerLoop::NAME[]="thisIsAFakeNode";
  33
  34 const int OptimizerLoop::NOT_RUNNING_BRANCH_ID=-1973012217;
  35 const int OptimizerLoop::NOT_INITIALIZED_BRANCH_ID=-1973;
  36
  37 const char OptimizerLoop::NAME_OF_ALGO_INIT_PORT[] = "algoInit";
  38 const char OptimizerLoop::NAME_OF_OUT_POOL_INPUT[] = "evalResults";
  39 const char OptimizerLoop::NAME_OF_ALGO_RESULT_PORT[] = "algoResults";
  40
  41
  42 FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop(OptimizerLoop *loop, bool normal, std::string message)
  43   : ElementaryNode(NAME), _loop(loop), _normal(normal), _message(message)
  44 {
  45   _state=YACS::TOACTIVATE;
  46   _father=_loop->getFather();
  47 }
  48
  49 FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop(const FakeNodeForOptimizerLoop& other)
  50   : ElementaryNode(other), _loop(0), _normal(other._normal), _message(other._message)
  51 {
  52 }
  53
  54 Node *FakeNodeForOptimizerLoop::simpleClone(ComposedNode *father, bool editionOnly) const
  55 {
  56   return new FakeNodeForOptimizerLoop(*this);
  57 }
  58
  59 void FakeNodeForOptimizerLoop::exForwardFailed()
  60 {
  61   _loop->exForwardFailed();
  62 }
  63
  64 void FakeNodeForOptimizerLoop::exForwardFinished()
  65 {
  66   _loop->exForwardFinished();
  67 }
  68
  69 void FakeNodeForOptimizerLoop::execute()
  70 {
  71   DEBTRACE("FakeNodeForOptimizerLoop::execute: " << _message)
  72   if (!_normal) {
  73     _loop->_errorDetails = _message;
  74     throw Exception(_message);
  75   }
  76   else
  77   {
  78     _loop->_algoResultPort.put(_loop->_alg->getAlgoResultProxy());
  79   }
  80 }
  81
  82 void FakeNodeForOptimizerLoop::aborted()
  83 {
  84   _loop->setState(YACS::ERROR);
  85 }
  86
  87 void FakeNodeForOptimizerLoop::finished()
  88 {
  89   _loop->setState(YACS::DONE);
  90 }
  91
  92 /*! \class YACS::ENGINE::OptimizerLoop
  93  *  \brief class to build optimization loops
  94  *
  95  * \ingroup ComposedNodes
  96  */
  97
  98 OptimizerLoop::OptimizerLoop(const std::string& name, const std::string& algLibWthOutExt,
  99                              const std::string& symbolNameToOptimizerAlgBaseInstanceFactory,
 100                              bool algInitOnFile,bool initAlgo, Proc * procForTypes):
 101         DynParaLoop(name,Runtime::_tc_string),_algInitOnFile(algInitOnFile),_alglib(algLibWthOutExt),
 102         _algoInitPort(NAME_OF_ALGO_INIT_PORT, this, Runtime::_tc_string, true),
 103         _loader(NULL),_alg(0),_convergenceReachedWithOtherCalc(false),
 104         _retPortForOutPool(NAME_OF_OUT_POOL_INPUT,this,Runtime::_tc_string),
 105         _nodeForSpecialCases(0), _algoResultPort(NAME_OF_ALGO_RESULT_PORT, this, Runtime::_tc_string)
 106 {
 107   //We need this because calling a virtual method in a constructor does not call the most derived method but the method of the class
 108   //A derived class must take care to manage that
 109   if(initAlgo)
 110     setAlgorithm(algLibWthOutExt,symbolNameToOptimizerAlgBaseInstanceFactory, procForTypes);
 111 }
 112
 113 OptimizerLoop::OptimizerLoop(const OptimizerLoop& other, ComposedNode *father, bool editionOnly):
 114   DynParaLoop(other,father,editionOnly),_algInitOnFile(other._algInitOnFile),_alglib(other._alglib),
 115   _convergenceReachedWithOtherCalc(false),_loader(NULL),_alg(0),_algoInitPort(other._algoInitPort,this),
 116   _retPortForOutPool(other._retPortForOutPool,this),_nodeForSpecialCases(0),
 117   _algoResultPort(other._algoResultPort, this)
 118 {
 119   //Don't call setAlgorithm here because it will be called several times if the class is derived. Call it in simpleClone for cloning
 120
 121   // Create the links to evalResults port
 122   set<OutPort *> fromPortsToReproduce=other._retPortForOutPool.edSetOutPort();
 123   for(set<OutPort *>::iterator iter=fromPortsToReproduce.begin();iter!=fromPortsToReproduce.end();iter++)
 124     edAddLink(getOutPort(other.getPortName(*iter)),&_retPortForOutPool);
 125 }
 126
 127 OptimizerLoop::~OptimizerLoop()
 128 {
 129   if(_alg)
 130     _alg->decrRef();
 131   cleanDynGraph();
 132   cleanInterceptors();
 133   delete _loader;
 134   delete _nodeForSpecialCases;
 135 }
 136
 137 Node *OptimizerLoop::simpleClone(ComposedNode *father, bool editionOnly) const
 138 {
 139   OptimizerLoop* ol=new OptimizerLoop(*this,father,editionOnly);
 140   // TODO: Remove this const_cast (find a better design to get the type codes from the original node)
 141   Proc * procForTypes = ol->getProc();
 142   if (procForTypes == NULL) {
 143     const Proc * origProc = getProc();
 144     procForTypes = const_cast<Proc *>(origProc);
 145   }
 146   ol->setAlgorithm(_alglib, _symbol, false, procForTypes);
 147   return ol;
 148 }
 149
 150 void OptimizerLoop::init(bool start)
 151 {
 152   DynParaLoop::init(start);
 153   _algoInitPort.exInit(start);
 154   _retPortForOutPool.exInit(start);
 155   _algoResultPort.exInit();
 156   _convergenceReachedWithOtherCalc=false;
 157   cleanDynGraph();
 158   cleanInterceptors();
 159 }
 160
 161 void OptimizerLoop::exUpdateState()
 162 {
 163   if(_state == YACS::DISABLED)
 164     return;
 165   delete _nodeForSpecialCases;
 166   _nodeForSpecialCases = NULL;
 167   try
 168     {
 169       if(_inGate.exIsReady())
 170         {
 171           setState(YACS::TOACTIVATE);
 172           // Force termination in case the previous algorithm did not finish properly (manual stop)
 173           _alg->finishProxy();
 174           _myPool.destroyAll();
 175
 176           // Initialize and launch the algorithm
 177           _alg->initializeProxy(_algoInitPort.getValue());
 178           if (_alg->hasError()) {
 179             string error = _alg->getError();
 180             _alg->finishProxy();
 181             throw Exception(error);
 182           }
 183
 184           //internal graph update
 185           int i;
 186           int nbOfBr=_nbOfBranches.getIntValue();
 187           _alg->setNbOfBranches(nbOfBr);
 188
 189           _alg->startProxy();
 190           if (_alg->hasError()) {
 191             string error = _alg->getError();
 192             _alg->finishProxy();
 193             throw Exception(error);
 194           }
 195
 196           if(nbOfBr==0)
 197             {
 198               // A number of branches of 0 is acceptable if there are no output ports
 199               // leaving OptimizerLoop
 200               bool normal = getAllOutPortsLeavingCurrentScope().empty();
 201               _nodeForSpecialCases = new FakeNodeForOptimizerLoop(this, normal,
 202                   "OptimizerLoop has no branch to run the internal node(s)");
 203               return;
 204             }
 205           _execNodes.resize(nbOfBr);
 206           _execIds.resize(nbOfBr);
 207           if(_initNode)
 208             {
 209               _execInitNodes.resize(nbOfBr);
 210               _initNodeUpdated.resize(nbOfBr);
 211               for(i=0;i<nbOfBr;i++)
 212                 _initNodeUpdated[i]=false;
 213             }
 214           _initializingCounter = 0;
 215           if (_finalizeNode)
 216             _execFinalizeNodes.resize(nbOfBr);
 217           vector<Node *> origNodes;
 218           origNodes.push_back(_initNode);
 219           origNodes.push_back(_node);
 220           origNodes.push_back(_finalizeNode);
 221           for(i=0;i<nbOfBr;i++)
 222             {
 223               _execIds[i]=NOT_INITIALIZED_BRANCH_ID;
 224               vector<Node *> clonedNodes = cloneAndPlaceNodesCoherently(origNodes);
 225               if(_initNode)
 226                 _execInitNodes[i] = clonedNodes[0];
 227               _execNodes[i] = clonedNodes[1];
 228               if(_finalizeNode)
 229                 _execFinalizeNodes[i] = clonedNodes[2];
 230               prepareInputsFromOutOfScope(i);
 231             }
 232           initInterceptors(nbOfBr);
 233           int id;
 234           unsigned char priority;
 235           Any *val=_myPool.getNextSampleWithHighestPriority(id,priority);
 236           if(!val)
 237             {
 238               // It is acceptable to have no sample to launch if there are no output ports
 239               // leaving OptimizerLoop
 240               std::set<OutPort *> setOutPort = getAllOutPortsLeavingCurrentScope();
 241               // Special in the special
 242               // We do not check algoResult
 243               setOutPort.erase(&_algoResultPort);
 244               bool normal = setOutPort.empty();
 245               _nodeForSpecialCases = new FakeNodeForOptimizerLoop(this, normal,
 246                   string("The algorithm of OptimizerLoop with name ") + _name +
 247                   " returns no sample to launch");
 248               return;
 249             }
 250           launchMaxOfSamples(true);
 251         }
 252     }
 253   catch (const exception & e)
 254     {
 255       _nodeForSpecialCases = new FakeNodeForOptimizerLoop(this, false,
 256           string("An error happened in the control algorithm of OptimizerLoop \"") + _name +
 257           "\": " + e.what());
 258     }
 259 }
 260
 261 int OptimizerLoop::getNumberOfInputPorts() const
 262 {
 263   return DynParaLoop::getNumberOfInputPorts()+2;
 264 }
 265
 266 InputPort *OptimizerLoop::getInputPort(const std::string& name) const throw(YACS::Exception)
 267 {
 268   if (name == NAME_OF_ALGO_INIT_PORT)
 269     return (InputPort *)&_algoInitPort;
 270   else if (name == NAME_OF_OUT_POOL_INPUT)
 271     return (InputPort *)&_retPortForOutPool;
 272   else
 273     return DynParaLoop::getInputPort(name);
 274 }
 275
 276 std::list<InputPort *> OptimizerLoop::getSetOfInputPort() const
 277 {
 278   list<InputPort *> ret=DynParaLoop::getSetOfInputPort();
 279   ret.push_back((InputPort *)&_algoInitPort);
 280   ret.push_back((InputPort *)&_retPortForOutPool);
 281   return ret;
 282 }
 283
 284 std::list<InputPort *> OptimizerLoop::getLocalInputPorts() const
 285 {
 286   list<InputPort *> ret=DynParaLoop::getLocalInputPorts();
 287   ret.push_back((InputPort *)&_algoInitPort);
 288   ret.push_back((InputPort *)&_retPortForOutPool);
 289   return ret;
 290 }
 291
 292 void OptimizerLoop::selectRunnableTasks(std::vector<Task *>& tasks)
 293 {
 294 }
 295
 296 void OptimizerLoop::getReadyTasks(std::vector<Task *>& tasks)
 297 {
 298   if(!_node)
 299     return;
 300   if(_state==YACS::TOACTIVATE || _state==YACS::ACTIVATED)
 301     {
 302       if(_nodeForSpecialCases)
 303         {
 304           _nodeForSpecialCases->getReadyTasks(tasks);
 305           return ;
 306         }
 307       vector<Node *>::iterator iter;
 308       for (iter=_execNodes.begin() ; iter!=_execNodes.end() ; iter++)
 309         (*iter)->getReadyTasks(tasks);
 310       for (iter=_execInitNodes.begin() ; iter!=_execInitNodes.end() ; iter++)
 311         (*iter)->getReadyTasks(tasks);
 312       for (iter=_execFinalizeNodes.begin() ; iter!=_execFinalizeNodes.end() ; iter++)
 313         (*iter)->getReadyTasks(tasks);
 314     }
 315 }
 316
 317 YACS::Event OptimizerLoop::updateStateOnFinishedEventFrom(Node *node)
 318 {
 319   if (getState() == YACS::FAILED)
 320     {
 321       // This happens when a valid computation on a branch finishes after an error on another branch.
 322       // In this case we just ignore the new result because the algorithm has already been terminated.
 323       return YACS::NOEVENT;
 324     }
 325   unsigned int id;
 326   switch(getIdentityOfNotifyerNode(node,id))
 327     {
 328     case INIT_NODE:
 329     {
 330       _execNodes[id]->exUpdateState();
 331       _nbOfEltConsumed++;
 332       _initializingCounter--;
 333       if (_initializingCounter == 0) _initNode->setState(DONE);
 334       break;
 335     }
 336     case WORK_NODE:
 337     {
 338       if(_convergenceReachedWithOtherCalc)
 339         { //This case happens when alg has reached its convergence whereas other calculations still compute
 340           _execIds[id]=NOT_RUNNING_BRANCH_ID;
 341           if(!isFullyLazy())
 342             return YACS::NOEVENT;
 343           else
 344             return finalize();
 345         }
 346       _myPool.putOutSampleAt(_execIds[id],_interceptorsForOutPool[id]->getValue());
 347       _myPool.setCurrentId(_execIds[id]);
 348       _alg->takeDecisionProxy();
 349       if (_alg->hasError()) {
 350         _errorDetails = string("An error happened in the control algorithm of optimizer loop: ") +
 351                         _alg->getError();
 352         _alg->finishProxy();
 353         setState(YACS::FAILED);
 354         return YACS::ABORT;
 355       }
 356
 357       _myPool.destroyCurrentCase();
 358       if(_myPool.empty())
 359         {
 360           pushValueOutOfScopeForCase(id);
 361           _execIds[id]=NOT_RUNNING_BRANCH_ID;
 362           if(!isFullyLazy())
 363             {// This case happens when the hand is returned to continue, whereas some other are working in parallel for nothing.
 364               _convergenceReachedWithOtherCalc=true;
 365               return YACS::NOEVENT;
 366             }
 367           return finalize();
 368         }
 369       _execIds[id]=NOT_RUNNING_BRANCH_ID;
 370       int newId;
 371       unsigned char priority;
 372       Any *val=_myPool.getNextSampleWithHighestPriority(newId, priority);
 373       if(!val)
 374         {
 375           bool isFinished=true;
 376           for(int i=0;i<_execIds.size() && isFinished;i++)
 377             isFinished=(_execIds[i]==NOT_RUNNING_BRANCH_ID || _execIds[i]==NOT_INITIALIZED_BRANCH_ID);
 378           if(isFinished)
 379             {
 380               std::cerr <<"OptimizerLoop::updateStateOnFinishedEventFrom: Alg has not inserted more cases whereas last element has been calculated !" << std::endl;
 381               setState(YACS::ERROR);
 382               exForwardFailed();
 383               _alg->finishProxy();
 384               return YACS::FINISH;
 385             }
 386           return YACS::NOEVENT;
 387         }
 388       launchMaxOfSamples(false);
 389       break;
 390     }
 391     case FINALIZE_NODE:
 392     {
 393       _unfinishedCounter--;
 394       if (_unfinishedCounter == 0)
 395         {
 396           _finalizeNode->setState(YACS::DONE);
 397           setState(YACS::DONE);
 398           return YACS::FINISH;
 399         }
 400       else
 401         return YACS::NOEVENT;
 402       break;
 403     }
 404     default:
 405       YASSERT(false);
 406     }
 407   return YACS::NOEVENT;
 408 }
 409
 410 YACS::Event OptimizerLoop::finalize()
 411 {
 412   //update internal node (definition node) state
 413   if (_node)
 414     {
 415       _node->setState(YACS::DONE);
 416       ComposedNode* compNode = dynamic_cast<ComposedNode*>(_node);
 417       if (compNode)
 418         {
 419           std::list<Node *> aChldn = compNode->getAllRecursiveConstituents();
 420           std::list<Node *>::iterator iter=aChldn.begin();
 421           for(;iter!=aChldn.end();iter++)
 422             (*iter)->setState(YACS::DONE);
 423         }
 424     }
 425   _alg->finishProxy();
 426   _algoResultPort.put(_alg->getAlgoResultProxy());
 427   if (_finalizeNode == NULL)
 428     {
 429       // No finalize node, we just finish OptimizerLoop at the end of exec nodes execution
 430       setState(YACS::DONE);
 431       return YACS::FINISH;
 432     }
 433   else
 434     {
 435       // Run the finalize nodes, the OptimizerLoop will be done only when they all finish
 436       _unfinishedCounter = 0;  // This counter indicates how many branches are not finished
 437       for (int i=0 ; i<_nbOfBranches.getIntValue() ; i++)
 438         if (_execIds[i] == NOT_RUNNING_BRANCH_ID)
 439           {
 440             DEBTRACE("Launching finalize node for branch " << i)
 441             _execFinalizeNodes[i]->exUpdateState();
 442             _unfinishedCounter++;
 443           }
 444         else
 445           // There should not be any running branch at this point
 446           YASSERT(_execIds[i] == NOT_INITIALIZED_BRANCH_ID)
 447       return YACS::NOEVENT;
 448     }
 449 }
 450
 451 //! Method used to notify the node that a child node has failed
 452 /*!
 453  * Notify the slave thread of the error, update the current state and
 454  * return the change state
 455  *
 456  *  \param node : the child node that has failed
 457  *  \return the state change
 458  */
 459 YACS::Event OptimizerLoop::updateStateOnFailedEventFrom(Node *node, const Executor *execInst)
 460 {
 461   DEBTRACE("OptimizerLoop::updateStateOnFailedEventFrom " << node->getName());
 462   _alg->setError(string("Error during the execution of YACS node ") + node->getName() +
 463                  ": " + node->getErrorReport());
 464   _alg->finishProxy();
 465   _myPool.destroyAll();
 466   DEBTRACE("OptimizerLoop::updateStateOnFailedEventFrom: returned from error notification.");
 467   return DynParaLoop::updateStateOnFailedEventFrom(node,execInst);
 468 }
 469
 470 void OptimizerLoop::checkNoCyclePassingThrough(Node *node) throw(YACS::Exception)
 471 {
 472 }
 473
 474 void OptimizerLoop::buildDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView)
 475 {
 476   DynParaLoop::buildDelegateOf(port,initialStart,pointsOfView);
 477   if(port==&_retPortForOutPool)
 478     throw Exception("OptimizerLoop::buildDelegateOf : uncorrect OptimizerLoop link : out pool port must be linked within the scope of OptimizerLoop node it belongs to.");
 479 }
 480
 481 void OptimizerLoop::buildDelegateOf(std::pair<OutPort *, OutPort *>& port, InPort *finalTarget, const std::list<ComposedNode *>& pointsOfView)
 482 {
 483   DynParaLoop::buildDelegateOf(port,finalTarget,pointsOfView);
 484   string typeOfPortInstance=(port.first)->getNameOfTypeOfCurrentInstance();
 485   if(typeOfPortInstance!=OutputPort::NAME)
 486     throw Exception("OptimizerLoop::buildDelegateOf : not implemented for DS because not specified ");
 487 }
 488
 489 void OptimizerLoop::checkControlDependancy(OutPort *start, InPort *end, bool cross,
 490                                            std::map < ComposedNode *,  std::list < OutPort * >, SortHierarc >& fw,
 491                                            std::vector<OutPort *>& fwCross,
 492                                            std::map< ComposedNode *, std::list < OutPort *>, SortHierarc >& bw,
 493                                            LinkInfo& info) const
 494 {
 495   if(end==&_retPortForOutPool)
 496     fw[(ComposedNode *)this].push_back(start);
 497   else
 498     DynParaLoop::checkControlDependancy(start,end,cross,fw,fwCross,bw,info);
 499 }
 500
 501 void OptimizerLoop::checkCFLinks(const std::list<OutPort *>& starts, InputPort *end, unsigned char& alreadyFed, bool direction, LinkInfo& info) const
 502 {
 503   if(end==&_retPortForOutPool)
 504     solveObviousOrDelegateCFLinks(starts,end,alreadyFed,direction,info);
 505   else
 506     DynParaLoop::checkCFLinks(starts,end,alreadyFed,direction,info);
 507 }
 508
 509 void OptimizerLoop::cleanInterceptors()
 510 {
 511   // At this point all garanties taken let's clean all.
 512   map<InputPort *,vector<InputPort *> >::iterator iter=_interceptors.begin();
 513   for(;iter!=_interceptors.end();iter++)
 514     for(vector<InputPort *>::iterator iter2=(*iter).second.begin();iter2!=(*iter).second.end();iter2++)
 515       delete (*iter2);
 516   _interceptors.clear();
 517   for(vector<AnyInputPort *>::iterator iter3=_interceptorsForOutPool.begin();iter3!=_interceptorsForOutPool.end();iter3++)
 518     delete (*iter3);
 519   _interceptorsForOutPool.clear();
 520 }
 521
 522 void OptimizerLoop::launchMaxOfSamples(bool first)
 523 {
 524   int id;
 525   unsigned char priority;
 526   Any *val;
 527   unsigned i;
 528   for (val = _myPool.getNextSampleWithHighestPriority(id, priority);
 529        !isFullyBusy(i) && val;
 530        val = _myPool.getNextSampleWithHighestPriority(id, priority))
 531     {
 532       if(_execIds[i] == NOT_INITIALIZED_BRANCH_ID)
 533         first=true; // node is not initialized (first pass)
 534       else
 535         first=false; // node is initialized (second pass)
 536       _execIds[i]=id;
 537       _myPool.markIdAsInUse(id);
 538       if(_initNode && !_initNodeUpdated[i])
 539         {
 540           putValueOnBranch(val,i,first);
 541           _execInitNodes[i]->exUpdateState();
 542           _initNodeUpdated[i]=true;
 543           _initializingCounter++;
 544         }
 545       else
 546         {
 547           if(!first)
 548             _execNodes[i]->init(first);
 549           putValueOnBranch(val,i,first);
 550           _execNodes[i]->exUpdateState();
 551           _nbOfEltConsumed++;
 552         }
 553     }
 554 }
 555
 556 bool OptimizerLoop::isFullyLazy() const
 557 {
 558   bool isLazy=true;
 559   for(unsigned i=0;i<_execIds.size() && isLazy;i++)
 560     isLazy=(_execIds[i]==NOT_RUNNING_BRANCH_ID || _execIds[i]==NOT_INITIALIZED_BRANCH_ID);
 561   return isLazy;
 562 }
 563
 564 /*!
 565  * Returns if a dynamic branch is available.
 566  * \param branchId Out param. Only usable if returned value is equal to \b false.
 567  */
 568 bool OptimizerLoop::isFullyBusy(unsigned& branchId) const
 569 {
 570   bool isFinished=true;
 571   unsigned i;
 572   for(i=0;i<_execIds.size() && isFinished;i++)
 573     isFinished=(_execIds[i]!=NOT_RUNNING_BRANCH_ID && _execIds[i]!=NOT_INITIALIZED_BRANCH_ID);
 574   if(!isFinished)
 575     branchId=i-1;
 576   return isFinished;
 577 }
 578
 579 /*!
 580  * Perform initialization of interceptors. \b WARNING _execNodes have to be created before.
 581  */
 582 void OptimizerLoop::initInterceptors(unsigned nbOfBr)
 583 {
 584   //For all classical outputports leaving 'this'
 585   set<OutPort *> portsToIntercept=getAllOutPortsLeavingCurrentScope();
 586   portsToIntercept.erase(&_algoResultPort);
 587   for(set<OutPort *>::iterator iter=portsToIntercept.begin();iter!=portsToIntercept.end();iter++)
 588     {
 589       OutputPort *portC=(OutputPort *)(*iter);//Warrantied by OptimizerLoop::buildDelegateOf
 590       const set<InputPort *>& links=portC->getSetOfPhyLinks();
 591       for(set<InputPort *>::const_iterator iter2=links.begin();iter2!=links.end();iter2++)
 592         {
 593 #ifdef NOCOVARIANT
 594           InputPort *reprCur=dynamic_cast<InputPort *>((*iter2)->getPublicRepresentant());
 595 #else
 596           InputPort *reprCur=(*iter2)->getPublicRepresentant();
 597 #endif
 598           if(!isInMyDescendance(reprCur->getNode()))
 599             {//here we've got an out of scope link : Let's intercept it
 600               if(_interceptors.find(reprCur)==_interceptors.end())
 601                 {
 602                   _interceptors[reprCur].resize(nbOfBr);
 603                   for(unsigned i=0;i<nbOfBr;i++)
 604                     {
 605                       OutputPort *portExecC=(OutputPort *)_execNodes[i]->getOutputPort(_node->getOutPortName(portC));
 606                       InputPort *clone=reprCur->clone(0);
 607                       _interceptors[reprCur][i]=clone;
 608                       portExecC->edAddInputPort(clone);
 609                     }
 610                 }
 611               else
 612                 {
 613                   for(unsigned i=0;i<nbOfBr;i++)
 614                     {
 615                       OutputPort *portExecC=(OutputPort *)_execNodes[i]->getOutputPort(_node->getOutPortName(portC));
 616                       portExecC->edAddInputPort(_interceptors[reprCur][i]);
 617                     }
 618                 }
 619             }
 620         }
 621     }
 622   // For out pool
 623   _interceptorsForOutPool.resize(nbOfBr);
 624   set< OutPort * > links=_retPortForOutPool.edSetOutPort();
 625   for(unsigned i=0;i<nbOfBr;i++)
 626     _interceptorsForOutPool[i]=(AnyInputPort *)_retPortForOutPool.clone(this);
 627   for(set<OutPort *>::iterator iter2=links.begin();iter2!=links.end();iter2++)
 628     for(unsigned j=0;j<nbOfBr;j++)
 629       {
 630         OutPort *portExec;
 631         Node *whatType=isInMyDescendance((*iter2)->getNode());
 632         if(whatType==_node)
 633           {
 634             portExec=_execNodes[j]->getOutPort(_node->getOutPortName(*iter2));
 635             portExec->addInPort(_interceptorsForOutPool[j]);
 636           }
 637         else if(whatType==_initNode && whatType!=0)//This case should never happend. Useless !
 638           {
 639             portExec=_execInitNodes[j]->getOutPort(_node->getOutPortName(*iter2));
 640             portExec->addInPort(_interceptorsForOutPool[j]);
 641           }
 642       }
 643 }
 644
 645 /*!
 646  * Typically called when _alg has decided that convergence has been reached. In this case the links leaving the current scope are activated and filled
 647  * with value of the branch specified by 'branchId' that is the branch in which the convergence has been reached.
 648  */
 649 void OptimizerLoop::pushValueOutOfScopeForCase(unsigned branchId)
 650 {
 651   map<InputPort *, std::vector<InputPort *> >::iterator iter;
 652   for(iter=_interceptors.begin();iter!=_interceptors.end();iter++)
 653     (*iter).first->put((*iter).second[branchId]->get());
 654 }
 655
 656 void OptimizerLoop::accept(Visitor *visitor)
 657 {
 658   visitor->visitOptimizerLoop(this);
 659 }
 660
 661 //! Set the algorithm library name and factory name (symbol in library) to create the algorithm and change it if the node is not connected
 662 /*!
 663  *   throw an exception if the node is connected
 664  */
 665 void OptimizerLoop::setAlgorithm(const std::string& alglib, const std::string& symbol,
 666                                  bool checkLinks, Proc * procForTypes)
 667 {
 668   if(checkLinks)
 669     {
 670       if (_splittedPort.edGetNumberOfOutLinks() != 0 ||
 671           _retPortForOutPool.edGetNumberOfLinks() != 0 ||
 672           _algoInitPort.edGetNumberOfLinks() != 0 ||
 673           _algoResultPort.edGetNumberOfOutLinks() != 0)
 674         throw Exception("The OptimizerLoop node must be disconnected before setting the algorithm");
 675     }
 676
 677   _symbol = symbol;
 678   _alglib = alglib;
 679
 680   if (_alg) {
 681     _alg->decrRef();
 682     _alg = NULL;
 683   }
 684
 685   loadAlgorithm();
 686
 687   if(_alg)
 688     {
 689       _alg->setProc((procForTypes == NULL) ? getProc() : procForTypes);
 690
 691       // Delete the values in the input ports if they were initialized
 692       _retPortForOutPool.put((Any *)NULL);
 693       _algoInitPort.put((Any *)NULL);
 694
 695       // Change the type of the ports
 696       _splittedPort.edSetType(checkTypeCode(_alg->getTCForInProxy(), NAME_OF_SPLITTED_SEQ_OUT));
 697       _retPortForOutPool.edSetType(checkTypeCode(_alg->getTCForOutProxy(), NAME_OF_OUT_POOL_INPUT));
 698       _algoInitPort.edSetType(checkTypeCode(_alg->getTCForAlgoInitProxy(), NAME_OF_ALGO_INIT_PORT));
 699       _algoResultPort.edSetType(checkTypeCode(_alg->getTCForAlgoResultProxy(), NAME_OF_ALGO_RESULT_PORT));
 700     }
 701
 702   modified();
 703 }
 704
 705 TypeCode * OptimizerLoop::checkTypeCode(TypeCode * tc, const char * portName)
 706 {
 707   if (tc == NULL) {
 708     ostringstream errorMsg;
 709     errorMsg << "The algorithm specified for OptimizerLoop node \"" << getName() <<
 710                 "\" provided an invalid type for port \"" << portName << "\"";
 711     throw Exception(errorMsg.str());
 712   }
 713   return tc;
 714 }
 715
 716 //! Load the algorithm from the dynamic library
 717 /*!
 718  *
 719  */
 720 void OptimizerLoop::loadAlgorithm()
 721 {
 722   YASSERT(_alg == NULL)
 723
 724   if (_loader != NULL) {
 725     delete _loader;
 726     _loader = NULL;
 727   }
 728   _loader = new YACS::BASES::DynLibLoader(_alglib);
 729   OptimizerAlgBaseFactory algFactory = NULL;
 730
 731   if (_alglib != "" && _symbol != "")
 732     {
 733       try
 734         {
 735           _errorDetails = "";
 736           algFactory = (OptimizerAlgBaseFactory)_loader->getHandleOnSymbolWithName(_symbol);
 737         }
 738       catch (YACS::Exception& e)
 739         {
 740           _errorDetails = e.what();
 741           modified();
 742           throw;
 743         }
 744     }
 745
 746   if (algFactory != NULL)
 747     _alg = algFactory(&_myPool);
 748 }
 749
 750 //! Return the name of the algorithm library
 751 /*!
 752  *
 753  */
 754 std::string OptimizerLoop::getAlgLib() const
 755 {
 756   return _alglib;
 757 }
 758
 759 //! Check validity for the node.
 760 /*!
 761  *  Throw an exception if the node is not valid
 762  */
 763 void OptimizerLoop::checkBasicConsistency() const throw(YACS::Exception)
 764 {
 765   DEBTRACE("OptimizerLoop::checkBasicConsistency");
 766   if (_alglib == "")
 767     throw Exception("No library specified for the OptimizerLoop control algorithm");
 768   if (_symbol == "")
 769     throw Exception("No symbol specified for the OptimizerLoop control algorithm");
 770   if(_alg == NULL)
 771     throw YACS::Exception("Problem during library loading: "+_errorDetails);
 772
 773   DynParaLoop::checkBasicConsistency();
 774 }
 775
 776 int OptimizerLoop::getNumberOfOutputPorts() const
 777 {
 778   return DynParaLoop::getNumberOfOutputPorts() + 1;
 779 }
 780
 781 std::list<OutputPort *> OptimizerLoop::getSetOfOutputPort() const
 782 {
 783   list<OutputPort *> ret = DynParaLoop::getSetOfOutputPort();
 784   ret.push_back((OutputPort *)&_algoResultPort);
 785   return ret;
 786 }
 787
 788 std::list<OutputPort *> OptimizerLoop::getLocalOutputPorts() const
 789 {
 790   list<OutputPort *> ret = DynParaLoop::getLocalOutputPorts();
 791   ret.push_front((OutputPort *)&_algoResultPort);
 792   return ret;
 793 }
 794
 795 OutPort * OptimizerLoop::getOutPort(const std::string& name) const throw(YACS::Exception)
 796 {
 797   return (name == NAME_OF_ALGO_RESULT_PORT) ? (OutPort *)&_algoResultPort :
 798                                               DynParaLoop::getOutPort(name);
 799 }
 800
 801
 802 OutputPort * OptimizerLoop::getOutputPort(const std::string& name) const throw(YACS::Exception)
 803 {
 804   return (name == NAME_OF_ALGO_RESULT_PORT) ? (OutputPort *)&_algoResultPort :
 805                                               DynParaLoop::getOutputPort(name);
 806 }