IMP logo
IMP Reference Guide  2.20.0
The Integrative Modeling Platform
IMP::core::BoxSweepClosePairsFinder Class Reference

Find all nearby pairs by sweeping the bounding boxes. More...

#include <IMP/core/BoxSweepClosePairsFinder.h>

+ Inheritance diagram for IMP::core::BoxSweepClosePairsFinder:

Detailed Description

Find all nearby pairs by sweeping the bounding boxes.

This method is much faster than the quadratic one when there are are large sets of points.

The class BoxSweepClosePairsFinder requires CGAL in order to function.

See Also
IMP::container::ClosePairsScoreState

Definition at line 24 of file BoxSweepClosePairsFinder.h.

Public Member Functions

virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const override
 Overload this method to specify the inputs. More...
 
virtual IntPairs get_close_pairs (const algebra::BoundingBox3Ds &bbs) const override
 
virtual IntPairs get_close_pairs (const algebra::BoundingBox3Ds &bas, const algebra::BoundingBox3Ds &bbs) const override
 
virtual ParticleIndexPairs get_close_pairs (Model *m, const ParticleIndexes &pc) const override
 return all close pairs among pc in model m More...
 
virtual ParticleIndexPairs get_close_pairs (Model *m, const ParticleIndexes &pca, const ParticleIndexes &pcb) const override
 return all close pairs among pc in model m More...
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
- Public Member Functions inherited from IMP::core::ClosePairsFinder
 ClosePairsFinder (std::string name)
 
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 erase_pair_filter (unsigned int i)
 
void reserve_pair_filters (unsigned int sz)
 
virtual void set_distance (double d)
 
double get_distance () const
 
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::Object
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

- Public Attributes inherited from IMP::core::ClosePairsFinder
list pair_filters
 A Python list of PairFilters More...
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual ModelObjectsTemp IMP::core::BoxSweepClosePairsFinder::do_get_inputs ( Model m,
const ParticleIndexes pis 
) const
overridevirtual

Overload this method to specify the inputs.

Implements IMP::ParticleInputs.

virtual ParticleIndexPairs IMP::core::BoxSweepClosePairsFinder::get_close_pairs ( Model m,
const ParticleIndexes pc 
) const
overridevirtual

return all close pairs among pc in model m

Implements IMP::core::ClosePairsFinder.

virtual ParticleIndexPairs IMP::core::BoxSweepClosePairsFinder::get_close_pairs ( Model m,
const ParticleIndexes pca,
const ParticleIndexes pcb 
) const
overridevirtual

return all close pairs among pc in model m

Implements IMP::core::ClosePairsFinder.

virtual ::IMP::VersionInfo IMP::core::BoxSweepClosePairsFinder::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 40 of file BoxSweepClosePairsFinder.h.


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