BALL::FermiBaseFunction Class Reference

#include <BALL/SCORING/COMMON/fermiBaseFunction.h>

Inheritance diagram for BALL::FermiBaseFunction:
BALL::ScoringBaseFunction

List of all members.


Public Member Functions

 FermiBaseFunction ()
 FermiBaseFunction (float lower, float upper)
void setLower (float lower)
void setUpper (float upper)
float calculate (float x) const
float calculate (float x, float lower, float upper)

Private Member Functions

void computeFermiParameters_ ()

Private Attributes

float a_
float b_

Detailed Description

Sigmoidal base function


Constructor & Destructor Documentation

BALL::FermiBaseFunction::FermiBaseFunction (  ) 
BALL::FermiBaseFunction::FermiBaseFunction ( float  lower,
float  upper 
)

The function is defined in such a way that the score approaches 1 for values < lower and 0 for values > upper. If you need contrary behaviour, you have to supply a "lower" which is greater than "upper". This will invert the function.


Member Function Documentation

float BALL::FermiBaseFunction::calculate ( float  x,
float  lower,
float  upper 
) [virtual]

Reimplemented from BALL::ScoringBaseFunction.

float BALL::FermiBaseFunction::calculate ( float  x  )  const [virtual]

Reimplemented from BALL::ScoringBaseFunction.

void BALL::FermiBaseFunction::computeFermiParameters_ (  )  [private]
void BALL::FermiBaseFunction::setLower ( float  lower  )  [virtual]

Reimplemented from BALL::ScoringBaseFunction.

void BALL::FermiBaseFunction::setUpper ( float  upper  )  [virtual]

Reimplemented from BALL::ScoringBaseFunction.


Member Data Documentation