YACS::ENGINE::Pool Class Reference

Pool used to manage the samples of the optimizer loop plugin. More...

#include <Pool.hxx>

Collaboration diagram for YACS::ENGINE::Pool:

Classes
class	ExpData

Public Member Functions
int	getCurrentId () const
Any *	getCurrentInSample () const
Any *	getCurrentOutSample () const
Any *	getOutSample (int id)
void	pushInSample (int id, Any *inSample, unsigned char priority=0)
	Push a sample. WARNING inSample ownership is released to current Pool instance (this) ! More...
void	destroyAll ()

Private Member Functions
void	destroyCurrentCase ()
void	checkConsistency () throw (Exception)
void	setCurrentId (int id) throw (Exception)
void	putOutSampleAt (int id, Any *outValue) throw (Exception)
Any *	getNextSampleWithHighestPriority (int &id, unsigned char &priority) const
void	markIdAsInUse (int id)
bool	empty () const

Private Attributes
std::list< std::pair< int, ExpData > >	_container
std::list< std::pair< int, ExpData > >::iterator	_currentCase

Static Private Attributes
static const char	MESSAGEFORUNXSTNGID [] ="The id specified not exists. Unable to handle with. Either internal error, or invalid use of Pool from Optimizer Algorithm"

Friends
class	OptimizerLoop

Detailed Description

Pool used to manage the samples of the optimizer loop plugin.

Every sample has an identifier (Id), a priority, an initial value (In) and an evaluation value (Out). The current sample is the sample used by the latest terminated evaluation.

Definition at line 41 of file Pool.hxx.

Member Function Documentation

void Pool::checkConsistency ( ) throw (Exception)

private

This method is typically called by OptimizerNode to check the consistency, that is to say that optimizer algorithm has not corrupted 'this'.

Definition at line 140 of file Pool.cxx.

References _container.

{
  // First check unicity of ids.
  std::set<int> ids;
  std::list< std::pair<int, ExpData> >::iterator iter;
  for(iter=_container.begin();iter!=_container.end();iter++)
    {
      std::pair< std::set<int>::iterator, bool > verdict=ids.insert((*iter).first);
      if(verdict.second)
        {
          std::ostringstream what;
          what << "Id with value : " << (*iter).first << " appears several times.";
          throw Exception(what.str());
        }
    }
}

void Pool::destroyAll

(

void

)

Definition at line 123 of file Pool.cxx.

References _container.

Referenced by YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::OptimizerAlgASync::run(), and YACS::ENGINE::OptimizerLoop::updateStateOnFailedEventFrom().

{
  _container.clear();
}

void Pool::destroyCurrentCase ( )

private

Definition at line 128 of file Pool.cxx.

References _container, and _currentCase.

Referenced by YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

{
  if(!_container.empty())
    _container.erase(_currentCase);
}

bool Pool::empty ( ) const

private

Typically called after takeDecision of OptimizerAlg as been performed. If true is returned, that is to say that convergence has been reached.

Definition at line 247 of file Pool.cxx.

References _container.

Referenced by getCurrentId(), getCurrentInSample(), getCurrentOutSample(), getOutSample(), and YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

{
  return _container.empty();
}

int Pool::getCurrentId

(

void

)

const

Definition at line 78 of file Pool.cxx.

References _currentCase, and empty().

{ 
  if(empty())
    throw YACS::Exception("no current case set in pool");
  else
    return _currentCase->first; 
}

Any * Pool::getCurrentInSample

(

)

const

Definition at line 85 of file Pool.cxx.

References empty().

{ 
  if(empty())
    throw YACS::Exception("no current case set in pool");
  else
    return (*_currentCase).second.inValue(); 
}

Any * Pool::getCurrentOutSample

(

)

const

Definition at line 93 of file Pool.cxx.

References empty().

{ 
  if(empty())
    throw YACS::Exception("no current case set in pool");
  else
    return (*_currentCase).second.outValue(); 
}

Any * Pool::getNextSampleWithHighestPriority ( int &  id, unsigned char &  priority  ) const

private

This method is typically called by OptimizerNode instance owner of 'this' that wants to launch an another job on one branch.

Returns

: In case there are more jobs to do 2 parameters are returned.

• id to locate the computation to do.
• priority attached.
• value. In case no more jobs are required id and priority stay unchanged and the returned value is equal to 0.

Definition at line 205 of file Pool.cxx.

References _container.

Referenced by YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::OptimizerLoop::launchMaxOfSamples(), and YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

