 |
|
IMP Reference Guide
develop.169ea894ba,2025/11/01
The Integrative Modeling Platform
|
A shared container for Pairs. More...
#include <IMP/PairContainer.h>
Inheritance diagram for IMP::PairContainer:A shared container for Pairs.
Stores a shared collection of Pairs.
Definition at line 39 of file PairContainer.h.
Public Types | |
| typedef ParticleIndexPair | ContainedIndexType |
| typedef ParticleIndexPairs | ContainedIndexTypes |
| typedef ParticlePair | ContainedType |
| typedef ParticlePairsTemp | ContainedTypes |
| typedef PairModifier | Modifier |
| typedef const ParticleIndexPair & | PassContainedIndexType |
Public Member Functions | |
| void | apply (const PairModifier *sm) const |
| Apply a PairModifier to the contents. More... | |
| void | apply_generic (const PairModifier *m) const |
| Just use apply() in the base class. More... | |
| void | apply_generic_moved (const PairModifier *m, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| Just use apply_moved() in the base class. More... | |
| void | apply_moved (const PairModifier *sm, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| Apply a PairModifier to the contents. More... | |
| const ParticleIndexPairs & | get_contents () const |
| virtual ParticleIndexPairs | get_indexes () const =0 |
| virtual ParticleIndexPairs | get_range_indexes () const =0 |
| Public Member Functions inherited from IMP::Container | |
| ModelObjectsTemp | do_get_outputs () const override |
| containers don't have outputs More... | |
| virtual ParticleIndexes | get_all_possible_indexes () const =0 |
| Get contained particles. More... | |
| std::size_t | get_contents_hash () const |
| virtual bool | get_is_decomposable () const |
| 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 |
| def | get_derived_object |
| Return this object cast to the most derived subclass. More... | |
| LogLevel | get_log_level () const |
| virtual VersionInfo | get_version_info () const |
| Get information about the module and version of the object. More... | |
| 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) |
| virtual std::string | get_type_name () const |
Protected Member Functions | |
| PairContainer (Model *m, std::string name="PairContainer %1%") | |
| virtual void | do_apply (const PairModifier *sm) const =0 |
| virtual void | do_apply_moved (const PairModifier *sm, const ParticleIndexes &moved_pis, const ParticleIndexes &reset_pis) const |
| virtual bool | do_get_provides_access () const |
| Protected Member Functions inherited from IMP::Container | |
| Container (Model *m, std::string name="Container %1%") | |
| virtual std::size_t | do_get_contents_hash () const =0 |
| Protected Member Functions inherited from IMP::ModelObject | |
| virtual ModelObjectsTemp | do_get_inputs () const =0 |
| 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 () |
| void IMP::PairContainer::apply | ( | const PairModifier * | sm | ) | const |
Apply a PairModifier to the contents.
| void IMP::PairContainer::apply_generic | ( | const PairModifier * | m | ) | const |
Just use apply() in the base class.
| void IMP::PairContainer::apply_generic_moved | ( | const PairModifier * | m, |
| const ParticleIndexes & | moved_pis, | ||
| const ParticleIndexes & | reset_pis | ||
| ) | const |
Just use apply_moved() in the base class.
| void IMP::PairContainer::apply_moved | ( | const PairModifier * | sm, |
| const ParticleIndexes & | moved_pis, | ||
| const ParticleIndexes & | reset_pis | ||
| ) | const |
Apply a PairModifier to the contents.
|
pure virtual |
Get all the indexes contained in the container.
This should be protected but isn't for compatibility reasons.
External callers should use get_contents().
Implemented in IMP::container::ExclusiveConsecutivePairContainer, IMP::container::ClosePairContainer, IMP::container::CloseBipartitePairContainer, IMP::container::ConsecutivePairContainer, IMP::container::ConnectingPairContainer, IMP::container::AllBipartitePairContainer, IMP::atom::BondPairContainer, and IMP::container::AllPairContainer.
|
pure virtual |
Get all the indexes that might possibly be contained in the container, useful with dynamic containers. For example, with a container::ClosePairContainer, this is the list of all pairs taken from the input list (those that are far apart in addition to those that are close).
Implemented in IMP::container::ExclusiveConsecutivePairContainer, IMP::container::ClosePairContainer, IMP::container::CloseBipartitePairContainer, IMP::container::ConsecutivePairContainer, IMP::container::ConnectingPairContainer, IMP::container::AllBipartitePairContainer, IMP::atom::BondPairContainer, and IMP::container::AllPairContainer.