IMP  2.1.0
The Integrative Modeling Platform
DistributePairsScoreState.h
Go to the documentation of this file.
1 /**
2  * \file IMP/container/DistributePairsScoreState.h
3  * \brief Apply a PairScore to each Pair in a list.
4  *
5  * WARNING This file was generated from DistributePairsScoreState.h
6  * in /tmp/nightly-build-90783/imp-2.1.0/tools/build/container_templates/container
7  * by tools/maintenance/setup_containers.py.
8  *
9  * Copyright 2007-2013 IMP Inventors. All rights reserved.
10  *
11  */
12 
13 #ifndef IMPCONTAINER_DISTRIBUTE_PAIRS_SCORE_STATE_H
14 #define IMPCONTAINER_DISTRIBUTE_PAIRS_SCORE_STATE_H
15 
16 #include <IMP/container/container_config.h>
17 
18 #include "DynamicListPairContainer.h"
19 #include <IMP/PairPredicate.h>
20 #include <IMP/PairContainer.h>
21 #include <IMP/base/Vector.h>
22 #include <IMP/pair_macros.h>
23 #include <IMP/score_state_macros.h>
24 #include <boost/tuple/tuple.hpp>
25 
26 #include <iostream>
27 
28 IMPCONTAINER_BEGIN_NAMESPACE
29 
30 //! Distribute contents of one container into several based on predicates
31 /** This ScoreState takes a list of predicates and values. For
32  each tuple in the input container, it is placed in a given output container
33  if the predicate, when applied, has the passed value.
34 
35  \note The output containers contents are not necessarily disjoint.
36 */
37 class IMPCONTAINEREXPORT DistributePairsScoreState : public ScoreState {
38  base::PointerMember<PairContainer> input_;
39  typedef boost::tuple<base::Pointer<DynamicListPairContainer>,
40  base::PointerMember<PairPredicate>, int> Data;
41  base::Vector<Data> data_;
42  mutable int input_version_;
43  void update_lists_if_necessary() const;
44 
45  public:
46  DistributePairsScoreState(PairContainerAdaptor input,
47  std::string name =
48  "DistributePairsScoreState %1%");
49 
50  /** A given tuple will go into the returned container if \c predicate
51  returns \c value when applied to it.*/
52  DynamicListPairContainer *add_predicate(PairPredicate *predicate,
53  int value) {
54  IMP_NEW(DynamicListPairContainer, c,
55  (input_, predicate->get_name() + " output"));
56  data_.push_back(Data(c, predicate, value));
57  return c;
58  }
59  virtual void do_before_evaluate() IMP_OVERRIDE;
60  virtual void do_after_evaluate(DerivativeAccumulator *da) IMP_OVERRIDE;
61  virtual kernel::ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE;
62  virtual kernel::ModelObjectsTemp do_get_outputs() const IMP_OVERRIDE;
63  IMP_OBJECT_METHODS(DistributePairsScoreState);
64 };
65 
66 IMPCONTAINER_END_NAMESPACE
67 
68 #endif /* IMPCONTAINER_DISTRIBUTE_PAIRS_SCORE_STATE_H */
IMP::kernel::DerivativeAccumulator
Class for adding derivatives from restraints to the model.
Definition: kernel/DerivativeAccumulator.h:25
pair_macros.h
Import IMP/kernel/pair_macros.h in the namespace.
IMP::kernel::ModelObjectsTemp
IMP::base::Vector< IMP::base::WeakPointer< kernel::ModelObject > > ModelObjectsTemp
Definition: kernel/base_types.h:82
IMP::base::PointerMember
A smart pointer to a ref-counted Object that is a class memeber.
Definition: base/Pointer.h:146
DynamicListPairContainer.h
Store a list of ParticlePairsTemp.
IMP_NEW
#define IMP_NEW(Typename, varname, args)
Declare a ref counted pointer to a new object.
Definition: base/object_macros.h:100
IMP::kernel::ScoreState
ScoreStates maintian invariants in the Model.
Definition: kernel/ScoreState.h:51
IMP::container::DistributePairsScoreState::add_predicate
DynamicListPairContainer * add_predicate(PairPredicate *predicate, int value)
Definition: DistributePairsScoreState.h:52
PairContainer.h
Import IMP/kernel/PairContainer.h in the namespace.
PairPredicate.h
Import IMP/kernel/PairPredicate.h in the namespace.
Vector.h
A class for storing lists of IMP items.
IMP_OBJECT_METHODS
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
Definition: base/object_macros.h:25
IMP::container::DistributePairsScoreState
Distribute contents of one container into several based on predicates.
Definition: DistributePairsScoreState.h:37
IMP::kernel::PairPredicate
Abstract predicate function.
Definition: kernel/PairPredicate.h:32
score_state_macros.h
Import IMP/kernel/score_state_macros.h in the namespace.