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.*/
21 /** Import IMP::kernel::Configuration
22  in the IMP namespace.*/
25 /** Import IMP::kernel::ConfigurationSet
26  in the IMP namespace.*/
29 /** Import IMP::kernel::Constraint
30  in the IMP namespace.*/
33 /** Import IMP::kernel::Container
34  in the IMP namespace.*/
37 /** Import IMP::kernel::Decorator
38  in the IMP namespace.*/
41 /** Import IMP::kernel::DependencyGraph
42  in the IMP namespace.*/
45 /** Import IMP::kernel::DerivativeAccumulator
46  in the IMP namespace.*/
49 /** Import IMP::kernel::EvaluationState
50  in the IMP namespace.*/
53 /** Import IMP::kernel::EvaluationStates
54  in the IMP namespace.*/
57 /** Import IMP::kernel::FloatIndex
58  in the IMP namespace.*/
61 /** Import IMP::kernel::FloatIndexes
62  in the IMP namespace.*/
65 /** Import IMP::kernel::FloatKey
66  in the IMP namespace.*/
69 /** Import IMP::kernel::FloatKeys
70  in the IMP namespace.*/
73 /** Import IMP::kernel::IntKey
74  in the IMP namespace.*/
75 typedef IMP::kernel::IntKey
77 /** Import IMP::kernel::IntKeys
78  in the IMP namespace.*/
81 /** Import IMP::kernel::Model
82  in the IMP namespace.*/
83 typedef IMP::kernel::Model
85 /** Import IMP::kernel::ModelObject
86  in the IMP namespace.*/
89 /** Import IMP::kernel::ObjectKey
90  in the IMP namespace.*/
93 /** Import IMP::kernel::ObjectKeys
94  in the IMP namespace.*/
97 /** Import IMP::kernel::Optimizer
98  in the IMP namespace.*/
101 /** Import IMP::kernel::OptimizerState
102  in the IMP namespace.*/
105 /** Import IMP::kernel::OptionParser
106  in the IMP namespace.*/
109 /** Import IMP::kernel::PairContainer
110  in the IMP namespace.*/
113 /** Import IMP::kernel::PairModifier
114  in the IMP namespace.*/
117 /** Import IMP::kernel::PairPredicate
118  in the IMP namespace.*/
121 /** Import IMP::kernel::PairScore
122  in the IMP namespace.*/
125 /** Import IMP::kernel::Particle
126  in the IMP namespace.*/
127 typedef IMP::kernel::Particle
129 /** Import IMP::kernel::ParticleIndex
130  in the IMP namespace.*/
133 /** Import IMP::kernel::ParticleIndexKey
134  in the IMP namespace.*/
137 /** Import IMP::kernel::ParticleIndexKeys
138  in the IMP namespace.*/
141 /** Import IMP::kernel::ParticleIndexPairs
142  in the IMP namespace.*/
145 /** Import IMP::kernel::ParticleIndexQuads
146  in the IMP namespace.*/
149 /** Import IMP::kernel::ParticleIndexTriplets
150  in the IMP namespace.*/
153 /** Import IMP::kernel::ParticleIndexes
154  in the IMP namespace.*/
157 /** Import IMP::kernel::ParticleIndexesKey
158  in the IMP namespace.*/
161 /** Import IMP::kernel::ParticleIndexesKeys
162  in the IMP namespace.*/
165 /** Import IMP::kernel::ParticlePair
166  in the IMP namespace.*/
169 /** Import IMP::kernel::ParticlePairsTemp
170  in the IMP namespace.*/
173 /** Import IMP::kernel::ParticleQuad
174  in the IMP namespace.*/
177 /** Import IMP::kernel::ParticleQuadsTemp
178  in the IMP namespace.*/
181 /** Import IMP::kernel::ParticleTriplet
182  in the IMP namespace.*/
185 /** Import IMP::kernel::ParticleTripletsTemp
186  in the IMP namespace.*/
189 /** Import IMP::kernel::PythonRestraint
190  in the IMP namespace.*/
193 /** Import IMP::kernel::PythonScoreState
194  in the IMP namespace.*/
197 /** Import IMP::kernel::QuadContainer
198  in the IMP namespace.*/
201 /** Import IMP::kernel::QuadModifier
202  in the IMP namespace.*/
205 /** Import IMP::kernel::QuadPredicate
206  in the IMP namespace.*/
209 /** Import IMP::kernel::QuadScore
210  in the IMP namespace.*/
213 /** Import IMP::kernel::Refiner
214  in the IMP namespace.*/
215 typedef IMP::kernel::Refiner
217 /** Import IMP::kernel::Restraint
218  in the IMP namespace.*/
221 /** Import IMP::kernel::RestraintBase
222  in the IMP namespace.*/
225 /** Import IMP::kernel::RestraintSet
226  in the IMP namespace.*/
229 /** Import IMP::kernel::RestraintStatistics
230  in the IMP namespace.*/
233 /** Import IMP::kernel::RestraintStatisticsList
234  in the IMP namespace.*/
237 /** Import IMP::kernel::Sampler
238  in the IMP namespace.*/
239 typedef IMP::kernel::Sampler
241 /** Import IMP::kernel::SaveToConfigurationSetOptimizerState
242  in the IMP namespace.*/
245 /** Import IMP::kernel::ScopedRemoveRestraint
246  in the IMP namespace.*/
249 /** Import IMP::kernel::ScopedRemoveScoreState
250  in the IMP namespace.*/
253 /** Import IMP::kernel::ScopedRestraint
254  in the IMP namespace.*/
257 /** Import IMP::kernel::ScopedScoreState
258  in the IMP namespace.*/
261 /** Import IMP::kernel::ScopedSetFloatAttribute
262  in the IMP namespace.*/
265 /** Import IMP::kernel::ScoreAccumulator
266  in the IMP namespace.*/
269 /** Import IMP::kernel::ScoreAccumulators
270  in the IMP namespace.*/
273 /** Import IMP::kernel::ScoreState
274  in the IMP namespace.*/
277 /** Import IMP::kernel::ScoreStateBase
278  in the IMP namespace.*/
281 /** Import IMP::kernel::ScoringFunction
282  in the IMP namespace.*/
285 /** Import IMP::kernel::SingletonContainer
286  in the IMP namespace.*/
289 /** Import IMP::kernel::SingletonModifier
290  in the IMP namespace.*/
293 /** Import IMP::kernel::SingletonPredicate
294  in the IMP namespace.*/
297 /** Import IMP::kernel::SingletonScore
298  in the IMP namespace.*/
301 /** Import IMP::kernel::StringKey
302  in the IMP namespace.*/
305 /** Import IMP::kernel::StringKeys
306  in the IMP namespace.*/
309 /** Import IMP::kernel::TripletContainer
310  in the IMP namespace.*/
313 /** Import IMP::kernel::TripletModifier
314  in the IMP namespace.*/
317 /** Import IMP::kernel::TripletPredicate
318  in the IMP namespace.*/
321 /** Import IMP::kernel::TripletScore
322  in the IMP namespace.*/
325 /** Import IMP::kernel::UnaryFunction
326  in the IMP namespace.*/
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.*/
338 /** Import IMP::kernel::get_dependency_graph
339  in the IMP namespace.*/
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.*/
347 /** Import IMP::kernel::get_dependent_score_states
348  in the IMP namespace.*/
350 /** Import IMP::kernel::get_indexes
351  in the IMP namespace.*/
353 /** Import IMP::kernel::get_input_containers
354  in the IMP namespace.*/
356 /** Import IMP::kernel::get_input_particles
357  in the IMP namespace.*/
359 /** Import IMP::kernel::get_output_containers
360  in the IMP namespace.*/
362 /** Import IMP::kernel::get_output_particles
363  in the IMP namespace.*/
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.*/
371 /** Import IMP::kernel::get_pruned_dependency_graph
372  in the IMP namespace.*/
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.*/
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.*/
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.*/
395 /** Import IMP::kernel::set_score_state_update_order
396  in the IMP namespace.*/
398 /** Import IMP::kernel::show_restraint_hierarchy
399  in the IMP namespace.*/
401 /** Import IMP::kernel::write_particles_to_buffer
402  in the IMP namespace.*/
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 */