TripletRestraint.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-379/imp-20260108.develop.02fce3ae61/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-379/imp-20260108.develop.02fce3ae61/tools/build/container_templates/core/ClassnameRestraint.h
// Do not edit - any changes will be lost!

/**
 *  \file IMP/core/TripletRestraint.h
 *  \brief Apply a TripletScore to a Triplet.
 *
 *  Copyright 2007-2025 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPCORE_TRIPLET_RESTRAINT_H
#define IMPCORE_TRIPLET_RESTRAINT_H

#include <IMP/core/core_config.h>

#include <IMP/internal/TupleRestraint.h>
#include <IMP/TripletScore.h>

#include <iostream>
#include <cereal/access.hpp>
#include <cereal/types/base_class.hpp>

IMPCORE_BEGIN_NAMESPACE

//! Applies a TripletScore to a Triplet.
/** This restraint stores a Triplet.
    \see TripletRestraint
 */
class TripletRestraint :
#if defined(SWIG) || defined(IMP_DOXYGEN)
    public Restraint
#else
    public IMP::internal::TupleRestraint<TripletScore>
#endif
    {
  typedef IMP::internal::TupleRestraint<TripletScore> P;
  friend class cereal::access;

  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<
                    IMP::internal::TupleRestraint<TripletScore> >(this));
  }
  IMP_OBJECT_SERIALIZE_DECL(TripletRestraint);
 public:
  //! Create the restraint.
  /** This function takes the function to apply to the
      stored Triplet and the Triplet.
   */
  TripletRestraint(Model *m, TripletScore *ss, const ParticleIndexTriplet& vt,
                     std::string name = "TripletRestraint %1%")
      : IMP::internal::TupleRestraint<TripletScore>(ss, m, vt, name) {
  }
  TripletRestraint() {}

  //! Get the TripletScore object used in this restraint
  TripletScore *get_score_object() const { return P::get_score(); }

#if defined(SWIG) || defined(IMP_DOXYGEN)
  //! Get the index(es) used in this restraint
  typename TripletScore::IndexArgument get_index() const;

 protected:
  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const;
  IMP::ModelObjectsTemp do_get_inputs() const;
#endif
  IMP_OBJECT_METHODS(TripletRestraint)
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_TRIPLET_RESTRAINT_H */