The UpperBound class - Upper-bounds output of provided Evaluator. More...

#include <Curve.hh>

Inheritance diagram for grail::evaluator::UpperBound< ContextType >:

Collaboration diagram for grail::evaluator::UpperBound< ContextType >:

Public Member Functions
	UpperBound (std::shared_ptr< Evaluator< ContextType >> childEvaluator, float upperBound)
	UpperBound - Constructor. More...

virtual float	Sample (float argument) const override final
	Sample - Transforms argument into output value depending on the type of Curve. More...

virtual data::EvaluatorType	GetEvaluatorType () const override final

Public Member Functions inherited from grail::evaluator::Curve< ContextType >
	Curve (std::shared_ptr< Evaluator< ContextType >> childEvaluator)
	Curve - Constructor. More...

	Curve (const Curve< ContextType > &other)=default

	Curve (Curve< ContextType > &&other)=default

virtual float	Evaluate (const ContextType &context, data::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...

virtual void	GetDependentConsiderations (std::vector< Consideration< ContextType > * > &considerations) override

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

Additional Inherited Members
Protected Member Functions inherited from grail::evaluator::Curve< ContextType >
virtual void	DebugDump (const std::map< const void *, unsigned int > &nodeMapping, data::EvaluationDebugData &debugData) const override final
	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...

Detailed Description

The UpperBound class - Upper-bounds output of provided Evaluator.

Template Parameters

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

Constructor & Destructor Documentation

template<typename ContextType >

grail::evaluator::UpperBound< ContextType >::UpperBound	(	std::shared_ptr< Evaluator< ContextType >>	childEvaluator,
		float	upperBound
	)

inline

UpperBound - Constructor.

Parameters

childEvaluator	- Evaluator which output will be transformed by this curve.
upperBound	- Value bounding the function from above.

template<typename ContextType >

virtual float grail::evaluator::UpperBound< ContextType >::Sample ( float argument ) const

inlinefinaloverridevirtual

Sample - Transforms argument into output value depending on the type of Curve.

Parameters

argument - Value of a curve argument belonging to its domain.

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