dox for bounders

This commit is contained in:
nojhan 2011-09-12 16:05:18 +02:00
commit 7f6c591a6b
5 changed files with 26 additions and 13 deletions

View file

@ -30,17 +30,20 @@ Authors:
#include <eoFunctor.h> #include <eoFunctor.h>
//! edoBounder< EOT > /** The interface of a set of classes that modifies a solution so as to respect
* a given set of bounds (typically an hypercube).
*
* @ingroup Bounders
*/
template < typename EOT > template < typename EOT >
class edoBounder : public eoUF< EOT&, void > class edoBounder : public eoUF< EOT&, void >
{ {
public: public:
edoBounder( EOT min = EOT(1, 0), EOT max = EOT(1, 0) ) edoBounder( EOT min = EOT(1, 0), EOT max = EOT(1, 0) )
: _min(min), _max(max) : _min(min), _max(max)
{ {
assert(_min.size() > 0); assert(_min.size() > 0);
assert(_min.size() == _max.size()); assert(_min.size() == _max.size());
} }
// virtual void operator()( EOT& ) = 0 (provided by eoUF< A1, R >) // virtual void operator()( EOT& ) = 0 (provided by eoUF< A1, R >)

View file

@ -30,8 +30,10 @@ Authors:
#include "edoBounder.h" #include "edoBounder.h"
//! edoBounderBound< EOT > /** A bounder that correct an incorrect variable by setting it to the min/max
*
* @ingroup Bounders
*/
template < typename EOT > template < typename EOT >
class edoBounderBound : public edoBounder< EOT > class edoBounderBound : public edoBounder< EOT >
{ {

View file

@ -30,8 +30,10 @@ Authors:
#include "edoBounder.h" #include "edoBounder.h"
//! edoBounderNo< EOT > /** A bounder that does nothing.
*
* @ingroup Bounders
*/
template < typename EOT > template < typename EOT >
class edoBounderNo : public edoBounder< EOT > class edoBounderNo : public edoBounder< EOT >
{ {

View file

@ -30,8 +30,11 @@ Authors:
#include "edoBounder.h" #include "edoBounder.h"
//! edoBounderRng< EOT > /** A bounder that randomly draw new values for variables going out bounds,
* using an eoRng to do so.
*
* @ingroup Bounders
*/
template < typename EOT > template < typename EOT >
class edoBounderRng : public edoBounder< EOT > class edoBounderRng : public edoBounder< EOT >
{ {

View file

@ -29,8 +29,11 @@ Authors:
#include "edoBounder.h" #include "edoBounder.h"
//! edoBounderUniform< EOT > /** A bounder that randomly draw new values for variables going out bounds,
* in a given uniform distribution.
*
* @ingroup Bounders
*/
template < typename EOT > template < typename EOT >
class edoBounderUniform : public edoBounder< EOT > class edoBounderUniform : public edoBounder< EOT >
{ {