IMP logo
IMP Reference Guide  2.14.0
The Integrative Modeling Platform
version 2.14.0
MinimumSingletonScore.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/container_templates/container/MinimumClassnameScore.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/container/MinimumSingletonScore.h
7  * \brief Define SingletonScore.
8  *
9  * Copyright 2007-2020 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPCONTAINER_MINIMUM_SINGLETON_SCORE_H
13 #define IMPCONTAINER_MINIMUM_SINGLETON_SCORE_H
14 
15 #include <IMP/container/container_config.h>
16 #include <IMP/SingletonScore.h>
17 #include <IMP/singleton_macros.h>
18 
19 IMPCONTAINER_BEGIN_NAMESPACE
20 
21 //! Evaluate the min or max n particle scores of the passed set
22 /** Each of the set of SingletonScores is evaluated and the sum of the
23  minimum n is returned.
24 */
25 class IMPCONTAINEREXPORT MinimumSingletonScore : public SingletonScore {
26  SingletonScores scores_;
27  unsigned int n_;
28 
29  public:
30  MinimumSingletonScore(const SingletonScoresTemp &scores, unsigned int n = 1,
31  std::string name = "SingletonScore %1%");
32  virtual double evaluate_index(Model *m, ParticleIndex vt,
33  DerivativeAccumulator *da) const IMP_OVERRIDE;
34  virtual ModelObjectsTemp do_get_inputs(
35  Model *m, const ParticleIndexes &pis) const IMP_OVERRIDE;
36  IMP_SINGLETON_SCORE_METHODS(MinimumSingletonScore);
37  IMP_OBJECT_METHODS(MinimumSingletonScore);
38 
39  Restraints do_create_current_decomposition(Model *m,
40  ParticleIndex vt) const
41  IMP_OVERRIDE;
42 };
43 
44 IMP_OBJECTS(MinimumSingletonScore, MinimumSingletonScores);
45 
46 IMPCONTAINER_END_NAMESPACE
47 
48 #endif /* IMPCONTAINER_MINIMUM_SINGLETON_SCORE_H */
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: object_macros.h:25
singleton_macros.h
Macros for various classes.
IMP::SingletonScore::do_create_current_decomposition
virtual Restraints do_create_current_decomposition(Model *m, ParticleIndex vt) const
Override this to return your own decomposition.
IMP::Model
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
IMP::SingletonScore
Abstract class for scoring object(s) of type ParticleIndex.
Definition: SingletonScore.h:37
IMP_SINGLETON_SCORE_METHODS
#define IMP_SINGLETON_SCORE_METHODS(Name)
Definition: singleton_macros.h:25
IMP::ParticleInputs::do_get_inputs
virtual ModelObjectsTemp do_get_inputs(Model *m, const ParticleIndexes &pis) const =0
Overload this method to specify the inputs.
SingletonScore.h
Define SingletonScore.
IMP_OBJECTS
#define IMP_OBJECTS(Name, PluralName)
Define the types for storing lists of object pointers.
Definition: object_macros.h:44
IMP::container::MinimumSingletonScore
Evaluate the min or max n particle scores of the passed set.
Definition: MinimumSingletonScore.h:25
IMP::SingletonScore::evaluate_index
virtual double evaluate_index(Model *m, ParticleIndex vt, DerivativeAccumulator *da) const =0
Compute the score and the derivative if needed.
IMP_OVERRIDE
#define IMP_OVERRIDE
Cause a compile error if this method does not override a parent method.
Definition: compiler_macros.h:78
IMP::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition: DerivativeAccumulator.h:25