IMP logo
IMP Reference Guide  develop.879b8d2544,2020/09/29
The Integrative Modeling Platform
IMP::isd::GaussianRestraint Class Reference

Normal probability distribution as a restraint. More...

#include <IMP/isd/GaussianRestraint.h>

+ Inheritance diagram for IMP::isd::GaussianRestraint:

Detailed Description

Normal probability distribution as a restraint.

Definition at line 21 of file GaussianRestraint.h.

Public Member Functions

 GaussianRestraint (Particle *x, Particle *mu, Particle *sigma)
 Gaussian restraint. More...
 
 GaussianRestraint (double x, Particle *mu, Particle *sigma)
 
 GaussianRestraint (Particle *x, double mu, Particle *sigma)
 
 GaussianRestraint (Particle *x, Particle *mu, double sigma)
 
 GaussianRestraint (double x, double mu, Particle *sigma)
 
 GaussianRestraint (Particle *x, double mu, double sigma)
 
 GaussianRestraint (double x, Particle *mu, double sigma)
 
virtual IMP::ModelObjectsTemp do_get_inputs () const
 
double get_chi () const
 
double get_probability () 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...
 
virtual double unprotected_evaluate (IMP::DerivativeAccumulator *accum) const
 
- Public Member Functions inherited from IMP::Restraint
 Restraint (Model *m, std::string name)
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 Perform the actual restraint scoring. More...
 
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf. More...
 
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms. More...
 
virtual ScoringFunctioncreate_scoring_function (double weight=1.0, double max=NO_MAX) const
 Create a scoring function with only this restraint. More...
 
virtual RestraintInfoget_dynamic_info () const
 
virtual double get_last_score () const
 
double get_score () const
 
virtual RestraintInfoget_static_info () const
 
bool get_was_good () const
 
void set_weight (Float weight)
 
Float get_weight () const
 
double get_maximum_score () const
 
void set_maximum_score (double s)
 
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
 
- 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::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 A restraint should override this to compute the score and derivatives. More...
 
virtual Restraints do_create_current_decomposition () const
 
virtual Restraints do_create_decomposition () const
 
ModelObjectsTemp do_get_outputs () const
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- 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::isd::GaussianRestraint::GaussianRestraint ( Particle x,
Particle mu,
Particle sigma 
)

Gaussian restraint.

The restraint is a 3-particle restraint, linking together the mean, observed value and variance, which can all be either Nuisances or doubles. If F is the identity function, this is a gaussian (e.g. harmonic) restraint.

Member Function Documentation

virtual IMP::ModelObjectsTemp IMP::isd::GaussianRestraint::do_get_inputs ( ) const
virtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::ModelObject.

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

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 62 of file GaussianRestraint.h.


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