PairsConstraint.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-470/imp-2.22.0/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-470/imp-2.22.0/tools/build/container_templates/container/ClassnamesConstraint.h
// Do not edit - any changes will be lost!

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

#ifndef IMPCONTAINER_PAIRS_CONSTRAINT_H
#define IMPCONTAINER_PAIRS_CONSTRAINT_H

#include <IMP/container/container_config.h>
#include <IMP/PairContainer.h>
#include <IMP/PairModifier.h>
#include <IMP/Constraint.h>
#include <IMP/object_macros.h>
#include <IMP/internal/ContainerConstraint.h>
#include <cereal/access.hpp>
#include <cereal/types/base_class.hpp>

IMPKERNEL_BEGIN_NAMESPACE
// for swig
class PairContainer;
class PairModifier;
IMPKERNEL_END_NAMESPACE

IMPCONTAINER_BEGIN_NAMESPACE
//! Apply a PairFunction to a PairContainer to maintain an invariant
/** 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 core::PairConstraint
 */
class IMPCONTAINEREXPORT PairsConstraint :
#if defined(SWIG) || defined(IMP_DOXYGEN)
    public Constraint
#else
    public IMP::internal::ContainerConstraint<
        PairModifier, PairModifier, PairContainer>
#endif
    {
  typedef IMP::internal::ContainerConstraint<
      PairModifier, PairModifier, PairContainer> P;

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

  IMP_OBJECT_SERIALIZE_DECL(PairsConstraint);

 public:
  /** \param[in] c The Container to hold the elements to process
      \param[in] before The PairModifier to apply to all elements
      before evaluate.
      \param[in] after The PairModifier to apply to all elements
      after evaluate.
      \param[in] name The object name
   */
  PairsConstraint(PairModifier *before, PairModifier *after,
                       PairContainerAdaptor c,
                       std::string name = "PairsConstraint %1%")
      : P(before, after, c, name) {}

  PairsConstraint() {}

#if defined(IMP_DOXYGEN) || defined(SWIG)
 protected:
  void do_update_attributes();
  void do_update_derivatives(DerivativeAccumulator *da);
  virtual ModelObjectsTemp do_get_inputs() const;
  virtual ModelObjectsTemp do_get_outputs() const;
  IMP_OBJECT_METHODS(PairsConstraint);
#endif
};

IMP_OBJECTS(PairsConstraint, PairsConstraints);

IMPCONTAINER_END_NAMESPACE

#endif /* IMPCONTAINER_PAIRS_CONSTRAINT_H */