IMP  2.0.0
The Integrative Modeling Platform
IMP::core::DistanceRestraint Class Reference

Distance restraint between two particles. More...

#include <IMP/core/DistanceRestraint.h>

+ Inheritance diagram for IMP::core::DistanceRestraint:

Public Member Functions

 DistanceRestraint (UnaryFunction *score_func, Particle *a, Particle *b)
 Create the distance restraint. More...
 
- Public Member Functions inherited from IMP::kernel::Restraint
 Restraint (Model *m, std::string name)
 
void add_score_and_derivatives (ScoreAccumulator sa) const
 
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
 
ContainersTemp get_input_containers () const
 
ParticlesTemp get_input_particles () const
 
virtual double get_last_score () const
 
double get_score () 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::kernel::ModelObject
 ModelObject (Model *m, std::string name)
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
 
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::kernel::Restraint
virtual void do_add_score_and_derivatives (ScoreAccumulator sa) const
 
virtual Restraints do_create_current_decomposition () const
 
virtual Restraints do_create_decomposition () const
 
ModelObjectsTemp do_get_outputs () const
 
virtual void do_update_dependencies ()
 

Detailed Description

Note
If the particles are closer than a certain distance, then the contributions to the derivatives are set to 0.
See Also
PairRestraint
DistancePairScore
SphereDistancePairScore

Definition at line 32 of file DistanceRestraint.h.

Constructor & Destructor Documentation

IMP::core::DistanceRestraint::DistanceRestraint ( UnaryFunction score_func,
Particle a,
Particle b 
)
Parameters
[in]score_funcScoring function for the restraint.
[in]aPointer to first particle in distance restraint.
[in]bPointer to second particle in distance restraint.

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