IMP logo
IMP Reference Guide  2.21.0
The Integrative Modeling Platform
IMP::isd::OneDimensionalDistribution Class Referenceabstract

Base class for distributions that are passed a single random variable. More...

#include <IMP/isd/distribution.h>

+ Inheritance diagram for IMP::isd::OneDimensionalDistribution:

Detailed Description

Base class for distributions that are passed a single random variable.

Children must overload IMP::isd::OneDimensionalDistribution::do_evaluate().

Definition at line 36 of file isd/distribution.h.

Public Member Functions

 OneDimensionalDistribution (std::string name="OneDimensionalDistribution %1%")
 
double evaluate (double v) const
 Get negative log-density for passed variable value. More...
 
Floats evaluate (const Floats &vs) const
 Get negative log-densities for passed variable values. More...
 
double get_density (double v) const
 Get probability density for passed variable value. More...
 
Floats get_density (const Floats &vs) const
 Get probability densities for passed variable values. 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::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)
 

Protected Member Functions

virtual double do_evaluate (double v) const =0
 
virtual Floats do_evaluate (const Floats &vs) const
 
virtual double do_get_density (double v) const
 
virtual Floats do_get_density (const Floats &vs) const
 
- 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

double IMP::isd::OneDimensionalDistribution::evaluate ( double  v) const

Get negative log-density for passed variable value.

Definition at line 49 of file isd/distribution.h.

Floats IMP::isd::OneDimensionalDistribution::evaluate ( const Floats vs) const

Get negative log-densities for passed variable values.

Definition at line 52 of file isd/distribution.h.

double IMP::isd::OneDimensionalDistribution::get_density ( double  v) const

Get probability density for passed variable value.

Definition at line 55 of file isd/distribution.h.

Floats IMP::isd::OneDimensionalDistribution::get_density ( const Floats vs) const

Get probability densities for passed variable values.

Definition at line 58 of file isd/distribution.h.

virtual ::IMP::VersionInfo IMP::isd::OneDimensionalDistribution::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::isd::Distribution.

Definition at line 60 of file isd/distribution.h.


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