IMP logo
Public Member Functions
IMP::UnaryFunction Class Reference

Detailed Description

Abstract single variable functor class for score functions.

These functors take a single feature value, and return a corresponding score (and optionally also the first derivative).

Implementers should check out IMP_UNARY_FUNCTION() and IMP_UNARY_FUNCTION_INLINE().

+ Inheritance diagram for IMP::UnaryFunction:

List of all members.

Public Member Functions

virtual double evaluate (double feature) const
 Calculate score with respect to the given feature.
virtual DerivativePair evaluate_with_derivative (double feature) const
 Calculate score and derivative with respect to the given feature.
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
void set_check_level (CheckLevel l)
void set_log_level (LogLevel l)
 Set the logging level used in this object.
void set_was_used (bool tf) const
void show (std::ostream &out=std::cout) const
const std::string & get_name () const
void set_name (std::string name)

Additional Inherited Members

- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)

Member Function Documentation

virtual double IMP::UnaryFunction::evaluate ( double  feature) const
virtual

Calculate score with respect to the given feature.

Parameters:
[in]featureValue of feature being tested.
Returns:
Score
virtual DerivativePair IMP::UnaryFunction::evaluate_with_derivative ( double  feature) const
virtual

Calculate score and derivative with respect to the given feature.

Parameters:
[in]featureValue of feature being tested.
Returns:
a FloatPair containing the score and its partial derivative with respect to the given feaure.

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

Generated on Tue May 22 2012 23:33:24 for IMP by doxygen 1.8.1