IMP
2.1.0
The Integrative Modeling Platform
|
Return all close ordered pairs of particles taken from the two SingletonContainers. More...
#include <IMP/container/CloseBipartitePairContainer.h>
Public Member Functions | |
CloseBipartitePairContainer (SingletonContainerAdaptor a, SingletonContainerAdaptor b, double distance, double slack=1, std::string name="CloseBipartitePairContainer%1%") | |
Get the individual particles from the passed SingletonContainer. | |
void | do_apply (const PairModifier *sm) const |
void | do_before_evaluate () |
kernel::ModelObjectsTemp | do_get_inputs () const |
kernel::ParticleIndexes | get_all_possible_indexes () const |
Get contained particles. More... | |
kernel::ParticleIndexPairs | get_indexes () const |
kernel::ParticleIndexPairs | get_range_indexes () const |
virtual std::string | get_type_name () const |
virtual ::IMP::base::VersionInfo | get_version_info () const |
Get information about the module and version of the object. | |
Public Member Functions inherited from IMP::kernel::PairContainer | |
void | apply (const PairModifier *sm) const |
Apply a SingletonModifier to the contents. | |
void | apply_generic (const PairModifier *m) const |
Just use apply() in the base class. | |
bool | get_contains_particle_pair (ParticlePair v) const |
This function is very slow and you should think hard about using it. More... | |
unsigned int | get_number_of_particle_pairs () const |
ParticlePair | get_particle_pair (unsigned int i) const |
ParticlePairsTemp | get_particle_pairs () const |
Public Member Functions inherited from IMP::kernel::Container | |
virtual void | do_after_evaluate (DerivativeAccumulator *accpt) |
Reset changed status. | |
ModelObjectsTemp | do_get_outputs () const |
containers don't have outputs | |
ParticlesTemp | get_all_possible_particles () const |
int | get_contents_version () const |
bool | get_is_changed () const |
virtual bool | get_is_decomposable () const |
Public Member Functions inherited from IMP::kernel::ScoreState | |
ScoreState (kernel::Model *m, std::string name) | |
ScoreState (kernel::Model *m) | |
ScoreState (std::string name="ScoreState %1%") | |
void | after_evaluate (DerivativeAccumulator *accpt) |
Do post evaluation work if needed. | |
void | before_evaluate () |
Force update of the structure. | |
ContainersTemp | get_input_containers () const |
ParticlesTemp | get_input_particles () const |
ContainersTemp | get_output_containers () const |
ParticlesTemp | get_output_particles () const |
Public Member Functions inherited from IMP::kernel::ModelObject | |
ModelObject (kernel::Model *m, std::string name) | |
ModelObject (std::string name) | |
virtual void | do_set_model (kernel::Model *) |
bool | get_has_dependencies () const |
Return whether this object has dependencies computed. | |
bool | get_has_required_score_states () const |
ModelObjectsTemp | get_inputs () const |
ModelObjectsTemps | get_interactions () const |
bool | get_is_part_of_model () const |
Model * | get_model () const |
ModelObjectsTemp | get_outputs () const |
const ScoreStatesTemp & | get_required_score_states () const |
void | set_has_dependencies (bool tf) |
void | set_has_required_score_states (bool tf) |
virtual void | set_model (kernel::Model *m) |
Public Member Functions inherited from IMP::base::Object | |
virtual void | clear_caches () |
virtual void | do_destroy () |
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) |
Methods to control the set of filters | |
PairPredicate objects can be used as filters to prevent the addition of pairs to the containeroutput list. Pairs for which the predicates evaluate to a non-zero value are excluded from the list. | |
IMP_LIST_ACTION (public, PairPredicate, PairPredicates, pair_filter, pair_filters, PairPredicate *, PairPredicates, obj->set_was_used(true);,,) | |
Additional Inherited Members | |
Public Types inherited from IMP::kernel::PairContainer | |
typedef ParticleIndexPair | ContainedIndexType |
typedef ParticleIndexPairs | ContainedIndexTypes |
typedef ParticlePair | ContainedType |
typedef ParticlePairsTemp | ContainedTypes |
Protected Member Functions inherited from IMP::kernel::PairContainer | |
PairContainer (kernel::Model *m, std::string name="PairContainer %1%") | |
virtual bool | do_get_provides_access () const |
Protected Member Functions inherited from IMP::kernel::Container | |
Container (kernel::Model *m, std::string name="Container %1%") | |
void | set_is_changed (bool tf) |
Call this with true when the contents of the container change. More... | |
Protected Member Functions inherited from IMP::kernel::ModelObject | |
virtual ModelObjectsTemps | do_get_interactions () const |
virtual void | handle_set_has_required_score_states (bool) |
Protected Member Functions inherited from IMP::base::Object | |
Object (std::string name) | |
Construct an object with the given name. More... | |
Object () | |
See ClosePairContainer for a more detailed description. This container lists all close pairs of particles where one particle is taken from each of the input sets.
See also AllPairContainer, ClosePairContainer, AllBipartitePairContainer for variants on the functionality provided.
Definition at line 35 of file CloseBipartitePairContainer.h.
|
virtual |
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::kernel::ModelObject.
|
virtual |
Get a list of all particles contained in this one, given that the input containers are up to date.
Implements IMP::kernel::Container.
|
virtual |
Get all the indexes contained in the container.
Implements IMP::kernel::PairContainer.
|
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 input list (those that are far apart in addition to those that are close).
Implements IMP::kernel::PairContainer.