IMP logo
IMP Reference Guide  develop.36b5e40f34,2024/10/14
The Integrative Modeling Platform
statistics_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-467/imp-20241014.develop.36b5e40f34/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-467/imp-20241014.develop.36b5e40f34/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/statistics/statistics_config.h
7  * \brief Provide macros to mark functions and classes as exported
8  * from a DLL/.so, and to set up namespaces
9  *
10  * When building the module, IMPSTATISTICS_EXPORTS should be defined, and when
11  * using the module externally, it should not be. Classes and functions
12  * declared in the module's headers should then be marked with
13  * IMPSTATISTICSEXPORT if they are intended to be part of the API and
14  * they are not defined entirely in a header.
15  *
16  * The Windows build environment requires applications to mark exports in
17  * this way; we use the same markings to set the visibility of ELF symbols
18  * if we have compiler support.
19  *
20  * All code in this module should live in the IMP::statistics namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPSTATISTICS_BEGIN_NAMESPACE and IMPSTATISTICS_END_NAMESPACE macros.
23  * There are similar macros for module code that is designed to be for
24  * internal use only.
25  *
26  * Copyright 2007-2022 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPSTATISTICS_CONFIG_H
31 #define IMPSTATISTICS_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPSTATISTICS_EXPORTS
40 #define IMPSTATISTICSEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPSTATISTICSEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPSTATISTICSEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPSTATISTICSEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPSTATISTICS_EXPORTS
57 
58 #define IMPSTATISTICS_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPSTATISTICS_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPSTATISTICS_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPSTATISTICS_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace statistics {
77 
78 #define IMPSTATISTICS_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPSTATISTICS_BEGIN_INTERNAL_NAMESPACE IMPSTATISTICS_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPSTATISTICS_END_INTERNAL_NAMESPACE } IMPSTATISTICS_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPSTATISTICS_BEGIN_NAMESPACE namespace IMP{ namespace statistics {
88 
89 #define IMPSTATISTICS_END_NAMESPACE } }
90 
91 #define IMPSTATISTICS_BEGIN_INTERNAL_NAMESPACE IMPSTATISTICS_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPSTATISTICS_END_INTERNAL_NAMESPACE } IMPSTATISTICS_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_STATISTICS_USE_IMP_CGAL
99 #define IMP_STATISTICS_HAS_IMP_CGAL 1
100 #define IMP_STATISTICS_USE_BOOST_FILESYSTEM
101 #define IMP_STATISTICS_HAS_BOOST_FILESYSTEM 1
102 #define IMP_STATISTICS_USE_BOOST_PROGRAMOPTIONS
103 #define IMP_STATISTICS_HAS_BOOST_PROGRAMOPTIONS 1
104 #define IMP_STATISTICS_USE_BOOST_RANDOM
105 #define IMP_STATISTICS_HAS_BOOST_RANDOM 1
106 #define IMP_STATISTICS_USE_BOOST_SYSTEM
107 #define IMP_STATISTICS_HAS_BOOST_SYSTEM 1
108 #define IMP_STATISTICS_USE_CGAL
109 #define IMP_STATISTICS_HAS_CGAL 1
110 #define IMP_STATISTICS_USE_NUMPY
111 #define IMP_STATISTICS_HAS_NUMPY 1
112 
113 // functions are defined explicitly for SWIG
114 namespace IMP{ namespace statistics {
115 /** \name Standard module functions
116  All \imp modules have a set of standard functions to help get information
117  about the module and about files associated with the module.
118  @{
119  */
120 #if !defined(SWIG)
121  IMPSTATISTICSEXPORT std::string get_module_version();
122 #endif
123 
124 #if !defined(SWIG)
125  // SWIG will whine about duplicate definitions of function
126  inline std::string get_module_name() { return "IMP::statistics"; }
127 #endif
128 
129  //! Return the full path to one of this module's data files
130  /** To read the data file "data_library" that was placed in the \c data
131  directory of this module, do something like
132  \code
133  std::ifstream in(IMP::statistics::get_data_path("data_library"));
134  \endcode
135  This will ensure that the code works both when IMP is installed or
136  if used via the \c setup_environment.sh script.
137 
138  \note Each module has its own data directory, so be sure to use
139  this function from the correct module.
140  */
141 #if !defined(SWIG)
142  IMPSTATISTICSEXPORT std::string get_data_path(std::string file_name);
143 #endif
144 
145  //! Return the full path to one of this module's example files
146  /** To read the example file "example_protein.pdb" that was placed
147  in the \c examples directory of this module, do something like
148  \code
149  std::ifstream in(IMP::statistics::get_example_path("example_protein.pdb"));
150  \endcode
151  This will ensure that the code works both when IMP is installed or
152  if used via the \c setup_environment.sh script.
153 
154  \note Each module has its own example directory, so be sure to use
155  this function from the correct module.
156  */
157 #if !defined(SWIG)
158  IMPSTATISTICSEXPORT std::string get_example_path(std::string file_name);
159 #endif
160  /** @} */
161 
162 
163 } } //namespace
164 
165 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
166 
167 #include <IMP/Showable.h>
168 #include <IMP/hash.h>
169 
170 namespace IMP{ namespace statistics {
171 using ::IMP::Showable;
172 using ::IMP::operator<<;
173 using ::IMP::hash_value;
174 } } // namespace
175 namespace IMP{ namespace statistics { namespace internal {
176 using ::IMP::Showable;
177 using ::IMP::operator<<;
178 using ::IMP::hash_value;
179 } } } // namespace
180 
181 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
182 
183 
184 #include <IMP/compiler_macros.h>
185 
186 #endif /* IMPSTATISTICS_CONFIG_H */
187 
188 // Here so it is always parsed
189 
190 #ifdef IMPSTATISTICS_DEPRECATED_HEADER
191 #undef IMPSTATISTICS_DEPRECATED_HEADER
192 #undef IMPSTATISTICS_DEPRECATED_VALUE_DEF
193 #undef IMPSTATISTICS_DEPRECATED_VALUE_DECL
194 #undef IMPSTATISTICS_DEPRECATED_OBJECT_DEF
195 #undef IMPSTATISTICS_DEPRECATED_OBJECT_DECL
196 #undef IMPSTATISTICS_DEPRECATED_FUNCTION_DEF
197 #undef IMPSTATISTICS_DEPRECATED_FUNCTION_DECL
198 #undef IMPSTATISTICS_DEPRECATED_METHOD_DEF
199 #undef IMPSTATISTICS_DEPRECATED_METHOD_DECL
200 #undef IMPSTATISTICS_DEPRECATED_MACRO
201 #undef IMPSTATISTICS_SHOW_WARNINGS
202 #endif
203 
204 // the central modules we can update easily, so don't warn in them
205 #if defined( IMPSTATISTICS_COMPILATION) \
206  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
207  || defined( IMPSTATISTICS_ALL) || defined(IMP_DOXYGEN) \
208  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
209  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
210  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
211  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
212  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
213  || defined(IMPGSL_COMPILATION)
214 #define IMPSTATISTICS_SHOW_WARNINGS 0
215 #else
216 #define IMPSTATISTICS_SHOW_WARNINGS 1
217 #endif
218 
219 // suppress header warnings with all header, SWIG wrapper and in the module
220 #if IMPSTATISTICS_SHOW_WARNINGS
221 #define IMPSTATISTICS_DEPRECATED_HEADER(version, help_message) \
222  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
223 #define IMPSTATISTICS_DEPRECATED_VALUE_DECL(version) \
224  IMP_DEPRECATED_ATTRIBUTE
225 #define IMPSTATISTICS_DEPRECATED_OBJECT_DECL(version) \
226  IMP_DEPRECATED_ATTRIBUTE
227 #define IMPSTATISTICS_DEPRECATED_FUNCTION_DECL(version) \
228  IMP_DEPRECATED_ATTRIBUTE
229 #define IMPSTATISTICS_DEPRECATED_METHOD_DECL(version) \
230  IMP_DEPRECATED_ATTRIBUTE
231 
232 #else //IMPSTATISTICS_SHOW_WARNINGS
233 /** See [deprecation support](@ref deprecation). */
234 #define IMPSTATISTICS_DEPRECATED_HEADER(version, help_message) \
235 /** See [deprecation support](@ref deprecation). */
236 #define IMPSTATISTICS_DEPRECATED_VALUE_DECL(version)
237 /** See [deprecation support](@ref deprecation). */
238 #define IMPSTATISTICS_DEPRECATED_OBJECT_DECL(version)
239 /** See [deprecation support](@ref deprecation). */
240 #define IMPSTATISTICS_DEPRECATED_FUNCTION_DECL(version)
241 /** See [deprecation support](@ref deprecation). */
242 #define IMPSTATISTICS_DEPRECATED_METHOD_DECL(version)
243 
244 #endif // IMPSTATISTICS_SHOW_WARNINGS
245 
246 // only warn about it in the all inclusion to cut down on copies
247 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
248  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
249  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
250  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
251  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
252  || defined(IMPSCOREFUNCTOR_COMPILATION)
253 /** See [deprecation support](@ref deprecation). */
254 #define IMPSTATISTICS_DEPRECATED_MACRO(version, message)
255 
256 #else
257 #define IMPSTATISTICS_DEPRECATED_MACRO(version, message) \
258  IMP_DEPRECATED_MACRO(version, message)
259 #endif
260 
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPSTATISTICS_DEPRECATED_VALUE_DEF(version, message) \
263  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
264 
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPSTATISTICS_DEPRECATED_OBJECT_DEF(version, message) \
267  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
268 
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPSTATISTICS_DEPRECATED_FUNCTION_DEF(version, message) \
271  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
272 
273 /** See [deprecation support](@ref deprecation). */
274 #define IMPSTATISTICS_DEPRECATED_METHOD_DEF(version, message) \
275  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
276 
277 
278 #include <IMP/compiler_macros.h>
279 
280 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
281 IMP_COMPILER_ENABLE_WARNINGS
282 #define IMP_EXECUTABLE_WARNINGS
283 #endif
Helper functions for implementing hashes.
Helper class to aid in output of IMP classes to streams.
std::string get_module_version()
Return the version of this module, as a string.
Various compiler workarounds.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.