paradiseo/eo/src/eoFunctorStore.h
nojhan 77921fea0c feat: add initializer list interface to eoFunctorStore
Easier to use while state initialize combined operators.
2020-03-24 16:34:01 +01:00

108 lines
3.3 KiB
C++

// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-
//-----------------------------------------------------------------------------
// eoFunctorStore.h
// (c) Maarten Keijzer 2000, GeNeura Team, 2000
/*
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Contact: todos@geneura.ugr.es, http://geneura.ugr.es
Marc.Schoenauer@polytechnique.fr
mak@dhi.dk
*/
//-----------------------------------------------------------------------------
#ifndef _eoFunctorStore_h
#define _eoFunctorStore_h
#include <vector>
#include <algorithm>
#include "utils/eoLogger.h"
class eoFunctorBase;
/**
eoFunctorStore is a class that stores functors that are allocated on the
heap. This class can be used in factories to store allocated memory for
dynamically created functors.
@ingroup Utilities
*/
class eoFunctorStore
{
public:
/// Default Ctor
eoFunctorStore() {}
// virtual destructor so we don't need to define it in derived classes
virtual ~eoFunctorStore();
/// Add an eoFunctorBase to the store
template <class Functor>
Functor& storeFunctor(Functor* r)
{
#ifndef NDEBUG
unsigned int existing = std::count( vec.begin(), vec.end(), r );
if( existing > 0 ) {
eo::log << eo::warnings << "WARNING: you asked eoFunctorStore to store the functor " << r << " "
<< existing + 1 << " times, a segmentation fault may occur in the destructor." << std::endl;
}
#endif
// If the compiler complains about the following line,
// check if you really are giving it a pointer to an
// eoFunctorBase derived object
vec.push_back(r);
return *r;
}
/** Allocate the given functor, store it and return its reference.
*
* Indicate the class to instanciate as template paramater,
* and pass its constructor arguments.
*
* @code
* eoSelect<EOT>& selector = state.pack< eoRankMuSelect<EOT> >( mu );
* @endcode
*/
template<class Functor, class... Args>
Functor& pack( Args&&... args )
{
Functor* f = new Functor(args...);
return this->storeFunctor(f);
}
// Allow to pass initializer lists of pointers, for example for edoCombinedContinue.
template<class Functor, class Args>
Functor& pack( std::initializer_list<Args> args )
{
Functor* f = new Functor(args);
return this->storeFunctor(f);
}
private :
/** no copying allowed */
eoFunctorStore(const eoFunctorStore&);
/** no assignment allowed */
eoFunctorStore operator=(const eoFunctorStore&);
protected:
std::vector<eoFunctorBase*> vec;
};
#endif