Grail (C#)  1.3.0
A multi-platform, modular, universal engine for embedding advanced AI in games.
Grail.Evaluators.Curves.SigmoidFunction< ContextType > Class Template Reference

Sigmoid function. More...

Inheritance diagram for Grail.Evaluators.Curves.SigmoidFunction< ContextType >:
Collaboration diagram for Grail.Evaluators.Curves.SigmoidFunction< ContextType >:

Public Member Functions

 SigmoidFunction (Evaluator< ContextType > childEvaluator, float range, float slope, float threshold, float displacement)
 Constructor. More...
 
sealed override float Sample (float argument)
 Transforms argument into output value depending on the type of Curve. More...
 
- Public Member Functions inherited from Grail.Evaluators.Curves.Curve< ContextType >
 Curve (Evaluator< ContextType > childEvaluator)
 Constructor. More...
 
- Public Member Functions inherited from Grail.Evaluators.Evaluator< ContextType >
float EvaluateContext (ContextType context, in UtilityEvaluatorSnapshot snapshot)
 Evaluates provided context and if provided snapshot is not empty, fills it with debug data describing this node. More...
 

Public Attributes

sealed override EvaluatorType EvaluatorType => EvaluatorType.CURVE_SIGMOID
 

Additional Inherited Members

- Protected Member Functions inherited from Grail.Evaluators.Curves.Curve< ContextType >
sealed override float Evaluate (ContextType context, in UtilityEvaluatorSnapshot snapshot)
 Called from EvaluateContext which also evaluates context, but without automatically filling snapshot with debug data. Should be overriden for each derived Evaluator. More...
 
sealed override void DebugDump (IReadOnlyDictionary< object, int > nodeMapping, ref EvaluationDebugData debugData)
 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...
 
- Properties inherited from Grail.Evaluators.Evaluator< ContextType >
abstract EvaluatorType EvaluatorType [get]
 

Detailed Description

Sigmoid function.

Template Parameters
ContextTypeType of evaluated object. By default - ValueTuple(AIEntity, Blackboard).

Constructor & Destructor Documentation

◆ SigmoidFunction()

Grail.Evaluators.Curves.SigmoidFunction< ContextType >.SigmoidFunction ( Evaluator< ContextType >  childEvaluator,
float  range,
float  slope,
float  threshold,
float  displacement 
)
inline

Constructor.

Parameters
childEvaluatorEvaluator which output will be transformed by this curve.
rangeDetermines difference between highest possible value and lowest possible value.
slopeThe higher the slope, the more it will resemble step function. The lower the slope, the more it will resemble linear function.
thresholdLocation of the middle of sigmoid slope on X-axis.
displacementDisplacement of the curve on Y-axis.

Member Function Documentation

◆ Sample()

sealed override float Grail.Evaluators.Curves.SigmoidFunction< ContextType >.Sample ( float  argument)
inlinevirtual

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

Parameters
argumentValue of a curve argument belonging to its domain.
Returns
Transformed argument.

Implements Grail.Evaluators.Curves.Curve< ContextType >.


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