IMP logo
IMP Reference Guide  develop.50fdd7fa33,2025/08/31
The Integrative Modeling Platform
benchmark/__init__.py
1 # This file was automatically generated by SWIG (https://www.swig.org).
2 # Version 4.3.1
3 #
4 # Do not make changes to this file unless you know what you are doing - modify
5 # the SWIG interface file instead.
6 
7 
8 # This wrapper is part of IMP,
9 # Copyright 2007-2025 IMP Inventors. All rights reserved.
10 
11 
12 
13 
14 from sys import version_info as _swig_python_version_info
15 import _IMP_benchmark
16 
17 try:
18  import builtins as __builtin__
19 except ImportError:
20  import __builtin__
21 
22 def _swig_repr(self):
23  try:
24  strthis = "proxy of " + self.this.__repr__()
25  except __builtin__.Exception:
26  strthis = ""
27  return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
28 
29 
30 def _swig_setattr_nondynamic_instance_variable(set):
31  def set_instance_attr(self, name, value):
32  if name == "this":
33  set(self, name, value)
34  elif name == "thisown":
35  self.this.own(value)
36  elif hasattr(self, name) and isinstance(getattr(type(self), name), property):
37  set(self, name, value)
38  else:
39  raise AttributeError("You cannot add instance attributes to %s" % self)
40  return set_instance_attr
41 
42 
43 def _swig_setattr_nondynamic_class_variable(set):
44  def set_class_attr(cls, name, value):
45  if hasattr(cls, name) and not isinstance(getattr(cls, name), property):
46  set(cls, name, value)
47  else:
48  raise AttributeError("You cannot add class attributes to %s" % cls)
49  return set_class_attr
50 
51 
52 def _swig_add_metaclass(metaclass):
53  """Class decorator for adding a metaclass to a SWIG wrapped class - a slimmed down version of six.add_metaclass"""
54  def wrapper(cls):
55  return metaclass(cls.__name__, cls.__bases__, cls.__dict__.copy())
56  return wrapper
57 
58 
59 class _SwigNonDynamicMeta(type):
60  """Meta class to enforce nondynamic attributes (no new attributes) for a class"""
61  __setattr__ = _swig_setattr_nondynamic_class_variable(type.__setattr__)
62 
63 
64 import weakref
65 
66 class IMP_BENCHMARK_SwigPyIterator(object):
67  r"""Proxy of C++ swig::IMP_BENCHMARK_SwigPyIterator class."""
68 
69  thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
70 
71  def __init__(self, *args, **kwargs):
72  raise AttributeError("No constructor defined - class is abstract")
73  __repr__ = _swig_repr
74  __swig_destroy__ = _IMP_benchmark.delete_IMP_BENCHMARK_SwigPyIterator
75 
76  def value(self):
77  r"""value(IMP_BENCHMARK_SwigPyIterator self) -> PyObject *"""
78  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_value(self)
79 
80  def incr(self, n=1):
81  r"""incr(IMP_BENCHMARK_SwigPyIterator self, size_t n=1) -> IMP_BENCHMARK_SwigPyIterator"""
82  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_incr(self, n)
83 
84  def decr(self, n=1):
85  r"""decr(IMP_BENCHMARK_SwigPyIterator self, size_t n=1) -> IMP_BENCHMARK_SwigPyIterator"""
86  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_decr(self, n)
87 
88  def distance(self, x):
89  r"""distance(IMP_BENCHMARK_SwigPyIterator self, IMP_BENCHMARK_SwigPyIterator x) -> ptrdiff_t"""
90  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_distance(self, x)
91 
92  def equal(self, x):
93  r"""equal(IMP_BENCHMARK_SwigPyIterator self, IMP_BENCHMARK_SwigPyIterator x) -> bool"""
94  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_equal(self, x)
95 
96  def copy(self):
97  r"""copy(IMP_BENCHMARK_SwigPyIterator self) -> IMP_BENCHMARK_SwigPyIterator"""
98  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_copy(self)
99 
100  def next(self):
101  r"""next(IMP_BENCHMARK_SwigPyIterator self) -> PyObject *"""
102  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_next(self)
103 
104  def __next__(self):
105  r"""__next__(IMP_BENCHMARK_SwigPyIterator self) -> PyObject *"""
106  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___next__(self)
107 
108  def previous(self):
109  r"""previous(IMP_BENCHMARK_SwigPyIterator self) -> PyObject *"""
110  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_previous(self)
111 
112  def advance(self, n):
113  r"""advance(IMP_BENCHMARK_SwigPyIterator self, ptrdiff_t n) -> IMP_BENCHMARK_SwigPyIterator"""
114  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_advance(self, n)
115 
116  def __eq__(self, x):
117  r"""__eq__(IMP_BENCHMARK_SwigPyIterator self, IMP_BENCHMARK_SwigPyIterator x) -> bool"""
118  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___eq__(self, x)
119 
120  def __ne__(self, x):
121  r"""__ne__(IMP_BENCHMARK_SwigPyIterator self, IMP_BENCHMARK_SwigPyIterator x) -> bool"""
122  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___ne__(self, x)
123 
124  def __iadd__(self, n):
125  r"""__iadd__(IMP_BENCHMARK_SwigPyIterator self, ptrdiff_t n) -> IMP_BENCHMARK_SwigPyIterator"""
126  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___iadd__(self, n)
127 
128  def __isub__(self, n):
129  r"""__isub__(IMP_BENCHMARK_SwigPyIterator self, ptrdiff_t n) -> IMP_BENCHMARK_SwigPyIterator"""
130  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___isub__(self, n)
131 
132  def __add__(self, n):
133  r"""__add__(IMP_BENCHMARK_SwigPyIterator self, ptrdiff_t n) -> IMP_BENCHMARK_SwigPyIterator"""
134  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___add__(self, n)
135 
136  def __sub__(self, *args):
137  r"""
138  __sub__(IMP_BENCHMARK_SwigPyIterator self, ptrdiff_t n) -> IMP_BENCHMARK_SwigPyIterator
139  __sub__(IMP_BENCHMARK_SwigPyIterator self, IMP_BENCHMARK_SwigPyIterator x) -> ptrdiff_t
140  """
141  return _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator___sub__(self, *args)
142  def __iter__(self):
143  return self
144 
145 # Register IMP_BENCHMARK_SwigPyIterator in _IMP_benchmark:
146 _IMP_benchmark.IMP_BENCHMARK_SwigPyIterator_swigregister(IMP_BENCHMARK_SwigPyIterator)
147 
148 _value_types=[]
149 _object_types=[]
150 _raii_types=[]
151 _plural_types=[]
152 
153 IMP_DEBUG = _IMP_benchmark.IMP_DEBUG
154 
155 IMP_RELEASE = _IMP_benchmark.IMP_RELEASE
156 
157 IMP_SILENT = _IMP_benchmark.IMP_SILENT
158 
159 IMP_PROGRESS = _IMP_benchmark.IMP_PROGRESS
160 
161 IMP_TERSE = _IMP_benchmark.IMP_TERSE
162 
163 IMP_VERBOSE = _IMP_benchmark.IMP_VERBOSE
164 
165 IMP_MEMORY = _IMP_benchmark.IMP_MEMORY
166 
167 IMP_NONE = _IMP_benchmark.IMP_NONE
168 
169 IMP_USAGE = _IMP_benchmark.IMP_USAGE
170 
171 IMP_INTERNAL = _IMP_benchmark.IMP_INTERNAL
172 
173 IMP_KERNEL_HAS_LOG4CXX = _IMP_benchmark.IMP_KERNEL_HAS_LOG4CXX
174 
175 IMP_COMPILER_HAS_CEREAL_RAW_POINTER = _IMP_benchmark.IMP_COMPILER_HAS_CEREAL_RAW_POINTER
176 
177 IMP_COMPILER_HAS_DEBUG_VECTOR = _IMP_benchmark.IMP_COMPILER_HAS_DEBUG_VECTOR
178 
179 IMP_COMPILER_HAS_RANDOM_SHUFFLE = _IMP_benchmark.IMP_COMPILER_HAS_RANDOM_SHUFFLE
180 
181 IMP_COMPILER_HAS_THREE_WAY = _IMP_benchmark.IMP_COMPILER_HAS_THREE_WAY
182 
183 IMP_KERNEL_HAS_BOOST_RANDOM = _IMP_benchmark.IMP_KERNEL_HAS_BOOST_RANDOM
184 
185 IMP_KERNEL_HAS_NUMPY = _IMP_benchmark.IMP_KERNEL_HAS_NUMPY
186 
187 IMP_KERNEL_HAS_BOOST_SYSTEM = _IMP_benchmark.IMP_KERNEL_HAS_BOOST_SYSTEM
188 
189 IMP_KERNEL_HAS_GPERFTOOLS = _IMP_benchmark.IMP_KERNEL_HAS_GPERFTOOLS
190 
191 IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER = _IMP_benchmark.IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER
192 
193 IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER = _IMP_benchmark.IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER
194 
195 IMPKERNEL_SHOW_WARNINGS = _IMP_benchmark.IMPKERNEL_SHOW_WARNINGS
196 
197 
198 import sys
199 class _DirectorObjects:
200  """@internal Simple class to keep references to director objects
201  to prevent premature deletion."""
202  def __init__(self):
203  self._objects = []
204  def register(self, obj):
205  """Take a reference to a director object; will only work for
206  refcounted C++ classes"""
207  if hasattr(obj, 'get_ref_count'):
208  self._objects.append(obj)
209  def cleanup(self):
210  """Only drop our reference and allow cleanup by Python if no other
211  Python references exist (we hold 3 references: one in self._objects,
212  one in x, and one in the argument list for getrefcount) *and* no
213  other C++ references exist (the Python object always holds one)"""
214  objs = [x for x in self._objects if sys.getrefcount(x) > 3 \
215  or x.get_ref_count() > 1]
216 # Do in two steps so the references are kept until the end of the
217 # function (deleting references may trigger a fresh call to this method)
218  self._objects = objs
219  def get_object_count(self):
220  """Get number of director objects (useful for testing only)"""
221  return len(self._objects)
222 _director_objects = _DirectorObjects()
223 
224 class _ostream(object):
225  r"""Proxy of C++ std::ostream class."""
226 
227  thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
228 
229  def __init__(self, *args, **kwargs):
230  raise AttributeError("No constructor defined")
231  __repr__ = _swig_repr
232 
233  def write(self, osa_buf):
234  r"""write(_ostream self, char const * osa_buf)"""
235  return _IMP_benchmark._ostream_write(self, osa_buf)
236 
237 # Register _ostream in _IMP_benchmark:
238 _IMP_benchmark._ostream_swigregister(_ostream)
239 IMP_C_OPEN_BINARY = _IMP_benchmark.IMP_C_OPEN_BINARY
240 
241 import IMP
242 IMP_BENCHMARK_HAS_BOOST_FILESYSTEM = _IMP_benchmark.IMP_BENCHMARK_HAS_BOOST_FILESYSTEM
243 
244 IMP_BENCHMARK_HAS_BOOST_PROGRAMOPTIONS = _IMP_benchmark.IMP_BENCHMARK_HAS_BOOST_PROGRAMOPTIONS
245 
246 IMP_BENCHMARK_HAS_BOOST_RANDOM = _IMP_benchmark.IMP_BENCHMARK_HAS_BOOST_RANDOM
247 
248 IMP_BENCHMARK_HAS_NUMPY = _IMP_benchmark.IMP_BENCHMARK_HAS_NUMPY
249 
250 IMPBENCHMARK_SHOW_WARNINGS = _IMP_benchmark.IMPBENCHMARK_SHOW_WARNINGS
251 
252 
253 _raii_types.append("Profiler")
254 
255 
256 def report(*args):
257  r"""
258  report(std::string benchmark, std::string algorithm, double time, double check)
259  report(std::string benchmark, double time, double check)
260  """
261  return _IMP_benchmark.report(*args)
262 
263 def get_return_value():
264  r"""get_return_value() -> int"""
265  return _IMP_benchmark.get_return_value()
266 class Profiler(IMP._RAII):
267  r"""Proxy of C++ IMP::benchmark::Profiler class."""
268 
269  thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
270 
271  def __init__(self, *args):
272  r"""
273  __init__(Profiler self) -> Profiler
274  __init__(Profiler self, std::string name) -> Profiler
275  """
276  _IMP_benchmark.Profiler_swiginit(self, _IMP_benchmark.new_Profiler(*args))
277 
278  def set(self, name):
279  r"""set(Profiler self, std::string name)"""
280  return _IMP_benchmark.Profiler_set(self, name)
281 
282  def reset(self):
283  r"""reset(Profiler self)"""
284  return _IMP_benchmark.Profiler_reset(self)
285  __swig_destroy__ = _IMP_benchmark.delete_Profiler
286 
287  def show(self, *args):
288  r"""show(Profiler self, _ostream out=std::cout)"""
289  return _IMP_benchmark.Profiler_show(self, *args)
290 
291  def __enter__(self):
292  return self
293  def __exit__(self, exc_type, exc_val, exc_tb):
294  self.reset()
295  return False
296 
297 
298  def __str__(self):
299  r"""__str__(Profiler self) -> std::string"""
300  return _IMP_benchmark.Profiler___str__(self)
301 
302  def __repr__(self):
303  r"""__repr__(Profiler self) -> std::string"""
304  return _IMP_benchmark.Profiler___repr__(self)
305 
306 # Register Profiler in _IMP_benchmark:
307 _IMP_benchmark.Profiler_swigregister(Profiler)
308 
309 def get_module_name():
310  r"""get_module_name() -> std::string const"""
311  return _IMP_benchmark.get_module_name()
312 
313 def get_module_version():
314  r"""get_module_version() -> std::string const"""
315  return _IMP_benchmark.get_module_version()
316 
317 def get_example_path(fname):
318  r"""get_example_path(std::string fname) -> std::string"""
319  return _IMP_benchmark.get_example_path(fname)
320 
321 def get_data_path(fname):
322  r"""get_data_path(std::string fname) -> std::string"""
323  return _IMP_benchmark.get_data_path(fname)
324 
325 from . import _version_check
326 _version_check.check_version(get_module_version())
327 __version__ = get_module_version()
328 
329 
void report(std::string benchmark, std::string algorithm, double time, double check)
Report a benchmark result in a standard way.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
std::ostream & show(Hierarchy h, std::ostream &out=std::cout)
Print the hierarchy using a given decorator to display each node.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
std::string get_module_version()
Return the version of this module, as a string.