The ConstantFunction class - Constant function. More...

Inheritance diagram for grail::curves::ConstantFunction< ContextType >:

Collaboration diagram for grail::curves::ConstantFunction< ContextType >:

Public Member Functions
	ConstantFunction (std::shared_ptr< utility::Evaluator< ContextType >> childEvaluator, float constant)
	ConstantFunction - Constructor. More...

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

float	GetConstant () const
	GetConstant. More...

EvaluatorType	GetEvaluatorType () const override final

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

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

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

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...

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...

Additional Inherited Members
Protected Member Functions inherited from grail::curves::Curve< ContextType >
virtual void	DebugDump (const std::map< const void *, std::size_t > &nodeMapping, 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 ConstantFunction class - Constant function.

Template Parameters

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

Constructor & Destructor Documentation

template<typename ContextType >

grail::curves::ConstantFunction< ContextType >::ConstantFunction	(	std::shared_ptr< utility::Evaluator< ContextType >>	childEvaluator,
		float	constant
	)

inline

Parameters

childEvaluator	- Evaluator which output will be transformed by this curve.
constant	- Value which will always be returned by this object's sample method.

template<typename ContextType >

float grail::curves::ConstantFunction< ContextType >::GetConstant ( ) const

inline

GetConstant.

Returns: Value which will always be returned by this object's sample method.

template<typename ContextType >

virtual float grail::curves::ConstantFunction< 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: