The AverageAggregator class - Evaluator aggregating multiple other Evaluators' scores into one output by taking the average. More...

#include <AverageAggregator.hh>

Inheritance diagram for grail::utility::AverageAggregator< ContextType >:

[legend]

Collaboration diagram for grail::utility::AverageAggregator< ContextType >:

[legend]

Public Member Functions
	AverageAggregator (const std::vector< std::shared_ptr< Evaluator< ContextType >>> &childEvaluators)
	AverageAggregator - Constructor. More...

virtual EvaluatorType	GetEvaluatorType () const override final

Public Member Functions inherited from grail::utility::Aggregator< ContextType >
	Aggregator (const std::vector< std::shared_ptr< Evaluator< ContextType >>> &childEvaluators)
	Aggregator - Constructor. More...

	Aggregator (const Aggregator< ContextType > &)=default

	Aggregator (Aggregator< ContextType > &&)=default

Aggregator &	operator= (const Aggregator< ContextType > &)=default

Aggregator &	operator= (Aggregator< ContextType > &&)=default

Public Member Functions inherited from grail::utility::Evaluator< ContextType >
float	EvaluateContext (const ContextType &context, UtilityEvaluatorSnapshot *const snapshot) const
	EvaluateContext - evaluates provided context and if provided snapshot is not empty, fills it with debug data describing this node. More...

Protected Member Functions
virtual float	Evaluate (const ContextType &context, UtilityEvaluatorSnapshot *const snapshot) const override final
	Evaluate - Called from EvaluateContext which also evaluates context, but without automatically filling snapshot with debug data. Should be overriden for each derived Evaluator. More...

Protected Member Functions inherited from grail::utility::Aggregator< ContextType >
virtual void	DebugDump (const std::map< const void *, std::size_t > &nodeMapping, EvaluationDebugData &debugData) const override
	DebugDump - Called from EvaluateContext, which generates additional debug data for each evaluator. Should be overriden in each derived evaluator to better reflect debug tree topology. More...

Additional Inherited Members
Protected Attributes inherited from grail::utility::Aggregator< ContextType >
std::vector< std::shared_ptr< Evaluator< ContextType > > >	childEvaluators {}

Detailed Description

template<typename ContextType>
class grail::utility::AverageAggregator< ContextType >

The AverageAggregator class - Evaluator aggregating multiple other Evaluators' scores into one output by taking the average.

Template Parameters

ContextType - Type of evaluated object. By default - ValueTuple(AIEntity, Blackboard).

Constructor & Destructor Documentation

◆ AverageAggregator()

template<typename ContextType >

grail::utility::AverageAggregator< ContextType >::AverageAggregator ( const std::vector< std::shared_ptr< Evaluator< ContextType >>> & childEvaluators )

inline

AverageAggregator - Constructor.

Parameters

childEvaluators - All evaluators which scores should be aggregated during evaluation of this node.

Member Function Documentation

◆ Evaluate()

template<typename ContextType >

virtual float grail::utility::AverageAggregator< ContextType >::Evaluate	(	const ContextType &	context,
		UtilityEvaluatorSnapshot *const	snapshot
	)		const

inlinefinaloverrideprotectedvirtual

Evaluate - Called from EvaluateContext which also evaluates context, but without automatically filling snapshot with debug data. Should be overriden for each derived Evaluator.

Parameters

context	- Input data for evaluation
snapshot	- Evaluator snapshot containing debug data describing whole evaluator tree.

Returns: Numerical evaluation of provided context.

Implements grail::utility::Evaluator< ContextType >.

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

GrailEvaluators/Aggregators/AverageAggregator.hh

Public Member Functions

Protected Member Functions