{
  unsigned char myPriority=0;
  std::list< std::pair<int, ExpData> >::const_iterator iter,ptToSelected;
  ptToSelected=_container.end();
  for(iter=_container.begin();iter!=_container.end();iter++)
    {
      if((*iter).second.isLaunchable())
        if((*iter).second.getPriority()>myPriority || ptToSelected==_container.end())
          {
            ptToSelected=iter;
            myPriority=(*iter).second.getPriority();
          }
    }
  //Search performed. No performing output writings if needed.
  if(ptToSelected==_container.end())
    return 0;
  priority=myPriority;
  id=(*ptToSelected).first;  
  return (*ptToSelected).second.inValue();
}

Any * Pool::getOutSample

(

int

id

)

Definition at line 101 of file Pool.cxx.

References _container, and empty().

{
  if(empty())
    throw YACS::Exception("no current case set in pool");

  std::list< std::pair<int, ExpData> >::iterator iter;
  for(iter=_container.begin();iter!=_container.end();iter++)
    if((*iter).first==id)
        return (*iter).second.outValue();
  if(iter==_container.end())
    throw YACS::Exception("no current case set in pool");
}

void Pool::markIdAsInUse ( int  id )

private

Typically called after 'this->destroyCurrentCase' 'this->checkConsistency' and 'this->getNextSampleWithHighestPriority' have been called. At this point the case with id id is marked as in use in order to avoid to be used by an another branch of OptimizerNode.

Definition at line 233 of file Pool.cxx.

References _container.

Referenced by YACS::ENGINE::OptimizerLoop::launchMaxOfSamples().

{
  std::list< std::pair<int, ExpData> >::iterator iter;
  for(iter=_container.begin();iter!=_container.end();iter++)
    if((*iter).first==id)
      {
        (*iter).second.markItAsInUse();
        break;
      }
}

void Pool::pushInSample	(	int	id,
		Any *	inSample,
		unsigned char	priority = 0
	)

Push a sample. WARNING inSample ownership is released to current Pool instance (this) !

Definition at line 116 of file Pool.cxx.

References _container, and YACS::ENGINE::RefCounter::decrRef().

{
  std::pair<int, ExpData> eltToAdd(id,Pool::ExpData(inSample,priority));
  _container.push_back(eltToAdd);
  inSample->decrRef();
}

void Pool::putOutSampleAt ( int  id, Any *  outValue  ) throw (Exception)

private

Push a result of case discriminated by id. It also sets the _currentCase pointer on the case discriminated by id. So after this call, the call to setCurrentId with the same id is useless.

Exceptions

When	case id is not found in 'this'. This is particulary true, if not an internal error, when optimizer algorithm has destroyed a case id different from its id.

Definition at line 181 of file Pool.cxx.

References _container, _currentCase, and MESSAGEFORUNXSTNGID.

Referenced by YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

{
  std::list< std::pair<int, ExpData> >::iterator iter;
  for(iter=_container.begin();iter!=_container.end();iter++)
    if((*iter).first==id)
      {
        _currentCase=iter;
        (*iter).second.setOutValue(outValue);
        break;
      }
  if(iter==_container.end())
    throw Exception(MESSAGEFORUNXSTNGID);
}

void Pool::setCurrentId ( int  id ) throw (Exception)

private

Exceptions

See	the throw case of pushOutSampleAt method.

Definition at line 160 of file Pool.cxx.

References _container, _currentCase, and MESSAGEFORUNXSTNGID.

Referenced by YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

{
  std::list< std::pair<int, ExpData> >::iterator iter;
  for(iter=_container.begin();iter!=_container.end();iter++)
    if((*iter).first==id)
      {
        _currentCase=iter;
        break;
      }
  if(iter==_container.end())
    throw Exception(MESSAGEFORUNXSTNGID);
}

Friends And Related Function Documentation

friend class OptimizerLoop

friend

Definition at line 43 of file Pool.hxx.

Member Data Documentation

std::list< std::pair<int, ExpData> > YACS::ENGINE::Pool::_container

private

Definition at line 66 of file Pool.hxx.

Referenced by checkConsistency(), destroyAll(), destroyCurrentCase(), empty(), getNextSampleWithHighestPriority(), getOutSample(), markIdAsInUse(), pushInSample(), putOutSampleAt(), and setCurrentId().

std::list< std::pair<int, ExpData> >::iterator YACS::ENGINE::Pool::_currentCase

private

Definition at line 67 of file Pool.hxx.

Referenced by destroyCurrentCase(), getCurrentId(), putOutSampleAt(), and setCurrentId().

const char Pool::MESSAGEFORUNXSTNGID ="The id specified not exists. Unable to handle with. Either internal error, or invalid use of Pool from Optimizer Algorithm"

staticprivate

Definition at line 86 of file Pool.hxx.

Referenced by putOutSampleAt(), and setCurrentId().

---

The documentation for this class was generated from the following files:

• src/engine/Pool.hxx
• src/engine/Pool.cxx