IMP logo
IMP Reference Guide  2.8.0
The Integrative Modeling Platform
Edit on GitHub version 2.8.0
QuadraticClosePairsFinder.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/QuadraticClosePairsFinder.h
3  * \brief Test all pairs of particles to find close pairs.
4  *
5  * Copyright 2007-2017 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPCORE_QUADRATIC_CLOSE_PAIRS_FINDER_H
9 #define IMPCORE_QUADRATIC_CLOSE_PAIRS_FINDER_H
10 
11 #include "ClosePairsFinder.h"
12 #include <IMP/core/core_config.h>
13 
14 IMPCORE_BEGIN_NAMESPACE
15 
16 //! Find all nearby pairs by testing all pairs
17 /** \see ClosePairsScoreState
18  */
19 class IMPCOREEXPORT QuadraticClosePairsFinder : public ClosePairsFinder {
20  public:
21  QuadraticClosePairsFinder();
22  bool get_are_close(Particle *a, Particle *b) const {
23  return get_are_close(a->get_model(), a->get_index(), b->get_index());
24  }
25  bool get_are_close(Model *m, ParticleIndex a,
26  ParticleIndex b) const;
27  virtual IntPairs get_close_pairs(const algebra::BoundingBox3Ds &bbs) const
28  IMP_OVERRIDE;
29  virtual IntPairs get_close_pairs(const algebra::BoundingBox3Ds &bas,
30  const algebra::BoundingBox3Ds &bbs) const
31  IMP_OVERRIDE;
32  virtual ParticleIndexPairs get_close_pairs(
33  Model *m, const ParticleIndexes &pc) const IMP_OVERRIDE;
34  virtual ParticleIndexPairs get_close_pairs(
35  Model *m, const ParticleIndexes &pca,
36  const ParticleIndexes &pcb) const IMP_OVERRIDE;
37  virtual ModelObjectsTemp do_get_inputs(
38  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
39 
40  IMP_OBJECT_METHODS(QuadraticClosePairsFinder);
41 };
42 
43 IMPCORE_END_NAMESPACE
44 
45 #endif /* IMPCORE_QUADRATIC_CLOSE_PAIRS_FINDER_H */
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::Particle
Class to handle individual particles of a Model object.
Definition: Particle.h:41
ClosePairsFinder.h
A base class for algorithms to detect proximities.
IMP::Particle::get_index
ParticleIndex get_index() const
returns the particle index of this particle in its model
IMP::core::QuadraticClosePairsFinder
Find all nearby pairs by testing all pairs.
Definition: QuadraticClosePairsFinder.h:19
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:80