IMP  2.0.0
The Integrative Modeling Platform
kernel/doxygen.h
Go to the documentation of this file.
1 /**
2  * \file IMP/kernel/doxygen.h
3  * \brief Import kernel classes into the IMP scope in docs.
4  *
5  * Copyright 2007-2013 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPKERNEL_DOXYGEN_H
10 #define IMPKERNEL_DOXYGEN_H
11 
12  #include <IMP/kernel.h>
13 
14 #ifdef IMP_DOXYGEN
15 namespace IMP {
16 
17 /** Import IMP::kernel::CommandDispatcher
18  in the IMP namespace.*/
19 typedef IMP::kernel::CommandDispatcher
20  CommandDispatcher;
21 /** Import IMP::kernel::Configuration
22  in the IMP namespace.*/
23 typedef IMP::kernel::Configuration
24  Configuration;
25 /** Import IMP::kernel::ConfigurationSet
26  in the IMP namespace.*/
27 typedef IMP::kernel::ConfigurationSet
28  ConfigurationSet;
29 /** Import IMP::kernel::Constraint
30  in the IMP namespace.*/
31 typedef IMP::kernel::Constraint
32  Constraint;
33 /** Import IMP::kernel::Container
34  in the IMP namespace.*/
35 typedef IMP::kernel::Container
36  Container;
37 /** Import IMP::kernel::Decorator
38  in the IMP namespace.*/
39 typedef IMP::kernel::Decorator
40  Decorator;
41 /** Import IMP::kernel::DependencyGraph
42  in the IMP namespace.*/
43 typedef IMP::kernel::DependencyGraph
44  DependencyGraph;
45 /** Import IMP::kernel::DerivativeAccumulator
46  in the IMP namespace.*/
47 typedef IMP::kernel::DerivativeAccumulator
48  DerivativeAccumulator;
49 /** Import IMP::kernel::EvaluationState
50  in the IMP namespace.*/
51 typedef IMP::kernel::EvaluationState
52  EvaluationState;
53 /** Import IMP::kernel::EvaluationStates
54  in the IMP namespace.*/
55 typedef IMP::kernel::EvaluationStates
56  EvaluationStates;
57 /** Import IMP::kernel::FloatIndex
58  in the IMP namespace.*/
59 typedef IMP::kernel::FloatIndex
60  FloatIndex;
61 /** Import IMP::kernel::FloatIndexes
62  in the IMP namespace.*/
63 typedef IMP::kernel::FloatIndexes
64  FloatIndexes;
65 /** Import IMP::kernel::FloatKey
66  in the IMP namespace.*/
67 typedef IMP::kernel::FloatKey
68  FloatKey;
69 /** Import IMP::kernel::FloatKeys
70  in the IMP namespace.*/
71 typedef IMP::kernel::FloatKeys
72  FloatKeys;
73 /** Import IMP::kernel::IntKey
74  in the IMP namespace.*/
75 typedef IMP::kernel::IntKey
76  IntKey;
77 /** Import IMP::kernel::IntKeys
78  in the IMP namespace.*/
79 typedef IMP::kernel::IntKeys
80  IntKeys;
81 /** Import IMP::kernel::Model
82  in the IMP namespace.*/
83 typedef IMP::kernel::Model
84  Model;
85 /** Import IMP::kernel::ModelObject
86  in the IMP namespace.*/
87 typedef IMP::kernel::ModelObject
88  ModelObject;
89 /** Import IMP::kernel::ObjectKey
90  in the IMP namespace.*/
91 typedef IMP::kernel::ObjectKey
92  ObjectKey;
93 /** Import IMP::kernel::ObjectKeys
94  in the IMP namespace.*/
95 typedef IMP::kernel::ObjectKeys
96  ObjectKeys;
97 /** Import IMP::kernel::Optimizer
98  in the IMP namespace.*/
99 typedef IMP::kernel::Optimizer
100  Optimizer;
101 /** Import IMP::kernel::OptimizerState
102  in the IMP namespace.*/
103 typedef IMP::kernel::OptimizerState
104  OptimizerState;
105 /** Import IMP::kernel::OptionParser
106  in the IMP namespace.*/
107 typedef IMP::kernel::OptionParser
108  OptionParser;
109 /** Import IMP::kernel::PairContainer
110  in the IMP namespace.*/
111 typedef IMP::kernel::PairContainer
112  PairContainer;
113 /** Import IMP::kernel::PairModifier
114  in the IMP namespace.*/
115 typedef IMP::kernel::PairModifier
116  PairModifier;
117 /** Import IMP::kernel::PairPredicate
118  in the IMP namespace.*/
119 typedef IMP::kernel::PairPredicate
120  PairPredicate;
121 /** Import IMP::kernel::PairScore
122  in the IMP namespace.*/
123 typedef IMP::kernel::PairScore
124  PairScore;
125 /** Import IMP::kernel::Particle
126  in the IMP namespace.*/
127 typedef IMP::kernel::Particle
128  Particle;
129 /** Import IMP::kernel::ParticleIndex
130  in the IMP namespace.*/
131 typedef IMP::kernel::ParticleIndex
132  ParticleIndex;
133 /** Import IMP::kernel::ParticleIndexKey
134  in the IMP namespace.*/
135 typedef IMP::kernel::ParticleIndexKey
136  ParticleIndexKey;
137 /** Import IMP::kernel::ParticleIndexKeys
138  in the IMP namespace.*/
139 typedef IMP::kernel::ParticleIndexKeys
140  ParticleIndexKeys;
141 /** Import IMP::kernel::ParticleIndexPairs
142  in the IMP namespace.*/
143 typedef IMP::kernel::ParticleIndexPairs
144  ParticleIndexPairs;
145 /** Import IMP::kernel::ParticleIndexQuads
146  in the IMP namespace.*/
147 typedef IMP::kernel::ParticleIndexQuads
148  ParticleIndexQuads;
149 /** Import IMP::kernel::ParticleIndexTriplets
150  in the IMP namespace.*/
151 typedef IMP::kernel::ParticleIndexTriplets
152  ParticleIndexTriplets;
153 /** Import IMP::kernel::ParticleIndexes
154  in the IMP namespace.*/
155 typedef IMP::kernel::ParticleIndexes
156  ParticleIndexes;
157 /** Import IMP::kernel::ParticleIndexesKey
158  in the IMP namespace.*/
159 typedef IMP::kernel::ParticleIndexesKey
160  ParticleIndexesKey;
161 /** Import IMP::kernel::ParticleIndexesKeys
162  in the IMP namespace.*/
163 typedef IMP::kernel::ParticleIndexesKeys
164  ParticleIndexesKeys;
165 /** Import IMP::kernel::ParticlePair
166  in the IMP namespace.*/
167 typedef IMP::kernel::ParticlePair
168  ParticlePair;
169 /** Import IMP::kernel::ParticlePairsTemp
170  in the IMP namespace.*/
171 typedef IMP::kernel::ParticlePairsTemp
172  ParticlePairsTemp;
173 /** Import IMP::kernel::ParticleQuad
174  in the IMP namespace.*/
175 typedef IMP::kernel::ParticleQuad
176  ParticleQuad;
177 /** Import IMP::kernel::ParticleQuadsTemp
178  in the IMP namespace.*/
179 typedef IMP::kernel::ParticleQuadsTemp
180  ParticleQuadsTemp;
181 /** Import IMP::kernel::ParticleTriplet
182  in the IMP namespace.*/
183 typedef IMP::kernel::ParticleTriplet
184  ParticleTriplet;
185 /** Import IMP::kernel::ParticleTripletsTemp
186  in the IMP namespace.*/
187 typedef IMP::kernel::ParticleTripletsTemp
188  ParticleTripletsTemp;
189 /** Import IMP::kernel::PythonRestraint
190  in the IMP namespace.*/
191 typedef IMP::kernel::PythonRestraint
192  PythonRestraint;
193 /** Import IMP::kernel::PythonScoreState
194  in the IMP namespace.*/
195 typedef IMP::kernel::PythonScoreState
196  PythonScoreState;
197 /** Import IMP::kernel::QuadContainer
198  in the IMP namespace.*/
199 typedef IMP::kernel::QuadContainer
200  QuadContainer;
201 /** Import IMP::kernel::QuadModifier
202  in the IMP namespace.*/
203 typedef IMP::kernel::QuadModifier
204  QuadModifier;
205 /** Import IMP::kernel::QuadPredicate
206  in the IMP namespace.*/
207 typedef IMP::kernel::QuadPredicate
208  QuadPredicate;
209 /** Import IMP::kernel::QuadScore
210  in the IMP namespace.*/
211 typedef IMP::kernel::QuadScore
212  QuadScore;
213 /** Import IMP::kernel::Refiner
214  in the IMP namespace.*/
215 typedef IMP::kernel::Refiner
216  Refiner;
217 /** Import IMP::kernel::Restraint
218  in the IMP namespace.*/
219 typedef IMP::kernel::Restraint
220  Restraint;
221 /** Import IMP::kernel::RestraintBase
222  in the IMP namespace.*/
223 typedef IMP::kernel::RestraintBase
224  RestraintBase;
225 /** Import IMP::kernel::RestraintSet
226  in the IMP namespace.*/
227 typedef IMP::kernel::RestraintSet
228  RestraintSet;
229 /** Import IMP::kernel::RestraintStatistics
230  in the IMP namespace.*/
231 typedef IMP::kernel::RestraintStatistics
232  RestraintStatistics;
233 /** Import IMP::kernel::RestraintStatisticsList
234  in the IMP namespace.*/
235 typedef IMP::kernel::RestraintStatisticsList
236  RestraintStatisticsList;
237 /** Import IMP::kernel::Sampler
238  in the IMP namespace.*/
239 typedef IMP::kernel::Sampler
240  Sampler;
241 /** Import IMP::kernel::SaveToConfigurationSetOptimizerState
242  in the IMP namespace.*/
243 typedef IMP::kernel::SaveToConfigurationSetOptimizerState
244  SaveToConfigurationSetOptimizerState;
245 /** Import IMP::kernel::ScopedRemoveRestraint
246  in the IMP namespace.*/
247 typedef IMP::kernel::ScopedRemoveRestraint
248  ScopedRemoveRestraint;
249 /** Import IMP::kernel::ScopedRemoveScoreState
250  in the IMP namespace.*/
251 typedef IMP::kernel::ScopedRemoveScoreState
252  ScopedRemoveScoreState;
253 /** Import IMP::kernel::ScopedRestraint
254  in the IMP namespace.*/
255 typedef IMP::kernel::ScopedRestraint
256  ScopedRestraint;
257 /** Import IMP::kernel::ScopedScoreState
258  in the IMP namespace.*/
259 typedef IMP::kernel::ScopedScoreState
260  ScopedScoreState;
261 /** Import IMP::kernel::ScopedSetFloatAttribute
262  in the IMP namespace.*/
263 typedef IMP::kernel::ScopedSetFloatAttribute
264  ScopedSetFloatAttribute;
265 /** Import IMP::kernel::ScoreAccumulator
266  in the IMP namespace.*/
267 typedef IMP::kernel::ScoreAccumulator
268  ScoreAccumulator;
269 /** Import IMP::kernel::ScoreAccumulators
270  in the IMP namespace.*/
271 typedef IMP::kernel::ScoreAccumulators
272  ScoreAccumulators;
273 /** Import IMP::kernel::ScoreState
274  in the IMP namespace.*/
275 typedef IMP::kernel::ScoreState
276  ScoreState;
277 /** Import IMP::kernel::ScoreStateBase
278  in the IMP namespace.*/
279 typedef IMP::kernel::ScoreStateBase
280  ScoreStateBase;
281 /** Import IMP::kernel::ScoringFunction
282  in the IMP namespace.*/
283 typedef IMP::kernel::ScoringFunction
284  ScoringFunction;
285 /** Import IMP::kernel::SingletonContainer
286  in the IMP namespace.*/
287 typedef IMP::kernel::SingletonContainer
288  SingletonContainer;
289 /** Import IMP::kernel::SingletonModifier
290  in the IMP namespace.*/
291 typedef IMP::kernel::SingletonModifier
292  SingletonModifier;
293 /** Import IMP::kernel::SingletonPredicate
294  in the IMP namespace.*/
295 typedef IMP::kernel::SingletonPredicate
296  SingletonPredicate;
297 /** Import IMP::kernel::SingletonScore
298  in the IMP namespace.*/
299 typedef IMP::kernel::SingletonScore
300  SingletonScore;
301 /** Import IMP::kernel::StringKey
302  in the IMP namespace.*/
303 typedef IMP::kernel::StringKey
304  StringKey;
305 /** Import IMP::kernel::StringKeys
306  in the IMP namespace.*/
307 typedef IMP::kernel::StringKeys
308  StringKeys;
309 /** Import IMP::kernel::TripletContainer
310  in the IMP namespace.*/
311 typedef IMP::kernel::TripletContainer
312  TripletContainer;
313 /** Import IMP::kernel::TripletModifier
314  in the IMP namespace.*/
315 typedef IMP::kernel::TripletModifier
316  TripletModifier;
317 /** Import IMP::kernel::TripletPredicate
318  in the IMP namespace.*/
319 typedef IMP::kernel::TripletPredicate
320  TripletPredicate;
321 /** Import IMP::kernel::TripletScore
322  in the IMP namespace.*/
323 typedef IMP::kernel::TripletScore
324  TripletScore;
325 /** Import IMP::kernel::UnaryFunction
326  in the IMP namespace.*/
327 typedef IMP::kernel::UnaryFunction
328  UnaryFunction;
329 /** Import IMP::kernel::build
330  in the IMP namespace.*/
331 using IMP::kernel::build;
332 /** Import IMP::kernel::check_particle
333  in the IMP namespace.*/
334 using IMP::kernel::check_particle;
335 /** Import IMP::kernel::create_decomposition
336  in the IMP namespace.*/
337 using IMP::kernel::create_decomposition;
338 /** Import IMP::kernel::get_dependency_graph
339  in the IMP namespace.*/
340 using IMP::kernel::get_dependency_graph;
341 /** Import IMP::kernel::get_dependent_particles
342  in the IMP namespace.*/
343 using IMP::kernel::get_dependent_particles;
344 /** Import IMP::kernel::get_dependent_restraints
345  in the IMP namespace.*/
346 using IMP::kernel::get_dependent_restraints;
347 /** Import IMP::kernel::get_dependent_score_states
348  in the IMP namespace.*/
349 using IMP::kernel::get_dependent_score_states;
350 /** Import IMP::kernel::get_indexes
351  in the IMP namespace.*/
352 using IMP::kernel::get_indexes;
353 /** Import IMP::kernel::get_input_containers
354  in the IMP namespace.*/
355 using IMP::kernel::get_input_containers;
356 /** Import IMP::kernel::get_input_particles
357  in the IMP namespace.*/
358 using IMP::kernel::get_input_particles;
359 /** Import IMP::kernel::get_output_containers
360  in the IMP namespace.*/
361 using IMP::kernel::get_output_containers;
362 /** Import IMP::kernel::get_output_particles
363  in the IMP namespace.*/
364 using IMP::kernel::get_output_particles;
365 /** Import IMP::kernel::get_particle
366  in the IMP namespace.*/
367 using IMP::kernel::get_particle;
368 /** Import IMP::kernel::get_particles
369  in the IMP namespace.*/
370 using IMP::kernel::get_particles;
371 /** Import IMP::kernel::get_pruned_dependency_graph
372  in the IMP namespace.*/
373 using IMP::kernel::get_pruned_dependency_graph;
374 /** Import IMP::kernel::get_required_particles
375  in the IMP namespace.*/
376 using IMP::kernel::get_required_particles;
377 /** Import IMP::kernel::get_required_score_states
378  in the IMP namespace.*/
379 using IMP::kernel::get_required_score_states;
380 /** Import IMP::kernel::get_restraints
381  in the IMP namespace.*/
382 using IMP::kernel::get_restraints;
383 /** Import IMP::kernel::get_update_order
384  in the IMP namespace.*/
385 using IMP::kernel::get_update_order;
386 /** Import IMP::kernel::get_vertex_index
387  in the IMP namespace.*/
388 using IMP::kernel::get_vertex_index;
389 /** Import IMP::kernel::has_boost_filesystem
390  in the IMP namespace.*/
391 using IMP::kernel::has_boost_filesystem;
392 /** Import IMP::kernel::read_particles_from_buffer
393  in the IMP namespace.*/
394 using IMP::kernel::read_particles_from_buffer;
395 /** Import IMP::kernel::set_score_state_update_order
396  in the IMP namespace.*/
397 using IMP::kernel::set_score_state_update_order;
398 /** Import IMP::kernel::show_restraint_hierarchy
399  in the IMP namespace.*/
400 using IMP::kernel::show_restraint_hierarchy;
401 /** Import IMP::kernel::write_particles_to_buffer
402  in the IMP namespace.*/
403 using IMP::kernel::write_particles_to_buffer;
404 } // namespace
405 
406 /** \namespace IMP
407 
408  \brief All IMP::kernel code is brought into the IMP namespace.
409 
410  All \imp code is in the \imp namespace. For convenience and backwards
411  compatibility, the contents of IMP::kernel are hoisted into the \imp
412  namespace itself, in addition to being in the IMP::kernel namespace.
413  For now you should use the IMP namespace versions of the names.
414 */
415 
416 #endif //doxygen
417 #endif /* IMPKERNEL_DOXYGEN_H */