NetBuilder::FigureOfMerit::CBCFigureOfMerit Class Reference

Abstract class for figure of merit which can be evaluated in a CBC way. More...

#include <FigureOfMerit.h>

Inherits NetBuilder::FigureOfMerit::FigureOfMerit.

Inherited by NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::MULTILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::UNILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::UNILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::UNILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::UNILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::BitEquidistribution< ET >, NetBuilder::FigureOfMerit::CombinedFigureOfMerit, NetBuilder::FigureOfMerit::CoordUniformFigureOfMerit< KERNEL, ET >, and NetBuilder::FigureOfMerit::WeightedFigureOfMerit< PROJDEP >.

Public Member Functions
virtual	~CBCFigureOfMerit ()=default
	Virtual default destructor.
virtual std::unique_ptr< CBCFigureOfMeritEvaluator >	evaluator ()=0
	Returns a std::unique_ptr to an evaluator for the figure of merit.
virtual Accumulator	accumulator (Real initialValue) const =0
	Creates a new accumulator.
Public Member Functions inherited from NetBuilder::FigureOfMerit::FigureOfMerit
virtual	~FigureOfMerit ()=default
	Virtual default destructor.
std::unique_ptr< FigureOfMeritEvaluator >	evaluator ()
	Returns a std::unique_ptr to an evaluator for the figure of merit.
virtual std::string	format () const =0
	Output information about the figure of merit.

Detailed Description

Abstract class for figure of merit which can be evaluated in a CBC way.

Member Function Documentation

accumulator()

virtual Accumulator NetBuilder::FigureOfMerit::CBCFigureOfMerit::accumulator ( Real initialValue ) const

pure virtual

Creates a new accumulator.

Parameters

initialValue

Initial accumulator value.

Implemented in NetBuilder::FigureOfMerit::BitEquidistribution< ET >, NetBuilder::FigureOfMerit::CombinedFigureOfMerit, NetBuilder::FigureOfMerit::CoordUniformFigureOfMerit< KERNEL, ET >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< PROJDEP >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::MULTILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::UNILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::UNILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::UNILEVEL, GaussMethod > >, and NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::UNILEVEL, SchmidMethod > >.

References evaluator().

evaluator()

virtual std::unique_ptr< CBCFigureOfMeritEvaluator > NetBuilder::FigureOfMerit::CBCFigureOfMerit::evaluator ( )

pure virtual

Returns a std::unique_ptr to an evaluator for the figure of merit.

Implemented in NetBuilder::FigureOfMerit::BitEquidistribution< ET >, NetBuilder::FigureOfMerit::CombinedFigureOfMerit, NetBuilder::FigureOfMerit::CoordUniformFigureOfMerit< KERNEL, ET >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< PROJDEP >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::MULTILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::UNILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueProjMerit< EmbeddingType::UNILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, GaussMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::MULTILEVEL, SchmidMethod > >, NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::UNILEVEL, GaussMethod > >, and NetBuilder::FigureOfMerit::WeightedFigureOfMerit< TValueTransformedProjMerit< EmbeddingType::UNILEVEL, SchmidMethod > >.

Referenced by accumulator().

---

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

• include/netbuilder/FigureOfMerit/FigureOfMerit.h