LogWrapper.h

Go to the documentation of this file.

/**
 *  \file IMP/isd/LogWrapper.h
 *  \brief Calculate the -Log of a list of restraints.
 *
 *  Copyright 2007-2023 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPISD_LOG_WRAPPER_H
#define IMPISD_LOG_WRAPPER_H

#include <IMP/isd/isd_config.h>
#include <IMP/container_macros.h>
#include <IMP/RestraintSet.h>
#include <cereal/access.hpp>
#include <cereal/types/base_class.hpp>


IMPISD_BEGIN_NAMESPACE

//! Calculate the -Log of a list of restraints.
/** This is intended to be used with restraints where their score represents
    the probability (from 0 to 1) of being satisfied.
    \note Any weights of the wrapped restraints are ignored.
 */
class IMPISDEXPORT LogWrapper : public RestraintSet {

  friend class cereal::access;
  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<RestraintSet>(this));
  }
  IMP_OBJECT_SERIALIZE_DECL(LogWrapper);

  void show_it(std::ostream &out) const;

   public:
    //! Create an empty set that is registered with the model
    LogWrapper(Model *m, double weight, const std::string &name = "LogWrapper %1%");
    //! Create an empty set that is registered with the model
    LogWrapper(Model *m, const std::string &name = "LogWrapper %1%");
    //! Create a set that is registered with the model
    LogWrapper(const RestraintsTemp &rs, double weight,
               const std::string &name = "LogWrapper %1%");
    LogWrapper() {}

    virtual double unprotected_evaluate(
        IMP::DerivativeAccumulator* accum) const override;
    virtual double unprotected_evaluate_moved(
        IMP::DerivativeAccumulator* accum, const ParticleIndexes &moved_pis,
        const ParticleIndexes &reset_pis) const override;
    void do_add_score_and_derivatives(ScoreAccumulator sa) const override;
    void do_add_score_and_derivatives_moved(
                  ScoreAccumulator sa, const ParticleIndexes &moved_pis,
                  const ParticleIndexes &reset_pis) const override;

    IMP_OBJECT_METHODS(LogWrapper);

};

IMPISD_END_NAMESPACE

#endif /* IMPISD_LOG_WRAPPER_H */