 |
|
IMP Reference Guide
2.20.1
The Integrative Modeling Platform
|
Applies a SingletonScore to each Singleton in a list based on a predicate. More...
#include <IMP/container/PredicateSingletonsRestraint.h>
Inheritance diagram for IMP::container::PredicateSingletonsRestraint:Applies a SingletonScore to each Singleton in a list based on a predicate.
This restraint uses a passed predicate to choose which score to apply to each tuple in the input container. The selections are cached, making it substantially faster than using a core::TypedPairScore.
Definition at line 51 of file PredicateSingletonsRestraint.h.
Public Member Functions | |
| PredicateSingletonsRestraint (SingletonPredicate *pred, SingletonContainerAdaptor input, std::string name="PredicateSingletonsRestraint %1%") | |
| void | do_add_score_and_derivatives (IMP::ScoreAccumulator sa) const override |
| IMP::ModelObjectsTemp | do_get_inputs () const override |
| ParticleIndexes | get_indexes (int predicate_value) const |
| 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... | |
| void | set_is_complete (bool tf) |
| void | set_is_get_inputs_ignores_individual_scores (bool is_ignore) |
| void | set_score (int predicate_value, SingletonScore *score) |
| void | set_unknown_score (SingletonScore *score) |
| Public Member Functions inherited from IMP::Restraint | |
| Restraint (Model *m, std::string name) | |
| Create a restraint and register it with the model. More... | |
| Restraint () | |
| Default constructor. More... | |
| 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 |
| Create a scoring function with only this restraint. More... | |
| virtual RestraintInfo * | get_dynamic_info () const |
| bool | get_is_aggregate () const |
| Return whether this restraint wraps a number of other restraints. More... | |
| double | get_last_last_score () const |
| Get the unweighted score from the last-but-one time it was evaluated. More... | |
| virtual double | get_last_score () const |
| double | get_score () const |
| virtual RestraintInfo * | get_static_info () const |
| bool | get_was_good () const |
| double | evaluate (bool calc_derivs) const |
| double | evaluate_moved (bool calc_derivs, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| double | evaluate_moved_if_below (bool calc_derivatives, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis, double max) const |
| double | evaluate_moved_if_good (bool calc_derivatives, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| double | evaluate_if_good (bool calc_derivatives) const |
| double | evaluate_if_below (bool calc_derivatives, double max) const |
| virtual double | unprotected_evaluate (DerivativeAccumulator *da) const |
| Return the unweighted score for the restraint. More... | |
| virtual double | unprotected_evaluate_moved (DerivativeAccumulator *da, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| Return the unweighted score, taking moving particles into account. More... | |
| virtual double | unprotected_evaluate_if_good (DerivativeAccumulator *da, double max) const |
| virtual double | unprotected_evaluate_if_below (DerivativeAccumulator *da, double max) const |
| The function calling this will treat any score >= max as bad. More... | |
| virtual double | unprotected_evaluate_moved_if_below (DerivativeAccumulator *da, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis, double max) const |
| virtual double | unprotected_evaluate_moved_if_good (DerivativeAccumulator *da, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis, double max) 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... | |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| const ScoreStatesTemp & | get_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_moved (ScoreAccumulator sa, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| virtual Restraints | do_create_decomposition () const |
| ModelObjectsTemp | do_get_outputs () const override |
| 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 () |
| Protected Attributes inherited from IMP::Restraint | |
| bool | is_aggregate_ |
|
overridevirtual |
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.
| ParticleIndexes IMP::container::PredicateSingletonsRestraint::get_indexes | ( | int | predicate_value | ) | const |
return the indexes of all particles for a given predicate value.
Definition at line 113 of file PredicateSingletonsRestraint.h.
|
overridevirtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 130 of file PredicateSingletonsRestraint.h.
| void IMP::container::PredicateSingletonsRestraint::set_is_complete | ( | bool | tf | ) |
By default, it is an error if the predicate returns a value that is not known. If this is false, then they are silently skipped even if set_unknown_score() was not called.
Definition at line 110 of file PredicateSingletonsRestraint.h.
| void IMP::container::PredicateSingletonsRestraint::set_is_get_inputs_ignores_individual_scores | ( | bool | is_ignore | ) |
use at own risk - for efficiency in case e.g. all scores use same inputs If true, do_get_inputs() includes all inputs in input container but not individual inputs from individual scores
Definition at line 126 of file PredicateSingletonsRestraint.h.
| void IMP::container::PredicateSingletonsRestraint::set_score | ( | int | predicate_value, |
| SingletonScore * | score | ||
| ) |
Apply the passed score to all pairs whose predicate values match the passed value.
| void IMP::container::PredicateSingletonsRestraint::set_unknown_score | ( | SingletonScore * | score | ) |
Apply this score to any pair whose predicate value does not match one passed to set_score().