Detailed Description

Upper bound harmonic function (non-zero when feature > mean)

Definition at line 22 of file core/HarmonicUpperBound.h.

Public Member Functions
	HarmonicUpperBound (Float mean, Float k)

virtual double	evaluate (double feature) const override
	Calculate score with respect to the given feature. More...

virtual DerivativePair	evaluate_with_derivative (double feature) const override
	Calculate score and derivative with respect to the given feature. More...

virtual std::string	get_type_name () const override

virtual ::IMP::VersionInfo	get_version_info () const override
	Get information about the module and version of the object. More...

Public Member Functions inherited from IMP::core::Harmonic
	Harmonic (Float mean, Float k)

Float	get_k () const
	Return the spring constant. More...

Float	get_mean () const
	Return the mean of this function. More...

void	set_k (Float k)
	Set the spring constant. More...

void	set_mean (Float mean)
	Set the mean of this function. More...

Public Member Functions inherited from IMP::UnaryFunction
	UnaryFunction (std::string name="UnaryFunction%1%")

Public Member Functions inherited from IMP::Object
virtual void	clear_caches ()

CheckLevel	get_check_level () const

def	get_derived_object
	Return this object cast to the most derived subclass. More...

LogLevel	get_log_level () const

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)

Additional Inherited Members
Static Public Member Functions inherited from IMP::core::Harmonic
static Float	get_k_from_standard_deviation (Float sd, Float t=297.15)
	Return the k to use for a given Gaussian standard deviation. More...

Protected Member Functions inherited from IMP::Object
	Object (std::string name)
	Construct an object with the given name. More...

virtual void	do_destroy ()

Constructor & Destructor Documentation

IMP::core::HarmonicUpperBound::HarmonicUpperBound	(	Float	mean,
		Float	k
	)

Create with the given mean and the spring constant k

Definition at line 30 of file core/HarmonicUpperBound.h.

virtual double IMP::core::HarmonicUpperBound::evaluate ( double feature ) const

overridevirtual

Calculate score with respect to the given feature.

Parameters

[in] feature Value of feature being tested.

Reimplemented from IMP::core::Harmonic.

Definition at line 32 of file core/HarmonicUpperBound.h.

Here is the call graph for this function:

virtual DerivativePair IMP::core::HarmonicUpperBound::evaluate_with_derivative ( double feature ) const

overridevirtual

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 from IMP::core::Harmonic.

Definition at line 35 of file core/HarmonicUpperBound.h.

Here is the call graph for this function:

virtual ::IMP::VersionInfo IMP::core::HarmonicUpperBound::get_version_info ( ) const

overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::core::Harmonic.

Definition at line 41 of file core/HarmonicUpperBound.h.

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