IMP logo
IMP Reference Guide  2.18.0
The Integrative Modeling Platform
version 2.18.0
IMP.h
Go to the documentation of this file.
1 /**
2  * \file IMP.h
3  * \brief Include all non-deprecated headers in IMP.
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMP_H
9 #define IMP_H
10 #include <IMP/Array.h>
11 #include <IMP/AttributeOptimizer.h>
12 #include <IMP/Configuration.h>
13 #include <IMP/ConfigurationSet.h>
14 #include <IMP/ConstVector.h>
15 #include <IMP/Constraint.h>
16 #include <IMP/CreateLogContext.h>
17 #include <IMP/Decorator.h>
18 #include <IMP/DerivativeAccumulator.h>
19 #include <IMP/Flag.h>
20 #include <IMP/FloatIndex.h>
21 #include <IMP/Index.h>
22 #include <IMP/InputAdaptor.h>
23 #include <IMP/Key.h>
24 #include <IMP/Model.h>
25 #include <IMP/ModelObject.h>
26 #include <IMP/NonCopyable.h>
27 #include <IMP/Object.h>
28 #include <IMP/Optimizer.h>
29 #include <IMP/OptimizerState.h>
30 #include <IMP/Particle.h>
31 #include <IMP/Pointer.h>
32 #include <IMP/RAII.h>
33 #include <IMP/Refiner.h>
34 #include <IMP/Restraint.h>
35 #include <IMP/RestraintInfo.h>
36 #include <IMP/RestraintSet.h>
37 #include <IMP/Sampler.h>
38 #include <IMP/ScoreAccumulator.h>
39 #include <IMP/ScoreState.h>
40 #include <IMP/ScoringFunction.h>
41 #include <IMP/SetCheckState.h>
42 #include <IMP/SetLogState.h>
43 #include <IMP/Showable.h>
44 #include <IMP/UnaryFunction.h>
45 #include <IMP/Undecorator.h>
46 #include <IMP/Value.h>
47 #include <IMP/Vector.h>
48 #include <IMP/VersionInfo.h>
49 #include <IMP/WarningContext.h>
50 #include <IMP/WeakPointer.h>
51 #include <IMP/base_macros.h>
52 #include <IMP/base_types.h>
53 #include <IMP/base_utility.h>
54 #include <IMP/bracket_macros.h>
55 #include <IMP/cache.h>
56 #include <IMP/check_macros.h>
57 #include <IMP/comparison_macros.h>
58 #include <IMP/compiler_macros.h>
59 #include <IMP/constants.h>
60 #include <IMP/container_base.h>
61 #include <IMP/container_macros.h>
62 #include <IMP/decorator_macros.h>
63 #include <IMP/dependency_graph.h>
64 #include <IMP/deprecation.h>
65 #include <IMP/deprecation_macros.h>
66 #include <IMP/doxygen_macros.h>
67 #include <IMP/enums.h>
68 #include <IMP/exception.h>
69 #include <IMP/file.h>
70 #include <IMP/flags.h>
71 #include <IMP/functor.h>
72 #include <IMP/generic.h>
73 #include <IMP/graph_macros.h>
74 #include <IMP/hash.h>
75 #include <IMP/hash_macros.h>
76 #include <IMP/input_output.h>
77 #include <IMP/io.h>
78 #include <IMP/live_objects.h>
79 #include <IMP/log.h>
80 #include <IMP/log_macros.h>
81 #include <IMP/macros.h>
82 #include <IMP/math.h>
83 #include <IMP/model_object_helpers.h>
84 #include <IMP/object_cast.h>
85 #include <IMP/object_macros.h>
86 #include <IMP/particle_index.h>
87 #include <IMP/python_only.h>
88 #include <IMP/raii_macros.h>
89 #include <IMP/random.h>
90 #include <IMP/random_utils.h>
91 #include <IMP/ref_counted_macros.h>
92 #include <IMP/scoped.h>
93 #include <IMP/set_map_macros.h>
94 #include <IMP/showable_macros.h>
95 #include <IMP/swap_macros.h>
96 #include <IMP/swig_macros.h>
97 #include <IMP/thread_macros.h>
98 #include <IMP/threads.h>
99 #include <IMP/tuple_macros.h>
100 #include <IMP/types.h>
101 #include <IMP/utility.h>
102 #include <IMP/utility_macros.h>
103 #include <IMP/value_macros.h>
104 #include <IMP/vector_property_map.h>
105 #include <IMP/warning_macros.h>
106 #ifdef IMP_SWIG_WRAPPER
107 #include <IMP/nullptr.h>
108 #include <IMP/nullptr_macros.h>
109 #endif
110 #include <IMP/SingletonContainer.h>
111 #include <IMP/SingletonDerivativeModifier.h>
112 #include <IMP/SingletonModifier.h>
113 #include <IMP/SingletonPredicate.h>
114 #include <IMP/SingletonScore.h>
115 #include <IMP/singleton_macros.h>
116 #include <IMP/PairContainer.h>
117 #include <IMP/PairDerivativeModifier.h>
118 #include <IMP/PairModifier.h>
119 #include <IMP/PairPredicate.h>
120 #include <IMP/PairScore.h>
121 #include <IMP/pair_macros.h>
122 #include <IMP/TripletContainer.h>
123 #include <IMP/TripletDerivativeModifier.h>
124 #include <IMP/TripletModifier.h>
125 #include <IMP/TripletPredicate.h>
126 #include <IMP/TripletScore.h>
127 #include <IMP/triplet_macros.h>
128 #include <IMP/QuadContainer.h>
129 #include <IMP/QuadDerivativeModifier.h>
130 #include <IMP/QuadModifier.h>
131 #include <IMP/QuadPredicate.h>
132 #include <IMP/QuadScore.h>
133 #include <IMP/quad_macros.h>
134 #endif /* IMP_H */
swig_macros.h
Macros to hide code from SWIG.
math.h
Helper functions to check for NaN or infinity.
Decorator.h
The base class for decorators.
SingletonModifier.h
A Modifier on ParticlesTemp.
deprecation_macros.h
Control display of deprecation information.
object_macros.h
Helper macros for implementing IMP Objects.
scoped.h
Temporarily set particle attributes.
ref_counted_macros.h
Macros to help with reference counting.
QuadPredicate.h
Define QuadPredicate.
types.h
Basic types used by IMP.
vector_property_map.h
Include the correct headers to get the boost vector_property_map.
SetLogState.h
A class to change and restore log state.
base_types.h
Basic types used by IMP.
deprecation.h
Control display of deprecation information.
ScoreAccumulator.h
Class for adding scores from restraints to the model.
Index.h
Utility types to refer to various types of indices.
pair_macros.h
Macros for various classes.
PairDerivativeModifier.h
A Modifier on ParticlePairsTemp.
SingletonContainer.h
A container for Singletons.
RestraintSet.h
Used to hold a set of related restraints.
python_only.h
Helper functions for Python.
ConstVector.h
Store an array of values of the same type.
NonCopyable.h
Base class for all objects that cannot be copied.
particle_index.h
Functions and adaptors for dealing with particle indexes.
comparison_macros.h
Helper macros for implementing comparisons of IMP objects.
random_utils.h
Random number utility functions used by IMP.
TripletContainer.h
A container for Triplets.
triplet_macros.h
Macros for various classes.
constants.h
Various useful constants.
Undecorator.h
The base class for undecorators.
TripletPredicate.h
Define TripletPredicate.
UnaryFunction.h
Single variable function.
DerivativeAccumulator.h
Class for adding derivatives from restraints to the model.
Model.h
Storage of a model, its restraints, constraints and particles.
hash.h
Helper functions for implementing hashes.
quad_macros.h
Macros for various classes.
QuadContainer.h
A container for Quads.
file.h
Handling of file input/output.
singleton_macros.h
Macros for various classes.
Showable.h
Helper class to aid in output of IMP classes to streams.
io.h
Write/read the state of the particles to/from a buffer in memory.
Key.h
Keys to cache lookup of attribute strings.
swap_macros.h
Macros to help with swapping two objects.
tuple_macros.h
Macros to help in defining tuple classes.
exception.h
Exception definitions and assertions.
macros.h
Various general useful macros for IMP.
Array.h
Classes to handle static sized arrays of things.
doxygen_macros.h
Helper macros for writing doxygen documentation.
Optimizer.h
Base class for all optimizers.
threads.h
Control for using multiple threads in IMP.
set_map_macros.h
Macros to choose the best set or map for different purposes.
container_macros.h
Macros to define containers of objects.
FloatIndex.h
A FloatIndex identifies an optimized attribute in a model.
RAII.h
Basic types used by IMP.
SingletonPredicate.h
Define SingletonPredicate.
bracket_macros.h
Macros to handle array indexing.
PairContainer.h
A container for Pairs.
InputAdaptor.h
Convenience class to accept multiple input types.
nullptr.h
Provide a nullptr keyword analog.
input_output.h
Utility functions to track input/output particles of model objects.
TripletDerivativeModifier.h
A Modifier on ParticleTripletsTemp.
Refiner.h
Refine a particle into a list of particles.
warning_macros.h
Macros to control compiler warnings.
cache.h
Helper classes for various types of caching.
PairPredicate.h
Define PairPredicate.
hash_macros.h
Helper macros for implementing hashable classes.
SingletonDerivativeModifier.h
A Modifier on ParticlesTemp.
log_macros.h
Logging and error reporting support.
model_object_helpers.h
Classes used in the construction of ModelObjects.
QuadModifier.h
A Modifier on ParticleQuadsTemp.
PairScore.h
Define PairScore.
Sampler.h
Base class for all samplers.
utility_macros.h
Various general useful macros for IMP.
TripletScore.h
Define TripletScore.
decorator_macros.h
Helper macros for implementing Decorators.
Flag.h
Utility classes to add command line flags.
live_objects.h
A shared base class to help in debugging and things.
PairModifier.h
A Modifier on ParticlePairsTemp.
WeakPointer.h
A weak pointer to an Object or RefCountedObject.
functor.h
Helper functionality for functors.
Constraint.h
A base class for constraints.
ScoreState.h
Shared score state.
Vector.h
A class for storing lists of IMP items.
SingletonScore.h
Define SingletonScore.
utility.h
For backwards compatibility.
ModelObject.h
Base class for objects in a Model that depend on other objects.
SetCheckState.h
Checking and error reporting support.
Particle.h
Classes to handle individual model particles. (Note that implementation of inline functions is in int...
enums.h
Basic enumeration types used by IMP.
QuadScore.h
Define QuadScore.
container_base.h
Abstract base class for containers of particles.
graph_macros.h
Helper macros for handling graphs.
Pointer.h
A nullptr-initialized pointer to an IMP Object.
CreateLogContext.h
Logging and error reporting support.
check_macros.h
Helper macros for throwing and handling exceptions.
Object.h
A shared base class to help in debugging and things.
ScoringFunction.h
Represents a scoring function on the model.
Value.h
Base class for a simple primitive-like type.
RestraintInfo.h
Report key:value information on restraints.
flags.h
Support for shared command line flags.
object_cast.h
Up (or down) cast an IMP Object-derived class.
value_macros.h
Macros to help in implementing Value objects.
Restraint.h
Abstract base class for all restraints.
compiler_macros.h
Various compiler workarounds.
AttributeOptimizer.h
Base class for optimizers that act on individual attributes.
ConfigurationSet.h
Store a set of configurations of the model.
Configuration.h
Store a set of configurations of the model.
OptimizerState.h
Shared optimizer state.
random.h
Random number generators used by IMP.
thread_macros.h
Control for OpenMP.
QuadDerivativeModifier.h
A Modifier on ParticleQuadsTemp.
log.h
Logging and error reporting support.
nullptr_macros.h
Provide a nullptr keyword analog.
base_utility.h
Various general useful functions for IMP.
VersionInfo.h
Version and authorship of IMP objects.
dependency_graph.h
Build dependency graphs on models.
TripletModifier.h
A Modifier on ParticleTripletsTemp.
showable_macros.h
Macros to help with objects that can be printed to a stream.
raii_macros.h
Macros to aid in writing RAII-style classes.
WarningContext.h
Logging and error reporting support.
base_macros.h
Various general useful macros for IMP.
generic.h
Compile-time generic restraint and constraint support.