IMP  2.4.0
The Integrative Modeling Platform
GaussianProcessInterpolationRestraint.h
Go to the documentation of this file.
1 /**
2  * \file IMP/isd/GaussianProcessInterpolationRestraint.h
3  * \brief kernel::Restraint and ScoreState for GaussianProcessInterpolation
4  *
5  * Copyright 2007-2015 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPISD_GAUSSIAN_PROCESS_INTERPOLATION_RESTRAINT_H
9 #define IMPISD_GAUSSIAN_PROCESS_INTERPOLATION_RESTRAINT_H
10 
11 #include <IMP/isd/isd_config.h>
12 #include <IMP/macros.h>
13 #include <boost/scoped_ptr.hpp>
14 #include <IMP/kernel/Restraint.h>
17 #include <IMP/base/Pointer.h>
18 #include <IMP/algebra/eigen3/Eigen/Dense>
19 
20 #include <IMP/ScoreState.h>
21 
22 IMPISD_BEGIN_NAMESPACE
23 
24 class GaussianProcessInterpolationScoreState;
25 
26 //! gaussian process restraint
27 /* the restraint is a multivariate normal distribution on the vector of
28 * observations with mean and standard deviation given by the posterior of the
29 * gaussian process.
30 */
32  : public kernel::Restraint {
33  private:
34  // checks and makes necessary updates
35  void update_mean_and_covariance();
39  // number of observation points
40  unsigned M_;
41 
42  void create_score_state();
43 
44  public:
45  /** This is a restraint on other restraints. It first constructs the
46  necessary vectors from GaussianProcessInterpolation, then creates a
47  multivariate normal distribution around it. Upon evaluation, it
48  checks if parameters have changed, reconstructs the matrix if
49  necessary, changes the DA weight and passes it to the functions. */
52 
53  /** To call this, you need to update the scorestate before.
54  calling model.evaluate(False) is enough. */
55  double get_probability() const { return mvn_->density(); }
56 
57  void stats() const { return mvn_->stats(); }
58 
59  //! Use conjugate gradients when possible (default false)
60  void set_use_cg(bool use, double tol) { mvn_->set_use_cg(use, tol); }
61 
62  //! Get minus log normalization and minus exponent separately
63  double get_minus_log_normalization() const;
64  double get_minus_exponent() const;
65 
66  //! Get hessian of the minus log likelihood
67  IMP_Eigen::MatrixXd get_hessian() const;
68 
69  //! Get log determinant of hessian
70  double get_logdet_hessian() const;
71 
72  //! call this one from Python
73  FloatsList get_hessian(bool unused) const;
74 
75  public:
76  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const
80 
81  // to allow the scorestate to get the restraint's objects
82  friend class GaussianProcessInterpolationScoreState;
83 };
84 
85 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
86 class IMPISDEXPORT GaussianProcessInterpolationScoreState : public ScoreState {
87  private:
89 
90  private:
91  GaussianProcessInterpolationScoreState(
92  GaussianProcessInterpolationRestraint *gpir)
93  : ScoreState(gpir->get_model(),
94  "GaussianProcessInterpolationScoreState%1%"),
95  gpir_(gpir) {}
96 
97  public:
98  // only the GPIR can create this and add it to the model
99  friend class GaussianProcessInterpolationRestraint;
100  virtual void do_before_evaluate() IMP_OVERRIDE;
101  virtual void do_after_evaluate(DerivativeAccumulator *da) IMP_OVERRIDE;
104  IMP_OBJECT_METHODS(GaussianProcessInterpolationScoreState);
105 };
106 #endif
107 
108 IMPISD_END_NAMESPACE
109 
110 #endif /* IMPISD_GAUSSIAN_PROCESS_INTERPOLATION_RESTRAINT_H */
Normal distribution of Function.
Class for adding derivatives from restraints to the model.
IMP::kernel::ScoreState ScoreState
A smart pointer to a ref-counted Object that is a class member.
Definition: Pointer.h:147
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
void set_use_cg(bool use, double tol)
Use conjugate gradients when possible (default false)
A smart pointer to a reference counted object.
Definition: Pointer.h:87
Import IMP/kernel/macros.h in the namespace.
ScoreStates maintain invariants in the Model.
Normal distribution of Function.
Abstract base class for all restraints.
A restraint is a term in an IMP ScoringFunction.
Import IMP/kernel/ScoreState.h in the namespace.
A nullptr-initialized pointer to an IMP Object.
virtual ModelObjectsTemp do_get_inputs() const =0
virtual ModelObjectsTemp do_get_outputs() const =0
#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