IMP::core::DiameterRestraint Class Reference
Restrain the diameter of a set of points. More...
#include <IMP/core/DiameterRestraint.h>
Inheritance diagram for IMP::core::DiameterRestraint:Public Member Functions | |
| DiameterRestraint (UnaryFunction *f, SingletonContainer *sc, Float diameter) | |
| Use f to restraint sc to be withing diameter of one another. More... | |
| virtual void | do_show (std::ostream &out) const |
| Public Member Functions inherited from IMP::kernel::Restraint | |
| Restraint (Model *m, std::string name) | |
| void | add_score_and_derivatives (ScoreAccumulator sa) const |
| Restraint * | create_current_decomposition () const |
| Decompose this restraint into constituent terms for the current conf. More... | |
| Restraint * | create_decomposition () const |
| Decompose this restraint into constituent terms. More... | |
| virtual ScoringFunction * | create_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 |
| Model * | get_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 () |
| Related Functions inherited from IMP::kernel::Restraint | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Restraint > > | RestraintsTemp |
Detailed Description
This class also serves as an example of how to build restraints which have internal ScoreStates and perhaps more than one actual restraint object.
The diameter scored includes the radius of the involved particles.
- Note
- , Currently, decomposing this restraint results in pieces which score deviations from the diameter with a harmonic upper bound of strength 1.
Definition at line 33 of file DiameterRestraint.h.
Constructor & Destructor Documentation
| IMP::core::DiameterRestraint::DiameterRestraint | ( | UnaryFunction * | f, |
| SingletonContainer * | sc, | ||
| Float | diameter | ||
| ) |
f should have a minimum at 0 and be an upper bound-style function.
The documentation for this class was generated from the following file: