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

The StaircaseFunction class - Function consisting of multiple discrete values. More...

#include <StaircaseFunction.hh>

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

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

Public Member Functions
	StaircaseFunction (std::shared_ptr< utility::Evaluator< ContextType >> childEvaluator, const std::vector< StepData > &data)
	StaircaseFunction - Constructor. More...
virtual float	Sample (float argument) const override final
	Sample - Transforms argument into output value depending on the type of Curve. More...
std::vector< StepData > &	GetData ()
	GetData. More...
const std::vector< StepData > &	GetData () const
	GetData. 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

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

The StaircaseFunction class - Function consisting of multiple discrete values.

Template Parameters

ContextType

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

Constructor & Destructor Documentation

StaircaseFunction()

template<typename ContextType >

grail::curves::StaircaseFunction< ContextType >::StaircaseFunction ( std::shared_ptr< utility::Evaluator< ContextType >>  childEvaluator, const std::vector< StepData > &  data  )

inline

StaircaseFunction - Constructor.

Parameters

childEvaluator	- Evaluator which output will be transformed by this curve.
data	- Collection of data describing discrete values.

Member Function Documentation

GetData() [1/2]

template<typename ContextType >

std::vector<StepData>& grail::curves::StaircaseFunction< ContextType >::GetData ( )

inline

GetData.

Returns

Collection of data describing discrete values.

GetData() [2/2]

template<typename ContextType >

const std::vector<StepData>& grail::curves::StaircaseFunction< ContextType >::GetData ( ) const

inline

GetData.

Returns

Collection of data describing discrete values.

Sample()

template<typename ContextType >

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

Returns

Transformed argument.

Implements grail::curves::Curve< ContextType >.

---

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

• GrailEvaluators/Curves/StaircaseFunction.hh