IMP logo
Public Member Functions
IMP::container::CloseBipartitePairContainer Class Reference

Detailed Description

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

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.

Examples: bipartite nonbonded interactions, dock with crosslinks

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

List of all members.

Public Member Functions

 CloseBipartitePairContainer (SingletonContainerInput a, SingletonContainerInput b, double distance, double slack=1)
 Get the individual particles from the passed SingletonContainer.
 IMP_IMPLEMENT_PAIR_CONTAINER (CloseBipartitePairContainer)
- Public Member Functions inherited from IMP::PairContainer
virtual void apply (const PairModifier *sm) const =0
 Apply a SingletonModifier to the contents.
virtual void apply (const PairDerivativeModifier *sm, DerivativeAccumulator &da) const =0
 Apply a SingletonModifier to the contents.
virtual double evaluate (const PairScore *s, DerivativeAccumulator *da) const =0
 Evaluate a score on the contents.
virtual double evaluate_if_good (const PairScore *s, DerivativeAccumulator *da, double max) const =0
 Evaluate a score on the contents.
virtual bool get_contains_particle_pair (const ParticlePair &v) const =0
virtual unsigned int get_number_of_particle_pairs () const
 return the number of Pairs in the container
virtual ParticlePair get_particle_pair (unsigned int i) const
ParticlePairsTemp get_particle_pairs () const
- Public Member Functions inherited from IMP::Container
virtual void do_after_evaluate (DerivativeAccumulator *accpt)
 Reset changed status.
virtual ParticlesTemp get_all_possible_particles () const =0
 Get contained particles.
virtual ParticlesTemp get_input_particles () const
 Return get_all_possible_particles()
virtual bool get_is_changed () const
virtual bool get_is_decomposable () const
virtual ContainersTemp get_output_containers () const
 Containers don't have output.
virtual ParticlesTemp get_output_particles () const
 Containers don't have output.
- Public Member Functions inherited from IMP::Constraint
 Constraint (Model *m, std::string name="Constraint %1%")
- Public Member Functions inherited from IMP::ScoreState
 ScoreState (Model *m, std::string name="ScoreState %1%")
void after_evaluate (DerivativeAccumulator *accpt)
void before_evaluate ()
virtual ContainersTemp get_input_containers () const =0
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
ModelObjectsTemp get_inputs () const
Modelget_model () const
ModelObjectsTemp get_outputs () const
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
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.
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)
template<class F >
void remove_pair_filters_if (const F &f)
template<class List >
void remove_pair_filters (List d)
template<class List >
void set_pair_filters (List ps)
template<class List >
void set_pair_filters_order (List ps)
unsigned int add_pair_filter (PairPredicate *obj)
template<class List >
void add_pair_filters (List objs)
void clear_pair_filters ()
unsigned int get_number_of_pair_filters () const
bool get_has_pair_filters () const
PairPredicateget_pair_filter (unsigned int i) const
PairPredicates get_pair_filters () const
void reserve_pair_filters (unsigned int sz)
PairPredicateIterator pair_filters_begin ()
PairPredicateIterator pair_filters_end ()
PairPredicateConstIterator pair_filters_begin () const
PairPredicateConstIterator pair_filters_end () const

Additional Inherited Members

- Public Types inherited from IMP::PairContainer
typedef ParticleIndexPair ContainedIndexType
typedef ParticleIndexPairs ContainedIndexTypes
typedef ParticlePair ContainedType
typedef ParticlePairsTemp ContainedTypes
- Protected Member Functions inherited from IMP::PairContainer
 PairContainer (Model *m, std::string name="PairContainer %1%")
- Protected Member Functions inherited from IMP::Container
 Container (Model *m, std::string name="Container %1%")
void set_is_changed (bool tf)
 This will be reset at the end of evaluate.

Constructor & Destructor Documentation

IMP::container::CloseBipartitePairContainer::CloseBipartitePairContainer ( SingletonContainerInput  a,
SingletonContainerInput  b,
double  distance,
double  slack = 1 
)

Get the individual particles from the passed SingletonContainer.


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

Generated on Tue May 22 2012 23:33:28 for IMP by doxygen 1.8.1