IMP logo
IMP Reference Guide  2.15.0
The Integrative Modeling Platform
version 2.15.0
GridClosePairsFinder.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/GridClosePairsFinder.h
3  * \brief Use a hierarchy of grids to find close pairs.
4  *
5  * Copyright 2007-2021 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_GRID_CLOSE_PAIRS_FINDER_H
9 #define IMPCORE_GRID_CLOSE_PAIRS_FINDER_H
10 
11 #include "ClosePairsFinder.h"
12 #include <IMP/object_macros.h>
13 #include <IMP/core/core_config.h>
14 
15 IMPCORE_BEGIN_NAMESPACE
16 
17 //! Find all nearby pairs by testing all pairs
18 /**
19  \see ClosePairsScoreState
20  */
21 class IMPCOREEXPORT GridClosePairsFinder : public ClosePairsFinder {
22  public:
23  GridClosePairsFinder();
24  virtual IntPairs get_close_pairs(const algebra::BoundingBox3Ds &bbs) const
25  IMP_OVERRIDE;
26  virtual IntPairs get_close_pairs(const algebra::BoundingBox3Ds &bas,
27  const algebra::BoundingBox3Ds &bbs) const
28  IMP_OVERRIDE;
29  virtual ParticleIndexPairs get_close_pairs(
30  Model *m, const ParticleIndexes &pc) const IMP_OVERRIDE;
31  virtual ParticleIndexPairs get_close_pairs(
32  Model *m, const ParticleIndexes &pca,
33  const ParticleIndexes &pcb) const IMP_OVERRIDE;
34  virtual ModelObjectsTemp do_get_inputs(
35  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
36 
37  IMP_OBJECT_METHODS(GridClosePairsFinder);
38 };
39 
40 IMPCORE_END_NAMESPACE
41 
42 #endif /* IMPCORE_GRID_CLOSE_PAIRS_FINDER_H */
object_macros.h
Helper macros for implementing IMP Objects.
IMP::core::ClosePairsFinder
A base class for algorithms to find spatial proximities.
Definition: ClosePairsFinder.h:35
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::core::ClosePairsFinder::get_close_pairs
virtual ParticleIndexPairs get_close_pairs(Model *m, const ParticleIndexes &pc) const =0
return all close pairs among pc in model m
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
IMP::ParticleInputs::do_get_inputs
virtual ModelObjectsTemp do_get_inputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the inputs.
IMP::core::GridClosePairsFinder
Find all nearby pairs by testing all pairs.
Definition: GridClosePairsFinder.h:21
ClosePairsFinder.h
A base class for algorithms to detect proximities.
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78