IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
version 2.16.0
CommonEndpointPairFilter.h
Go to the documentation of this file.
1 /**
2  * \file IMP/misc/CommonEndpointPairFilter.h
3  * \brief Return true for any pair of bonds sharing an endpoint
4  *
5  * Copyright 2007-2021 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPMISC_COMMON_ENDPOINT_PAIR_FILTER_H
9 #define IMPMISC_COMMON_ENDPOINT_PAIR_FILTER_H
10 
11 #include <IMP/misc/misc_config.h>
12 
13 #include <IMP/PairPredicate.h>
14 #include <IMP/pair_macros.h>
15 IMPMISC_BEGIN_NAMESPACE
16 
17 //! Return true for any pair of bonds sharing an endpoint
18 class IMPMISCEXPORT CommonEndpointPairFilter : public PairPredicate {
19  public:
20  CommonEndpointPairFilter();
21 
22  virtual int get_value_index(Model *m,
23  const ParticleIndexPair &p) const
24  IMP_OVERRIDE;
25  virtual ModelObjectsTemp do_get_inputs(
26  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
27  IMP_PAIR_PREDICATE_METHODS(CommonEndpointPairFilter);
28  IMP_OBJECT_METHODS(CommonEndpointPairFilter);
29 };
30 
31 IMPMISC_END_NAMESPACE
32 
33 #endif /* IMPMISC_COMMON_ENDPOINT_PAIR_FILTER_H */
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:40
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:73
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::PairPredicate::get_value_index
virtual int get_value_index(Model *m, const ParticleIndexPair &vt) const =0
Compute the predicate and the derivative if needed.
IMP::misc::CommonEndpointPairFilter
Return true for any pair of bonds sharing an endpoint.
Definition: CommonEndpointPairFilter.h:18
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78
IMP_PAIR_PREDICATE_METHODS
#define IMP_PAIR_PREDICATE_METHODS(Name)
Define extra the functions needed for a PairPredicate.
Definition: pair_macros.h:78