IMP logo
IMP Reference Guide  2.6.0
The Integrative Modeling Platform
score_functor/Harmonic.h
Go to the documentation of this file.
1 /**
2  * \file IMP/score_functor/Harmonic.h
3  * \brief A Score on the distance between a pair of particles.
4  *
5  * Copyright 2007-2016 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPSCORE_FUNCTOR_HARMONIC_H
9 #define IMPSCORE_FUNCTOR_HARMONIC_H
10 
11 #include <IMP/score_functor/score_functor_config.h>
12 #include "Score.h"
13 #include <IMP/algebra/utility.h>
14 IMPSCOREFUNCTOR_BEGIN_NAMESPACE
15 
16 /** A DistanceScore that scores with a harmonic on the distance, centered
17  at 0.*/
18 class Harmonic : public Score {
19  double k_;
20 
21  public:
22  Harmonic(double k) : k_(k) {}
23  template <unsigned int D>
24  double get_score(Model *,
26  double distance) const {
27  return .5 * k_ * algebra::get_squared(distance);
28  }
29  template <unsigned int D>
30  DerivativePair get_score_and_derivative(
31  Model *m, const Array<D, ParticleIndex> &p,
32  double distance) const {
33  return DerivativePair(get_score(m, p, distance), k_ * (distance));
34  }
35  double get_k() { return k_; }
36  void set_k(double k) { k_ = k; }
37 };
38 
39 IMPSCOREFUNCTOR_END_NAMESPACE
40 
41 #endif /* IMPSCORE_FUNCTOR_HARMONIC_H */
A class to store an fixed array of same-typed values.
Definition: Array.h:33
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
Functions to deal with very common math operations.
A Score on the distance between a pair of particles.
std::pair< double, double > DerivativePair
A pair representing a function value with its first derivative.
Definition: types.h:23
A functor for computing a distance based score for two particles.
Definition: Score.h:20