IMP  2.3.0
The Integrative Modeling Platform
pair_predicates.h
Go to the documentation of this file.
1 /**
2  * \file IMP/core/pair_predicates.h
3  * \brief Define some predicates.
4  *
5  * WARNING This file was generated from pair_predicates.h
6  * in /tmp/nightly-build-54722/imp-2.3.0/tools/build/container_templates/core
7  * by tools/build/make_containers.py.
8  *
9  * Copyright 2007-2014 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPCORE_PAIR_PREDICATES_H
13 #define IMPCORE_PAIR_PREDICATES_H
14 
15 #include <IMP/core/core_config.h>
16 #include <IMP/PairPredicate.h>
17 #include <IMP/pair_macros.h>
18 #include <boost/random.hpp>
19 #include "internal/container_helpers.h"
20 
21 IMPCORE_BEGIN_NAMESPACE
22 
23 /** Always return a constant value.
24  */
25 class IMPCOREEXPORT ConstantPairPredicate : public PairPredicate {
26  int v_;
27 
28  public:
30  std::string name = "ConstPairPredicate%1%");
32  IMP_OVERRIDE {
33  return v_;
34  }
37  return kernel::ModelObjectsTemp();
38  }
41 };
42 
43 /** Return a unique predicate value for each unordered set of
44  kernel::ParticleTypes
45  (see Typed).
46 */
47 
48 class IMPCOREEXPORT UnorderedTypePairPredicate
49  : public PairPredicate {
50  public:
51  UnorderedTypePairPredicate(std::string name =
52  "UnorderedTypePairPredicate%1%");
53  virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexPair& pi) const
54  IMP_OVERRIDE {
55  return internal::get_type_hash(m, pi);
56  }
58  kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE {
60  ret += IMP::get_particles(m, pis);
61  return ret;
62  }
65 };
66 
67 /** Return a unique predicate value for each ordered pair of
68  kernel::ParticleTypes (see Typed).
69 */
70 class IMPCOREEXPORT OrderedTypePairPredicate : public PairPredicate {
71  public:
72  OrderedTypePairPredicate(std::string name =
73  "OrderedTypePairPredicate%1%");
74 #ifndef SWIG
76 #endif
77  int get_value(const core::ParticleTypes &types) {
78  return internal::get_ordered_type_hash(types);
79  }
80  virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexPair& pi) const
81  IMP_OVERRIDE {
82  return internal::get_ordered_type_hash(m, pi);
83  }
85  kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE {
87  ret += IMP::get_particles(m, pis);
88  return ret;
89  }
92 };
93 
94 /** Return true if all members of the tuple are the same. */
95 class IMPCOREEXPORT AllSamePairPredicate : public PairPredicate {
96  public:
97  AllSamePairPredicate(std::string name = "AllSamePairPredicate%1%");
98  virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexPair& pi) const
99  IMP_OVERRIDE {
100  return internal::get_all_same(m, pi);
101  }
104  return kernel::ModelObjectsTemp();
105  }
108 };
109 
110 /** Return true with a fixed probability. */
111 class IMPCOREEXPORT CoinFlipPairPredicate : public PairPredicate {
112  double p_;
113  mutable boost::uniform_real<double> rng_;
114 
115  public:
116  CoinFlipPairPredicate(double p, std::string name =
117  "CoinFlipPairPredicate%1%");
119  IMP_OVERRIDE {
120  if (rng_(base::random_number_generator) < p_)
121  return 1;
122  else
123  return 0;
124  }
127  return kernel::ModelObjectsTemp();
128  }
131 };
132 
133 IMPCORE_END_NAMESPACE
134 
135 #endif /* IMPCORE_PAIR_PREDICATES_H */
virtual kernel::ModelObjectsTemp do_get_inputs(kernel::Model *, const kernel::ParticleIndexes &) const
Import IMP/kernel/pair_macros.h in the namespace.
IMP::base::Vector< IMP::base::WeakPointer< kernel::ModelObject > > ModelObjectsTemp
virtual int get_value(const kernel::ParticlePair &vt) const
RandomNumberGenerator random_number_generator
A shared random number generator.
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
ParticlesTemp get_particles(kernel::Model *m, const ParticleIndexes &ps)
virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexPair &pi) const
Compute the predicate and the derivative if needed.
virtual kernel::ModelObjectsTemp do_get_inputs(kernel::Model *, const kernel::ParticleIndexes &) const
virtual kernel::ModelObjectsTemp do_get_inputs(kernel::Model *, const kernel::ParticleIndexes &) const
virtual int get_value_index(kernel::Model *, const kernel::ParticleIndexPair &) const
Compute the predicate and the derivative if needed.
A class to store an fixed array of same-typed values.
Definition: Array.h:33
virtual kernel::ModelObjectsTemp do_get_inputs(kernel::Model *m, const kernel::ParticleIndexes &pis) const
Import IMP/kernel/PairPredicate.h in the namespace.
#define IMP_PAIR_PREDICATE_METHODS(Name)
Define extra the functions needed for a PairPredicate.
virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexPair &pi) const
Compute the predicate and the derivative if needed.
Abstract predicate function.
virtual kernel::ModelObjectsTemp do_get_inputs(kernel::Model *m, const kernel::ParticleIndexes &pis) const
virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexPair &pi) const
Compute the predicate and the derivative if needed.
virtual int get_value_index(kernel::Model *, const kernel::ParticleIndexPair &) const
Compute the predicate and the derivative if needed.
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Class for storing model, its restraints, constraints, and particles.
Definition: kernel/Model.h:73