grail::curves::Curve< ContextType > Class Template Reference

The Curve class - Defines objects transforming one value into the other. More...

#include <Curve.hh>

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

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

Public Member Functions
	Curve (std::shared_ptr< utility::Evaluator< ContextType >> childEvaluator)
	Curve - Constructor. More...
	Curve (const Curve< ContextType > &other)=default
	Curve (Curve< ContextType > &&other)=default
virtual float	Sample (float argument) const =0
	Sample - Transforms argument into output value depending on the type of Curve. More...
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...
virtual EvaluatorType	GetEvaluatorType () const =0

Protected Member Functions
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

template<typename ContextType>
class grail::curves::Curve< ContextType >

The Curve class - Defines objects transforming one value into the other.

Template Parameters

ContextType

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

Constructor & Destructor Documentation

Curve()

template<typename ContextType >

grail::curves::Curve< ContextType >::Curve ( std::shared_ptr< utility::Evaluator< ContextType >>  childEvaluator )

inlineexplicit

Curve - Constructor.

Parameters

childEvaluator

- Evaluator which output will be transformed by this curve.

Member Function Documentation

DebugDump()

template<typename ContextType >

virtual void grail::curves::Curve< ContextType >::DebugDump ( const std::map< const void *, std::size_t > &  nodeMapping, EvaluationDebugData &  debugData  ) const

inlinefinaloverrideprotectedvirtual

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.

Parameters

nodeMapping	- Maps node pointers to node index.
debugData	- Evaluation debug data which will be filled in this method

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

Evaluate()

template<typename ContextType >

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

inlinefinaloverridevirtual

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

Sample()

template<typename ContextType >

virtual float grail::curves::Curve< ContextType >::Sample ( float  argument ) const

pure virtual

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

Parameters

argument

- Value of a curve argument belonging to its domain.

Returns

Transformed argument.

Implemented in grail::curves::ConstantFunction< ContextType >, grail::curves::UnitStepFunction< ContextType >, grail::curves::StaircaseFunction< ContextType >, grail::curves::SigmoidFunction< ContextType >, grail::curves::PowerFunction< ContextType >, grail::curves::LinearlyInterpolatedCurve< ContextType >, grail::curves::LinearFunction< ContextType >, grail::curves::ExponentialFunction< ContextType >, grail::curves::DoubleSidedBound< ContextType >, grail::curves::UpperBound< ContextType >, grail::curves::LowerBound< ContextType >, and grail::curves::BezierSpline< ContextType >.

---

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

• GrailEvaluators/Curves/Curve.hh