Dummy restraint between two particles. More...
#include <IMP/em2d/DummyRestraint.h>
Inheritance diagram for IMP::em2d::DummyRestraint:Public Member Functions | |
| DummyRestraint (IMP::Particle *p, IMP::Particle *q) | |
| virtual void | do_show (std::ostream &out) const |
| void | show (std::ostream &out=std::cout) 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) |
Related Functions | |
(Note that these are not member functions.) | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < DummyRestraint > > | DummyRestraintsTemp |
| Related Functions inherited from IMP::kernel::Restraint | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Restraint > > | RestraintsTemp |
| Related Functions inherited from IMP::kernel::ModelObject | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < ModelObject > > | ModelObjectsTemp |
| Related Functions inherited from IMP::base::Object | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Object > > | ObjectsTemp |
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
The restraint does do anything and returns 0 as a value. Use this restraint to force two particles to be considered by DOMINO as belonging to a restraint. This trick can be useful when building the merge tree for DOMINO, as can add branches that consider pairs of particles before entire subsets. NOTE: Using this restraint for DOMINO requires a fairly good knowledge of the works of merge trees.
Definition at line 37 of file DummyRestraint.h.
Constructor & Destructor Documentation
| IMP::em2d::DummyRestraint::DummyRestraint | ( | IMP::Particle * | p, |
| IMP::Particle * | q | ||
| ) |
Inits the dummy restraint between the particles
- Parameters
-
p First particle q Second particle
Definition at line 48 of file DummyRestraint.h.
Member Function Documentation
| void IMP::em2d::DummyRestraint::show | ( | std::ostream & | out = std::cout | ) | const |
Shows information about the class
- Parameters
-
out Stream used to show the information
Definition at line 57 of file DummyRestraint.h.
Friends And Related Function Documentation
|
related |
Pass a set of objects.
Definition at line 64 of file DummyRestraint.h.
The documentation for this class was generated from the following file: