MinimumRestraint.h

Go to the documentation of this file.

/**
 *  \file IMP/core/MinimumRestraint.h
 *  \brief Score based on the k minimum restraints.
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPCORE_MINIMUM_RESTRAINT_H
#define IMPCORE_MINIMUM_RESTRAINT_H

#include <IMP/core/core_config.h>
#include <IMP/kernel/Restraint.h>
#include <IMP/kernel/Model.h>
#include <IMP/macros.h>
#include <IMP/generic.h>

IMPCORE_BEGIN_NAMESPACE

//! Score based on the minimum scoring members of a set of restraints
/**
 */
class IMPCOREEXPORT MinimumRestraint : public kernel::Restraint {
  unsigned int k_;
  void on_add(kernel::Restraint *r) const;

 public:
  /** Score based on the num minimum restraints from rs. The restraints
      must already be registered with the model (either by being added
      to the model scoring function, upon constructior or having
      kernel::Restraint::set_model() called on them.
   */
  MinimumRestraint(unsigned int num,
                   const kernel::Restraints &rs = kernel::Restraints(),
                   std::string name = "MinimumRestraint %1%");

  void clear_caches();

 public:
  double unprotected_evaluate(IMP::DerivativeAccumulator *accum) const
      IMP_OVERRIDE;
  IMP::kernel::ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE;
  IMP_OBJECT_METHODS(MinimumRestraint);
  ;

  IMP_LIST_ACTION(public, Restraint, Restraints, restraint, restraints,
                  kernel::Restraint *, kernel::Restraints, on_add(obj);
                  , {}, {});
  void set_model(kernel::Model *m);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_MINIMUM_RESTRAINT_H */