LatNet Builder Manual  2.0.1-11
Software Package for Constructing Highly Uniform Point Sets
NetBuilder::FigureOfMerit::FigureOfMeritEvaluator Class Referenceabstract

Evaluator abstract class to evaluate figure of merit for a net. More...

#include <FigureOfMerit.h>

Inherited by NetBuilder::FigureOfMerit::CBCFigureOfMeritEvaluator.

Public Types

typedef boost::signals2::signal< bool(const MeritValue &), LatBuilder::Functor::AllOfOnProgress
 
typedef boost::signals2::signal< void(const DigitalNet &)> OnAbort
 

Public Member Functions

virtual ~FigureOfMeritEvaluator ()=default
 Default virtual destructor.
 
 FigureOfMeritEvaluator ()
 Constructor.
 
virtual MeritValue operator() (const DigitalNet &net, int verbose=0)=0
 Computes the figure of merit for the given net for all the dimensions (full computation). More...
 
virtual void reset ()=0
 
Resets the evaluator and prepare it to evaluate a new net.
 
Signals
OnProgress & onProgress () const
 Progress signal. More...
 
OnAbort & onAbort () const
 Abort signal. More...
 

Detailed Description

Evaluator abstract class to evaluate figure of merit for a net.

Member Function Documentation

◆ onAbort()

OnAbort& NetBuilder::FigureOfMerit::FigureOfMeritEvaluator::onAbort ( ) const
inline

◆ onProgress()

OnProgress& NetBuilder::FigureOfMerit::FigureOfMeritEvaluator::onProgress ( ) const
inline

Progress signal.

Emitted after a contribution to the figure of merit is processed. The signal argument is the cumulative value of the figure of merit. If any of the signal slots returns false, the computation of the figure of merit will be aborted.

Referenced by NetBuilder::FigureOfMerit::ProjectionDependentEvaluator< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >::operator()(), NetBuilder::FigureOfMerit::WeightedFigureOfMerit< PROJDEP >::WeightedFigureOfMeritEvaluator<>::operator()(), and NetBuilder::FigureOfMerit::CBCFigureOfMeritEvaluator::operator()().

◆ operator()()

virtual MeritValue NetBuilder::FigureOfMerit::FigureOfMeritEvaluator::operator() ( const DigitalNet net,
int  verbose = 0 
)
pure virtual

Computes the figure of merit for the given net for all the dimensions (full computation).

Parameters
netNet to evaluate.
verboseVerbosity level.

Implemented in NetBuilder::FigureOfMerit::CBCFigureOfMeritEvaluator.


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