IMP logo
IMP Reference Guide  2.10.1
The Integrative Modeling Platform
Edit on GitHub version 2.10.1
SameResiduePairFilter.h
Go to the documentation of this file.
1 /**
2  * \file IMP/atom/SameResiduePairFilter.h
3  * \brief A Score on the distance between a pair of particles.
4  *
5  * Copyright 2007-2018 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPATOM_SAME_RESIDUE_PAIR_FILTER_H
9 #define IMPATOM_SAME_RESIDUE_PAIR_FILTER_H
10 
11 #include <IMP/atom/atom_config.h>
12 #include <IMP/PairPredicate.h>
13 #include <IMP/pair_macros.h>
14 
15 IMPATOM_BEGIN_NAMESPACE
16 
17 //!
18 /** Predicate atoms that belong to the same residue. The is designed
19  for use with the DopePairScore. All particles passed to it must
20  be Atom particles. This can change if desired.
21 */
22 class IMPATOMEXPORT SameResiduePairFilter : public PairPredicate {
23  public:
24  SameResiduePairFilter();
25  virtual int get_value_index(Model *m,
26  const ParticleIndexPair &p) const
27  IMP_OVERRIDE;
28  virtual ModelObjectsTemp do_get_inputs(
29  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
30  IMP_PAIR_PREDICATE_METHODS(SameResiduePairFilter);
31  IMP_OBJECT_METHODS(SameResiduePairFilter);
32  ;
33 };
34 
35 IMPATOM_END_NAMESPACE
36 
37 #endif /* IMPATOM_SAME_RESIDUE_PAIR_FILTER_H */
IMP::PairPredicate::get_value_index
virtual int get_value_index(Model *m, const ParticleIndexPair &vt) const
Compute the predicate and the derivative if needed.
pair_macros.h
Macros for various classes.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
IMP::Vector
A more IMP-like version of the std::vector.
Definition: Vector.h:39
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
PairPredicate.h
Define PairPredicate.
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::PairPredicate
Abstract predicate function.
Definition: PairPredicate.h:31
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:80
IMP_PAIR_PREDICATE_METHODS
#define IMP_PAIR_PREDICATE_METHODS(Name)
Define extra the functions needed for a PairPredicate.
Definition: pair_macros.h:47