IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
BoxSweepClosePairsFinder.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/BoxSweepClosePairsFinder.h
3  * \brief Test all pairs of particles to find close pairs.
4  *
5  * Copyright 2007-2021 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_BOX_SWEEP_CLOSE_PAIRS_FINDER_H
9 #define IMPCORE_BOX_SWEEP_CLOSE_PAIRS_FINDER_H
10 
11 #include <IMP/core/core_config.h>
12 #include "ClosePairsFinder.h"
13 
14 IMPCORE_BEGIN_NAMESPACE
15 
16 #if defined(IMP_DOXYGEN) || defined(IMP_CORE_USE_IMP_CGAL)
17 //! Find all nearby pairs by sweeping the bounding boxes
18 /** This method is much faster than the quadratic one when
19  there are are large sets of points.
20 
21  \requires{class BoxSweepClosePairsFinder, CGAL}
22  \see IMP::container::ClosePairsScoreState
23 */
24 class IMPCOREEXPORT BoxSweepClosePairsFinder : public ClosePairsFinder {
25  public:
27 
28  virtual IntPairs get_close_pairs(const algebra::BoundingBox3Ds &bbs) const
31  const algebra::BoundingBox3Ds &bbs) const
34  Model *m, const ParticleIndexes &pc) const IMP_OVERRIDE;
36  Model *m, const ParticleIndexes &pca,
37  const ParticleIndexes &pcb) const IMP_OVERRIDE;
39  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
41 };
42 #endif /* IMP_USE_CGAL */
43 
44 IMPCORE_END_NAMESPACE
45 
46 #endif /* IMPCORE_BOX_SWEEP_CLOSE_PAIRS_FINDER_H */
A base class for algorithms to find spatial proximities.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
virtual ParticleIndexPairs get_close_pairs(Model *m, const ParticleIndexes &pc) const =0
return all close pairs among pc in model m
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:73
Find all nearby pairs by sweeping the bounding boxes.
virtual ModelObjectsTemp do_get_inputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the inputs.
A base class for algorithms to detect proximities.
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.