IMP Reference Guide
develop.31f669fd3e,2025/02/08
The Integrative Modeling Platform
|
Return a unique predicate value for each ordered set of ParticleTypes. More...
#include <IMP/core/pair_predicates.h>
Return a unique predicate value for each ordered set of ParticleTypes.
When applied to a set of particles that are decorated with the Typed decorator, this returns a value that is a function of all of the types. The order of the particles matters.
Definition at line 89 of file pair_predicates.h.
Public Member Functions | |
OrderedTypePairPredicate (std::string name="OrderedTypePairPredicate%1%") | |
virtual ModelObjectsTemp | do_get_inputs (Model *m, const ParticleIndexes &pis) const override |
Overload this method to specify the inputs. More... | |
virtual std::string | get_type_name () const override |
int | get_value (const core::ParticleTypes &types) |
Compute the predicate for specified types. More... | |
Ints | get_value (const ParticlePairsTemp &o) const |
int | get_value (const ParticlePair &a) const |
virtual int | get_value_index (Model *m, const ParticleIndexPair &pi) const override |
Compute the predicate for types of specific pi. More... | |
Ints | get_value_index (Model *m, const ParticleIndexPairs &o) const override |
virtual int | get_value_index_in_batch (Model *m, const ParticleIndexPair &pi) const override |
virtual ::IMP::VersionInfo | get_version_info () const override |
Get information about the module and version of the object. More... | |
virtual void | setup_for_get_value_index_in_batch (Model *m) const override |
![]() | |
PairPredicate (std::string name="PairPredicate %1%") | |
int | operator() (Model *m, const ParticleIndexPair &vt) const |
Enable them to be use as functors. More... | |
![]() | |
ModelObjectsTemp | get_inputs (Model *m, const ParticleIndexes &pis) const |
Get the ModelObjects read when the given list of particles is used. More... | |
![]() | |
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 | |
![]() | |
typedef ParticlePair | Argument |
typedef ParticleIndexPair | IndexArgument |
![]() | |
Object (std::string name) | |
Construct an object with the given name. More... | |
virtual void | do_destroy () |
|
overridevirtual |
Overload this method to specify the inputs.
Implements IMP::ParticleInputs.
Definition at line 126 of file pair_predicates.h.
int IMP::core::OrderedTypePairPredicate::get_value | ( | const core::ParticleTypes & | types | ) |
Compute the predicate for specified types.
Definition at line 97 of file pair_predicates.h.
|
overridevirtual |
Compute the predicate for types of specific pi.
Implements IMP::PairPredicate.
Definition at line 101 of file pair_predicates.h.
|
overridevirtual |
Same as get_value_index, but with optimizations for a batch of calls. Call setup_for_get_value_index_in_batch() right before calling a batch of those, otherwise unexpected behavior.
Reimplemented from IMP::PairPredicate.
Definition at line 118 of file pair_predicates.h.
|
overridevirtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 133 of file pair_predicates.h.
|
overridevirtual |
Setup for a batch of calls to get_value_index_in_batch() (used for improving performance)
Reimplemented from IMP::PairPredicate.
Definition at line 108 of file pair_predicates.h.