IMP  2.0.0
The Integrative Modeling Platform
IMP::container::CloseBipartitePairContainer Class Reference

Return all close ordered pairs of particles taken from the two SingletonContainers. More...

#include <IMP/container/CloseBipartitePairContainer.h>

+ Inheritance diagram for IMP::container::CloseBipartitePairContainer:

Public Member Functions

 CloseBipartitePairContainer (SingletonContainerAdaptor a, SingletonContainerAdaptor b, double distance, double slack=1)
 Get the individual particles from the passed SingletonContainer.
 
 IMP_PAIR_CONTAINER (CloseBipartitePairContainer)
 
- 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...
 
virtual ParticleIndexPairs get_indexes () const =0
 
unsigned int get_number_of_particle_pairs () const
 
ParticlePair get_particle_pair (unsigned int i) const
 
ParticlePairsTemp get_particle_pairs () const
 
virtual ParticleIndexPairs get_range_indexes () const =0
 
- 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
 
virtual ParticleIndexes get_all_possible_indexes () const =0
 Get contained particles. More...
 
ParticlesTemp get_all_possible_particles () const
 
bool get_is_changed () const
 
virtual bool get_is_decomposable () const
 
- Public Member Functions inherited from IMP::kernel::ScoreState
 ScoreState (Model *m, 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 (Model *m, std::string name)
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_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)
 

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.

void remove_pair_filter (PairPredicate *d)
 
void remove_pair_filters (const PairPredicates &d)
 
void set_pair_filters (const PairPredicates &ps)
 
void set_pair_filters_order (const PairPredicates &objs)
 
unsigned int add_pair_filter (PairPredicate *obj)
 
void add_pair_filters (const PairPredicates &objs)
 
void clear_pair_filters ()
 
unsigned int get_number_of_pair_filters () const
 
bool get_has_pair_filters ()
 
PairPredicateget_pair_filter (unsigned int i) const
 
PairPredicates get_pair_filters () const
 
void reserve_pair_filters (unsigned int sz)
 

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 (Model *m, std::string name="PairContainer %1%")
 
virtual void do_apply (const PairModifier *sm) const =0
 
virtual bool do_get_provides_access () const
 

Detailed Description

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.

Note
The maintenance of the invariant is done by an associated IMP::Constraint. As a result, the state is only guaranteed to be correct either during model evaluation, or immediately following model evaluation before any particles have been changed.

Definition at line 34 of file CloseBipartitePairContainer.h.


The documentation for this class was generated from the following file: