Crystal.SigmoidEvaluator Class Reference

The SigmoidEvaluator returns a normalized utility based on a sigmoid function that has effectively 1 parameter ( -0.99999f leq k leq 0.99999f ) bounded by the box defined by PtA and PtB with PtA.x being strictly less than PtB.x! Parametrized Sigmoidfor an interactive plot. More...

Inheritance diagram for Crystal.SigmoidEvaluator:

Public Member Functions
override float	Evaluate (float x)
	Returns the utility value for the specified value x. More...
	SigmoidEvaluator ()
	Initializes a new instance of the T:Crystal.SigmoidEvaluator class. Parametrized Sigmoidfor an interactive plot. More...
	SigmoidEvaluator (Pointf ptA, Pointf ptB)
	Initializes a new instance of the T:Crystal.SigmoidEvaluator class. Parametrized Sigmoidfor an interactive plot. More...
	SigmoidEvaluator (Pointf ptA, Pointf ptB, float k)
	Initializes a new instance of the T:Crystal.SigmoidEvaluator class. Parametrized Sigmoidfor an interactive plot. More...
Public Member Functions inherited from Crystal.EvaluatorBase
int	CompareTo (IEvaluator other)
	Compares the current object with another object of the same type. More...

Additional Inherited Members
Protected Member Functions inherited from Crystal.EvaluatorBase
	EvaluatorBase ()
	Initializes a new instance of the T:Crystal.EvaluatorBase class. More...
	EvaluatorBase (Pointf ptA, Pointf ptB)
	Initializes a new instance of the T:Crystal.EvaluatorBase class. More...
Protected Attributes inherited from Crystal.EvaluatorBase
float	Xa
	The x-coordinate of point A. Note, this can have any value in the real interval (-inf, +inf). More...
float	Xb
	The x-coordinate of point B. Note, this can have any value in the real interval (-inf, +inf). More...
float	Ya
	The y-coordinate of point A. Note, this can have a value within the interval [0, 1]. More...
float	Yb
	The y-coordinate of point B. Note, this can have a value within the interval [0, 1]. More...
Properties inherited from Crystal.EvaluatorBase
Pointf	PtA [get]
	The first point of the evaluator. The x-coordinate of this point will always be strictly smaller than that of PtB. More...
Pointf	PtB [get]
	The second point of the evaluator. The x-coordinate of this point will always be strictly larger than that of PtA. More...
float	MinX [get]
	The lower bound of the x-coordinate interval. More...
float	MaxX [get]
	The upper bound of the x-coordinate interval. More...
float	MinY [get]
	The lower bound of the y-coordinate interval. More...
float	MaxY [get]
	The upper bound of the y-coordinate interval. More...
Interval< float >	XInterval [get]
	The x-coordinate interval represents the domain of definition of this evaluator. More...
Interval< float >	YInterval [get]
	The y-coordinate interval represents the range of this evaluator. Note that this must be a sub-interval (or the entire interval) [0,1]. More...
bool	IsInverted [get, set]
	When true, the output of the Evaluate method is transformed to 1.0f - (normal output). More...
Properties inherited from Crystal.IEvaluator
Pointf	PtA [get]
	The first point of the evaluator. The x-coordinate of this point will always be strictly smaller than that of PtB. More...
Pointf	PtB [get]
	The second point of the evaluator. The x-coordinate of this point will always be strictly larger than that of PtA. More...
float	MinX [get]
	The lower bound of the x-coordinate interval. More...
float	MaxX [get]
	The upper bound of the x-coordinate interval. More...
float	MinY [get]
	The lower bound of the y-coordinate interval. More...
float	MaxY [get]
	The upper bound of the y-coordinate interval. More...
Interval< float >	XInterval [get]
	The x-coordinate interval represents the domain of definition of this evaluator. More...
Interval< float >	YInterval [get]
	The y-coordinate interval represents the range of this evaluator. Note that this must be a sub-interval (or the entire interval) [0,1]. More...
bool	IsInverted [get, set]
	When true, the output of the Evaluate method is transformed to 1.0f - (normal output). More...

Detailed Description

The SigmoidEvaluator returns a normalized utility based on a sigmoid function that has effectively 1 parameter ( -0.99999f leq k leq 0.99999f ) bounded by the box defined by PtA and PtB with PtA.x being strictly less than PtB.x! Parametrized Sigmoid

for an interactive plot.

Constructor & Destructor Documentation

Crystal.SigmoidEvaluator.SigmoidEvaluator ( )

inline

Initializes a new instance of the T:Crystal.SigmoidEvaluator class. Parametrized Sigmoidfor an interactive plot.

Crystal.SigmoidEvaluator.SigmoidEvaluator ( Pointf  ptA, Pointf  ptB  )

inline

Initializes a new instance of the T:Crystal.SigmoidEvaluator class. Parametrized Sigmoidfor an interactive plot.

Parameters

ptA	Point a.
ptB	Point b.

Crystal.SigmoidEvaluator.SigmoidEvaluator ( Pointf  ptA, Pointf  ptB, float  k  )

inline

Initializes a new instance of the T:Crystal.SigmoidEvaluator class. Parametrized Sigmoidfor an interactive plot.

Parameters

ptA	Point a.
ptB	Point b.
k	K.

Member Function Documentation

override float Crystal.SigmoidEvaluator.Evaluate ( float  x )

inlinevirtual

Returns the utility value for the specified value x.

Parameters

x	The x value.

Reimplemented from Crystal.EvaluatorBase.

---

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

• Source/Evaluators/SigmoidEvaluator.cs