IMP logo
IMP Reference Guide  develop.0ea7f7a4db,2020/10/23
The Integrative Modeling Platform
IMP::isd::FNormal Class Reference

FNormal. More...

#include <IMP/isd/FNormal.h>

+ Inheritance diagram for IMP::isd::FNormal:

Detailed Description


Probability density function and -log(p) of normal sampling from some function F. If A is drawn from the F-Normal distribution then F(A) is drawn from a normal distribution with mean F(M) and standard deviation sigma (w/r F(A)).

Arguments: F(A), J(A) the derivative of F w/r to A, F(M), and sigma. The distribution is normalized with respect to the variable A. Note that the mean and standard deviation with respect to A may not be M and sigma.

Example: If F is the log function, the F-normal distribution is the lognormal distribution with mean log(M) and standard deviation sigma (wrt. log(A)).

F must be a one-to-one function, i.e., it must be monotonically increasing or decreasing. This is not checked. For a monotonically decreasing function, set JA to -JA, so that JA > 0.

Definition at line 37 of file FNormal.h.

Public Member Functions

 FNormal (double FA, double JA, double FM, double sigma)
virtual double do_evaluate () const
virtual double do_get_density () const
virtual Floats do_get_sufficient_statistics () const
virtual void do_update_sufficient_statistics (Floats data)
virtual double evaluate_derivative_FA () const
virtual double evaluate_derivative_FM () const
virtual double evaluate_derivative_JA () const
virtual double evaluate_derivative_sigma () const
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...
void set_FA (double f)
void set_FM (double f)
void set_JA (double f)
void set_sigma (double f)
virtual void update_sufficient_statistics (double FA)
- Public Member Functions inherited from IMP::isd::OneDimensionalSufficientDistribution
 OneDimensionalSufficientDistribution (std::string name="OneDimensionalSufficientDistribution %1%")
 Constructor. More...
double evaluate () const
 Get negative log-density using cached sufficient statistics. More...
double get_density () const
 Get probability density using cached sufficient statistics. More...
Floats get_sufficient_statistics () const
void update_sufficient_statistics (Floats vs)
 Update cached sufficient statistics from data. More...
- Public Member Functions inherited from IMP::isd::Distribution
 Distribution (std::string name="Distribution %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 ()

Member Function Documentation

virtual ::IMP::VersionInfo IMP::isd::FNormal::get_version_info ( ) const

Get information about the module and version of the object.

Reimplemented from IMP::isd::OneDimensionalSufficientDistribution.

Definition at line 91 of file FNormal.h.

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