SingletonConstraint.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/SingletonConstraint.h
 *  \brief Use a SingletonModifier applied to a ParticlesTemp to
 *  maintain an invariant
 *
 *  Copyright 2007-2026 IMP Inventors. All rights reserved.
 */

#ifndef IMPCORE_SINGLETON_CONSTRAINT_H
#define IMPCORE_SINGLETON_CONSTRAINT_H

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

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

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

 public:
  SingletonConstraint(SingletonModifier *before,
                      SingletonDerivativeModifier *after, Model *m,
                      ParticleIndex vt,
                      std::string name = "SingletonConstraint %1%",
                      bool can_skip=false)
      : IMP::internal::TupleConstraint<
            SingletonModifier, SingletonDerivativeModifier>(before, after, m,
                                                            vt, name,
                                                            can_skip) {}

  SingletonConstraint() {}

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

#if defined(IMP_DOXYGEN) || defined(SWIG)
  //! Get the index(es) used in this constraint
  typename SingletonModifier::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(SingletonConstraint);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_SINGLETON_CONSTRAINT_H */