IMP logo
IMP Reference Guide  develop.b99932598c,2021/06/14
The Integrative Modeling Platform
QuadContainer.h
Go to the documentation of this file.
1 // Autogenerated by ../../../../tmp/nightly-build-311/imp-20210614.develop.b99932598c/tools/build/make_containers.py
2 // from ../../../../tmp/nightly-build-311/imp-20210614.develop.b99932598c/tools/build/container_templates/kernel/ClassnameContainer.h
3 // Do not edit - any changes will be lost!
4 
5 /**
6  * \file IMP/QuadContainer.h
7  * \brief A container for Quads.
8  *
9  * Copyright 2007-2021 IMP Inventors. All rights reserved.
10  */
11 
12 #ifndef IMPKERNEL_QUAD_CONTAINER_H
13 #define IMPKERNEL_QUAD_CONTAINER_H
14 
15 #include <IMP/kernel_config.h>
16 #include "internal/IndexingIterator.h"
17 #include "Particle.h"
18 #include "container_base.h"
19 #include "internal/container_helpers.h"
20 #include "DerivativeAccumulator.h"
21 #include "base_types.h"
22 #include <IMP/ref_counted_macros.h>
23 #include <IMP/check_macros.h>
24 #include <IMP/Pointer.h>
25 #include <IMP/InputAdaptor.h>
26 #include <IMP/utility_macros.h>
27 #include <IMP/deprecation_macros.h>
28 #include <algorithm>
29 
30 IMPKERNEL_BEGIN_NAMESPACE
31 class QuadModifier;
32 class QuadScore;
33 
34 //! A shared container for Quads
35 /** Stores a shared collection of Quads.
36  */
37 class IMPKERNELEXPORT QuadContainer : public Container {
38  public:
43  typedef QuadModifier Modifier;
45 
46  //! Just use apply() in the base class
47  void apply_generic(const QuadModifier *m) const;
48 
49  //! Apply a SingletonModifier to the contents
50  void apply(const QuadModifier *sm) const;
51 
52  /** Get all the indexes that might possibly be contained in the
53  container, useful with dynamic containers. For example,
54  with a container::ClosePairContainer, this is the list
55  of all pairs taken from the input list (those that are far apart
56  in addition to those that are close).
57  */
58  virtual ParticleIndexQuads get_range_indexes() const = 0;
59 
60  const ParticleIndexQuads &get_contents() const {
61  if (get_provides_access())
62  return get_access();
63  else {
64  std::size_t nhash = get_contents_hash();
65  if (contents_hash_ != nhash || !cache_initialized_) {
66  contents_hash_ = nhash;
67  cache_initialized_ = true;
68  get_indexes_in_place(contents_cache_); // inheriting class could implement this faster than get_indexes()
69  }
70  return contents_cache_;
71  }
72  }
73 
74  /** Get all the indexes contained in the container.
75 
76  This should be protected but isn't for compatibility reasons.
77 
78  External callers should use get_contents().
79  */
80  virtual ParticleIndexQuads get_indexes() const = 0;
81 
82 
83 #ifndef IMP_DOXYGEN
84 
85  ParticleQuadsTemp get() const {
86  return IMP::internal::get_particle(get_model(), get_indexes());
87  }
88 
89  ParticleQuad get(unsigned int i) const {
90  return IMP::internal::get_particle(get_model(), get_indexes()[i]);
91  }
92 
93  //! Return size of current container content
94  //! Note that this may be expensive since my evaluate
95  //! refreshing of the container
96  unsigned int get_number() const { return get_indexes().size(); }
97 #ifndef SWIG
98  bool get_provides_access() const;
99  virtual const ParticleIndexQuads &get_access() const {
100  IMP_THROW("Object not implemented properly.", IndexException);
101  }
102 
103  template <class Functor>
104  Functor for_each(Functor f) {
106  // use boost range instead
107  return std::for_each(vs.begin(), vs.end(), f);
108  }
109 
110 #endif
111 #endif
112 
113  protected:
114  QuadContainer(Model *m,
115  std::string name = "QuadContainer %1%");
116 
117  virtual void do_apply(const QuadModifier *sm) const = 0;
118  virtual bool do_get_provides_access() const { return false; }
119 
120 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
121  //! Insert the contents of the container into output
122  //! Could be reimplemented to save time in terms of e.g. memory
123  //! allocation compared with calling get_indexes()
124  virtual void get_indexes_in_place(ParticleIndexQuads& output) const{
125  output= get_indexes();
126  }
127 #endif
128 
130 
131  private:
132  mutable std::size_t contents_hash_;
133  mutable ParticleIndexQuads contents_cache_;
134  mutable bool cache_initialized_;
135 };
136 
137 /** This class allows either a list or a container to be
138  accepted as input.
139 */
140 class IMPKERNELEXPORT QuadContainerAdaptor :
141 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
142  public Pointer<QuadContainer>
143 #else
144  public InputAdaptor
145 #endif
146  {
147  typedef Pointer<QuadContainer> P;
148 
149  public:
151 
152  /**
153  Constructs the adaptor pointing to c (so if the contents of c are changed
154  dynamically, so do the contents of the adaptor, and vice versa)
155  */
157 
158  /**
159  Constructs the adaptor pointing to c (so if the contents of c are changed
160  dynamically, so do the contents of the adaptor, and vice versa)
161  */
162  template <class C>
163  QuadContainerAdaptor(IMP::internal::PointerBase<C> c)
164  : P(c) {}
165 
166  /**
167  Adapts the non-empty list t to QuadContainer
168 
169  @param t a non-empty list of ParticleQuadsTemp
170  */
172 
173  /** Set the name of the resulting container if it is currently the
174  default value. */
175  void set_name_if_default(std::string name);
176 };
177 
178 IMPKERNEL_END_NAMESPACE
179 
180 #endif /* IMPKERNEL_QUAD_CONTAINER_H */
Control display of deprecation information.
Macros to help with reference counting.
Basic types used by IMP.
A class to store an fixed array of same-typed values.
Definition: Array.h:33
Class for adding derivatives from restraints to the model.
std::size_t get_contents_hash() const
A more IMP-like version of the std::vector.
Definition: Vector.h:40
A smart pointer to a reference counted object.
Definition: Pointer.h:87
Class for storing model, its restraints, constraints, and particles.
Definition: Model.h:72
Convenience class to accept multiple input types.
QuadContainerAdaptor(IMP::internal::PointerBase< C > c)
Various general useful macros for IMP.
An exception for a request for an invalid member of a container.
Definition: exception.h:157
A shared container for Quads.
Definition: QuadContainer.h:37
Classes to handle individual model particles. (Note that implementation of inline functions is in int...
Abstract base class for containers of particles.
#define IMP_THROW(message, exception_name)
Throw an exception with a message.
Definition: check_macros.h:50
A nullptr-initialized pointer to an IMP Object.
Helper macros for throwing and handling exceptions.
#define IMP_REF_COUNTED_NONTRIVIAL_DESTRUCTOR(Name)
Convenience class to accept multiple input types.
Definition: InputAdaptor.h:25
A base class for modifiers of ParticleQuadsTemp.
Definition: QuadModifier.h:32
ParticleIndexes get_indexes(const ParticlesTemp &ps)
Get the indexes from a list of particles.
Abstract class for containers of particles.