IMP::UnaryFunction Class Reference

Abstract single variable functor class for score functions. More...

#include <IMP/UnaryFunction.h>

Inheritance diagram for IMP::UnaryFunction:

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 implement two functions:

• virtual double evaluate(double feature) const
• virtual DerivativePair evaluate_with_derivative(double feature) const also add IMP_OBJECT_METHODS(Name) macro for Object methods

Definition at line 25 of file UnaryFunction.h.

Public Member Functions
	UnaryFunction (std::string name="UnaryFunction%1%")
virtual double	evaluate (double feature) const
	Calculate score with respect to the given feature. More...
virtual DerivativePair	evaluate_with_derivative (double feature) const
	Calculate score and derivative with respect to the given feature. More...
Public Member Functions inherited from IMP::Object
virtual void	clear_caches ()
CheckLevel	get_check_level () const
LogLevel	get_log_level () const
virtual VersionInfo	get_version_info () const
	Get information about the module and version of the object. More...
void	set_check_level (CheckLevel l)
void	set_log_level (LogLevel l)
	Set the logging level used in this object. More...
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)
virtual std::string	get_type_name () const

Additional Inherited Members
Protected Member Functions inherited from IMP::Object
	Object (std::string name)
	Construct an object with the given name. More...
virtual void	do_destroy ()

Member Function Documentation

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

virtual

Calculate score with respect to the given feature.

Parameters

[in]

feature

Value of feature being tested.

Returns

Score

Reimplemented in IMP::core::SurfaceTetheredChain, IMP::misc::FreelyJointedChain, IMP::core::TruncatedHarmonic< DIRECTION >, IMP::core::HarmonicWell, IMP::core::WeightedSumOfExponential, IMP::spb::Gaussian, IMP::example::ExampleUnaryFunction, IMP::core::WeightedSum, IMP::misc::WormLikeChain, IMP::core::Cosine, IMP::core::Harmonic, IMP::score_functor::ScoreUnaryFunction< Score, D >, IMP::score_functor::ScoreUnaryFunction< score_functor::OpenCubicSpline >, IMP::core::ClosedCubicSpline, IMP::core::Linear, IMP::core::HarmonicLowerBound, and IMP::core::HarmonicUpperBound.

Definition at line 33 of file UnaryFunction.h.

virtual DerivativePair IMP::UnaryFunction::evaluate_with_derivative ( double  feature ) const

virtual

Calculate score and derivative with respect to the given feature.

Parameters

[in]

feature

Value of feature being tested.

Returns

a DerivativePair containing the score and its partial derivative with respect to the given feature.

Reimplemented in IMP::core::SurfaceTetheredChain, IMP::core::TruncatedHarmonic< DIRECTION >, IMP::misc::FreelyJointedChain, IMP::core::HarmonicWell, IMP::core::WeightedSumOfExponential, IMP::example::ExampleUnaryFunction, IMP::misc::WormLikeChain, IMP::spb::Gaussian, IMP::core::Cosine, IMP::core::Linear, IMP::core::ClosedCubicSpline, IMP::core::Harmonic, IMP::core::WeightedSum, IMP::core::HarmonicLowerBound, IMP::core::HarmonicUpperBound, IMP::score_functor::ScoreUnaryFunction< Score, D >, and IMP::score_functor::ScoreUnaryFunction< score_functor::OpenCubicSpline >.

Definition at line 48 of file UnaryFunction.h.

---

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

• UnaryFunction.h