PairConstraint.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-381/imp-20260128.develop.907651fe7c/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-381/imp-20260128.develop.907651fe7c/tools/build/container_templates/core/ClassnameConstraint.h
// Do not edit - any changes will be lost!

/**
 *  \file IMP/core/PairConstraint.h
 *  \brief Use a PairModifier applied to a ParticlePairsTemp to
 *  maintain an invariant
 *
 *  Copyright 2007-2026 IMP Inventors. All rights reserved.
 */

#ifndef IMPCORE_PAIR_CONSTRAINT_H
#define IMPCORE_PAIR_CONSTRAINT_H

#include <IMP/core/core_config.h>
#include <IMP/internal/TupleConstraint.h>
#include <IMP/PairModifier.h>
#include <IMP/PairDerivativeModifier.h>
#include <cereal/access.hpp>
#include <cereal/types/base_class.hpp>

IMPCORE_BEGIN_NAMESPACE
//! Apply a PairFunction to a Pair
/** The score state is passed up to two PairModifiers, one to
    apply before evaluation and the other after. The one after
    should take a DerivativeAccumulator as its last argument for
    PairModifier::apply() and will only be called if
    the score was computed with derivatives.

    \see container::PairsConstraint
 */
class PairConstraint :
#if defined(IMP_DOXYGEN) || defined(SWIG)
    public Constraint
#else
    public IMP::internal::TupleConstraint<PairModifier,
                                                  PairDerivativeModifier>
#endif
    {
  typedef IMP::internal::TupleConstraint<PairModifier,
                                         PairDerivativeModifier> P;
  friend class cereal::access;
  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<
                    IMP::internal::TupleConstraint<PairModifier,
                                        PairDerivativeModifier> >(this));
  }
  IMP_OBJECT_SERIALIZE_DECL(PairConstraint);

 public:
  PairConstraint(PairModifier *before,
                      PairDerivativeModifier *after, Model *m,
                      const ParticleIndexPair& vt,
                      std::string name = "PairConstraint %1%",
                      bool can_skip=false)
      : IMP::internal::TupleConstraint<
            PairModifier, PairDerivativeModifier>(before, after, m,
                                                            vt, name,
                                                            can_skip) {}

  PairConstraint() {}

  //! Get the PairModifier object used in this constraint
  PairModifier *get_before_modifier() const {
    return P::get_before_modifier();
  }

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

 protected:
  void do_update_attributes();
  void do_update_derivatives(DerivativeAccumulator *da);
  virtual ModelObjectsTemp do_get_inputs() const;
  virtual ModelObjectsTemp do_get_outputs() const;
#endif
  IMP_OBJECT_METHODS(PairConstraint);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_PAIR_CONSTRAINT_H */