IMP logo
IMP Reference Guide  develop.b99932598c,2021/06/14
The Integrative Modeling Platform
IMP::spb::Gaussian Class Reference

Gaussian function (symmetric about the mean) More...

#include <IMP/spb/Gaussian.h>

+ Inheritance diagram for IMP::spb::Gaussian:

Detailed Description

Gaussian function (symmetric about the mean)

Senes at al., JMB 366, 436 (2007)

Definition at line 20 of file spb/Gaussian.h.

Public Member Functions

 Gaussian (Float Emin, Float Zmin, Float sigma)
 
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...
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. 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
 
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

- 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::spb::Gaussian::Gaussian ( Float  Emin,
Float  Zmin,
Float  sigma 
)

Create with the given mean and the spring constant k

Definition at line 23 of file spb/Gaussian.h.

Member Function Documentation

virtual double IMP::spb::Gaussian::evaluate ( double  feature) const
virtual

Calculate score with respect to the given feature.

Parameters
[in]featureValue of feature being tested.
Returns
Score

Reimplemented from IMP::UnaryFunction.

Definition at line 44 of file spb/Gaussian.h.

virtual DerivativePair IMP::spb::Gaussian::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 DerivativePair containing the score and its partial derivative with respect to the given feature.

Reimplemented from IMP::UnaryFunction.

Definition at line 36 of file spb/Gaussian.h.

virtual ::IMP::VersionInfo IMP::spb::Gaussian::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 49 of file spb/Gaussian.h.


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