IMP logo
IMP Reference Guide  2.15.0
The Integrative Modeling Platform
mpi/__init__.py
1 # This file was automatically generated by SWIG (http://www.swig.org).
2 # Version 3.0.7
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 # This wrapper is part of IMP,
8 # Copyright 2007-2021 IMP Inventors. All rights reserved.
9 
10 from __future__ import print_function, division, absolute_import
11 
12 
13 
14 
15 from sys import version_info
16 if version_info >= (2, 6, 0):
17  def swig_import_helper():
18  from os.path import dirname
19  import imp
20  fp = None
21  try:
22  fp, pathname, description = imp.find_module('_IMP_mpi', [dirname(__file__)])
23  except ImportError:
24  import _IMP_mpi
25  return _IMP_mpi
26  if fp is not None:
27  try:
28  _mod = imp.load_module('_IMP_mpi', fp, pathname, description)
29  finally:
30  fp.close()
31  return _mod
32  _IMP_mpi = swig_import_helper()
33  del swig_import_helper
34 else:
35  import _IMP_mpi
36 del version_info
37 try:
38  _swig_property = property
39 except NameError:
40  pass # Python < 2.2 doesn't have 'property'.
41 
42 
43 def _swig_setattr_nondynamic(self, class_type, name, value, static=1):
44  if (name == "thisown"):
45  return self.this.own(value)
46  if (name == "this"):
47  if type(value).__name__ == 'SwigPyObject':
48  self.__dict__[name] = value
49  return
50  method = class_type.__swig_setmethods__.get(name, None)
51  if method:
52  return method(self, value)
53  if (not static):
54  object.__setattr__(self, name, value)
55  else:
56  raise AttributeError("You cannot add attributes to %s" % self)
57 
58 
59 def _swig_setattr(self, class_type, name, value):
60  return _swig_setattr_nondynamic(self, class_type, name, value, 0)
61 
62 
63 def _swig_getattr_nondynamic(self, class_type, name, static=1):
64  if (name == "thisown"):
65  return self.this.own()
66  method = class_type.__swig_getmethods__.get(name, None)
67  if method:
68  return method(self)
69  if (not static):
70  return object.__getattr__(self, name)
71  else:
72  raise AttributeError(name)
73 
74 def _swig_getattr(self, class_type, name):
75  return _swig_getattr_nondynamic(self, class_type, name, 0)
76 
77 
78 def _swig_repr(self):
79  try:
80  strthis = "proxy of " + self.this.__repr__()
81  except:
82  strthis = ""
83  return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
84 
85 try:
86  _object = object
87  _newclass = 1
88 except AttributeError:
89  class _object:
90  pass
91  _newclass = 0
92 
93 
94 
95 def _swig_setattr_nondynamic_method(set):
96  def set_attr(self, name, value):
97  if (name == "thisown"):
98  return self.this.own(value)
99  if hasattr(self, name) or (name == "this"):
100  set(self, name, value)
101  else:
102  raise AttributeError("You cannot add attributes to %s" % self)
103  return set_attr
104 
105 
106 try:
107  import weakref
108  weakref_proxy = weakref.proxy
109 except:
110  weakref_proxy = lambda x: x
111 
112 
113 class IMP_MPI_SwigPyIterator(object):
114  """Proxy of C++ swig::IMP_MPI_SwigPyIterator class"""
115  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
116 
117  def __init__(self, *args, **kwargs):
118  raise AttributeError("No constructor defined - class is abstract")
119  __repr__ = _swig_repr
120  __swig_destroy__ = _IMP_mpi.delete_IMP_MPI_SwigPyIterator
121  __del__ = lambda self: None
122 
123  def value(self):
124  """value(IMP_MPI_SwigPyIterator self) -> PyObject *"""
125  return _IMP_mpi.IMP_MPI_SwigPyIterator_value(self)
126 
127 
128  def incr(self, n=1):
129  """
130  incr(IMP_MPI_SwigPyIterator self, size_t n=1) -> IMP_MPI_SwigPyIterator
131  incr(IMP_MPI_SwigPyIterator self) -> IMP_MPI_SwigPyIterator
132  """
133  return _IMP_mpi.IMP_MPI_SwigPyIterator_incr(self, n)
134 
135 
136  def decr(self, n=1):
137  """
138  decr(IMP_MPI_SwigPyIterator self, size_t n=1) -> IMP_MPI_SwigPyIterator
139  decr(IMP_MPI_SwigPyIterator self) -> IMP_MPI_SwigPyIterator
140  """
141  return _IMP_mpi.IMP_MPI_SwigPyIterator_decr(self, n)
142 
143 
144  def distance(self, x):
145  """distance(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> ptrdiff_t"""
146  return _IMP_mpi.IMP_MPI_SwigPyIterator_distance(self, x)
147 
148 
149  def equal(self, x):
150  """equal(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> bool"""
151  return _IMP_mpi.IMP_MPI_SwigPyIterator_equal(self, x)
152 
153 
154  def copy(self):
155  """copy(IMP_MPI_SwigPyIterator self) -> IMP_MPI_SwigPyIterator"""
156  return _IMP_mpi.IMP_MPI_SwigPyIterator_copy(self)
157 
158 
159  def next(self):
160  """next(IMP_MPI_SwigPyIterator self) -> PyObject *"""
161  return _IMP_mpi.IMP_MPI_SwigPyIterator_next(self)
162 
163 
164  def __next__(self):
165  """__next__(IMP_MPI_SwigPyIterator self) -> PyObject *"""
166  return _IMP_mpi.IMP_MPI_SwigPyIterator___next__(self)
167 
168 
169  def previous(self):
170  """previous(IMP_MPI_SwigPyIterator self) -> PyObject *"""
171  return _IMP_mpi.IMP_MPI_SwigPyIterator_previous(self)
172 
173 
174  def advance(self, n):
175  """advance(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
176  return _IMP_mpi.IMP_MPI_SwigPyIterator_advance(self, n)
177 
178 
179  def __eq__(self, x):
180  """__eq__(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> bool"""
181  return _IMP_mpi.IMP_MPI_SwigPyIterator___eq__(self, x)
182 
183 
184  def __ne__(self, x):
185  """__ne__(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> bool"""
186  return _IMP_mpi.IMP_MPI_SwigPyIterator___ne__(self, x)
187 
188 
189  def __iadd__(self, n):
190  """__iadd__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
191  return _IMP_mpi.IMP_MPI_SwigPyIterator___iadd__(self, n)
192 
193 
194  def __isub__(self, n):
195  """__isub__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
196  return _IMP_mpi.IMP_MPI_SwigPyIterator___isub__(self, n)
197 
198 
199  def __add__(self, n):
200  """__add__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
201  return _IMP_mpi.IMP_MPI_SwigPyIterator___add__(self, n)
202 
203 
204  def __sub__(self, *args):
205  """
206  __sub__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator
207  __sub__(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> ptrdiff_t
208  """
209  return _IMP_mpi.IMP_MPI_SwigPyIterator___sub__(self, *args)
210 
211  def __iter__(self):
212  return self
213 IMP_MPI_SwigPyIterator_swigregister = _IMP_mpi.IMP_MPI_SwigPyIterator_swigregister
214 IMP_MPI_SwigPyIterator_swigregister(IMP_MPI_SwigPyIterator)
215 
216 
217 _value_types=[]
218 _object_types=[]
219 _raii_types=[]
220 _plural_types=[]
221 
222 
223 _IMP_mpi.IMP_DEBUG_swigconstant(_IMP_mpi)
224 IMP_DEBUG = _IMP_mpi.IMP_DEBUG
225 
226 _IMP_mpi.IMP_RELEASE_swigconstant(_IMP_mpi)
227 IMP_RELEASE = _IMP_mpi.IMP_RELEASE
228 
229 _IMP_mpi.IMP_SILENT_swigconstant(_IMP_mpi)
230 IMP_SILENT = _IMP_mpi.IMP_SILENT
231 
232 _IMP_mpi.IMP_PROGRESS_swigconstant(_IMP_mpi)
233 IMP_PROGRESS = _IMP_mpi.IMP_PROGRESS
234 
235 _IMP_mpi.IMP_TERSE_swigconstant(_IMP_mpi)
236 IMP_TERSE = _IMP_mpi.IMP_TERSE
237 
238 _IMP_mpi.IMP_VERBOSE_swigconstant(_IMP_mpi)
239 IMP_VERBOSE = _IMP_mpi.IMP_VERBOSE
240 
241 _IMP_mpi.IMP_MEMORY_swigconstant(_IMP_mpi)
242 IMP_MEMORY = _IMP_mpi.IMP_MEMORY
243 
244 _IMP_mpi.IMP_NONE_swigconstant(_IMP_mpi)
245 IMP_NONE = _IMP_mpi.IMP_NONE
246 
247 _IMP_mpi.IMP_USAGE_swigconstant(_IMP_mpi)
248 IMP_USAGE = _IMP_mpi.IMP_USAGE
249 
250 _IMP_mpi.IMP_INTERNAL_swigconstant(_IMP_mpi)
251 IMP_INTERNAL = _IMP_mpi.IMP_INTERNAL
252 
253 _IMP_mpi.IMP_KERNEL_HAS_LOG4CXX_swigconstant(_IMP_mpi)
254 IMP_KERNEL_HAS_LOG4CXX = _IMP_mpi.IMP_KERNEL_HAS_LOG4CXX
255 
256 _IMP_mpi.IMP_COMPILER_HAS_AUTO_swigconstant(_IMP_mpi)
257 IMP_COMPILER_HAS_AUTO = _IMP_mpi.IMP_COMPILER_HAS_AUTO
258 
259 _IMP_mpi.IMP_COMPILER_HAS_DEBUG_VECTOR_swigconstant(_IMP_mpi)
260 IMP_COMPILER_HAS_DEBUG_VECTOR = _IMP_mpi.IMP_COMPILER_HAS_DEBUG_VECTOR
261 
262 _IMP_mpi.IMP_COMPILER_HAS_UNIQUE_PTR_swigconstant(_IMP_mpi)
263 IMP_COMPILER_HAS_UNIQUE_PTR = _IMP_mpi.IMP_COMPILER_HAS_UNIQUE_PTR
264 
265 _IMP_mpi.IMP_KERNEL_HAS_BOOST_RANDOM_swigconstant(_IMP_mpi)
266 IMP_KERNEL_HAS_BOOST_RANDOM = _IMP_mpi.IMP_KERNEL_HAS_BOOST_RANDOM
267 
268 _IMP_mpi.IMP_KERNEL_HAS_NUMPY_swigconstant(_IMP_mpi)
269 IMP_KERNEL_HAS_NUMPY = _IMP_mpi.IMP_KERNEL_HAS_NUMPY
270 
271 _IMP_mpi.IMP_KERNEL_HAS_GPERFTOOLS_swigconstant(_IMP_mpi)
272 IMP_KERNEL_HAS_GPERFTOOLS = _IMP_mpi.IMP_KERNEL_HAS_GPERFTOOLS
273 
274 _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER_swigconstant(_IMP_mpi)
275 IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER = _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER
276 
277 _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER_swigconstant(_IMP_mpi)
278 IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER = _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER
279 
280 _IMP_mpi.IMPKERNEL_SHOW_WARNINGS_swigconstant(_IMP_mpi)
281 IMPKERNEL_SHOW_WARNINGS = _IMP_mpi.IMPKERNEL_SHOW_WARNINGS
282 
283 import sys
284 class _DirectorObjects(object):
285  """@internal Simple class to keep references to director objects
286  to prevent premature deletion."""
287  def __init__(self):
288  self._objects = []
289  def register(self, obj):
290  """Take a reference to a director object; will only work for
291  refcounted C++ classes"""
292  if hasattr(obj, 'get_ref_count'):
293  self._objects.append(obj)
294  def cleanup(self):
295  """Only drop our reference and allow cleanup by Python if no other
296  Python references exist (we hold 3 references: one in self._objects,
297  one in x, and one in the argument list for getrefcount) *and* no
298  other C++ references exist (the Python object always holds one)"""
299  objs = [x for x in self._objects if sys.getrefcount(x) > 3 \
300  or x.get_ref_count() > 1]
301 # Do in two steps so the references are kept until the end of the
302 # function (deleting references may trigger a fresh call to this method)
303  self._objects = objs
304  def get_object_count(self):
305  """Get number of director objects (useful for testing only)"""
306  return len(self._objects)
307 _director_objects = _DirectorObjects()
308 
309 class _ostream(object):
310  """Proxy of C++ std::ostream class"""
311  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
312 
313  def __init__(self, *args, **kwargs):
314  raise AttributeError("No constructor defined")
315  __repr__ = _swig_repr
316 
317  def write(self, osa_buf):
318  """write(_ostream self, char const * osa_buf)"""
319  return _IMP_mpi._ostream_write(self, osa_buf)
320 
321 _ostream_swigregister = _IMP_mpi._ostream_swigregister
322 _ostream_swigregister(_ostream)
323 
324 
325 _IMP_mpi.IMP_COMPILER_HAS_OVERRIDE_swigconstant(_IMP_mpi)
326 IMP_COMPILER_HAS_OVERRIDE = _IMP_mpi.IMP_COMPILER_HAS_OVERRIDE
327 
328 _IMP_mpi.IMP_COMPILER_HAS_FINAL_swigconstant(_IMP_mpi)
329 IMP_COMPILER_HAS_FINAL = _IMP_mpi.IMP_COMPILER_HAS_FINAL
330 
331 _IMP_mpi.IMP_HAS_NOEXCEPT_swigconstant(_IMP_mpi)
332 IMP_HAS_NOEXCEPT = _IMP_mpi.IMP_HAS_NOEXCEPT
333 
334 _IMP_mpi.IMP_C_OPEN_BINARY_swigconstant(_IMP_mpi)
335 IMP_C_OPEN_BINARY = _IMP_mpi.IMP_C_OPEN_BINARY
336 import IMP
337 
338 _IMP_mpi.IMP_MPI_HAS_BOOST_FILESYSTEM_swigconstant(_IMP_mpi)
339 IMP_MPI_HAS_BOOST_FILESYSTEM = _IMP_mpi.IMP_MPI_HAS_BOOST_FILESYSTEM
340 
341 _IMP_mpi.IMP_MPI_HAS_BOOST_PROGRAMOPTIONS_swigconstant(_IMP_mpi)
342 IMP_MPI_HAS_BOOST_PROGRAMOPTIONS = _IMP_mpi.IMP_MPI_HAS_BOOST_PROGRAMOPTIONS
343 
344 _IMP_mpi.IMP_MPI_HAS_BOOST_RANDOM_swigconstant(_IMP_mpi)
345 IMP_MPI_HAS_BOOST_RANDOM = _IMP_mpi.IMP_MPI_HAS_BOOST_RANDOM
346 
347 _IMP_mpi.IMP_MPI_HAS_BOOST_SYSTEM_swigconstant(_IMP_mpi)
348 IMP_MPI_HAS_BOOST_SYSTEM = _IMP_mpi.IMP_MPI_HAS_BOOST_SYSTEM
349 
350 _IMP_mpi.IMP_MPI_HAS_NUMPY_swigconstant(_IMP_mpi)
351 IMP_MPI_HAS_NUMPY = _IMP_mpi.IMP_MPI_HAS_NUMPY
352 
353 _IMP_mpi.IMPMPI_SHOW_WARNINGS_swigconstant(_IMP_mpi)
354 IMPMPI_SHOW_WARNINGS = _IMP_mpi.IMPMPI_SHOW_WARNINGS
355 
356 _object_types.append("ReplicaExchange")
357 
358 
359 def _object_cast_to_ReplicaExchange(o):
360  """_object_cast_to_ReplicaExchange(Object o) -> ReplicaExchange"""
361  return _IMP_mpi._object_cast_to_ReplicaExchange(o)
362 class ReplicaExchange(IMP.Object):
363  """Proxy of C++ IMP::mpi::ReplicaExchange class"""
364  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
365 
366  def __init__(self):
367  """__init__(IMP::mpi::ReplicaExchange self) -> ReplicaExchange"""
368  this = _IMP_mpi.new_ReplicaExchange()
369  try:
370  self.this.append(this)
371  except:
372  self.this = this
373 
374  def set_my_parameter(self, key, values):
375  """set_my_parameter(ReplicaExchange self, std::string key, IMP::Floats values)"""
376  return _IMP_mpi.ReplicaExchange_set_my_parameter(self, key, values)
377 
378 
379  def get_my_parameter(self, key):
380  """get_my_parameter(ReplicaExchange self, std::string key) -> IMP::Floats"""
381  return _IMP_mpi.ReplicaExchange_get_my_parameter(self, key)
382 
383 
384  def get_friend_index(self, istep):
385  """get_friend_index(ReplicaExchange self, int istep) -> int"""
386  return _IMP_mpi.ReplicaExchange_get_friend_index(self, istep)
387 
388 
389  def get_exchange_array(self):
390  """get_exchange_array(ReplicaExchange self) -> IMP::Ints"""
391  return _IMP_mpi.ReplicaExchange_get_exchange_array(self)
392 
393 
394  def get_friend_parameter(self, key, findex):
395  """get_friend_parameter(ReplicaExchange self, std::string key, int findex) -> IMP::Floats"""
396  return _IMP_mpi.ReplicaExchange_get_friend_parameter(self, key, findex)
397 
398 
399  def do_exchange(self, myscore0, myscore1, findex):
400  """do_exchange(ReplicaExchange self, double myscore0, double myscore1, int findex) -> bool"""
401  return _IMP_mpi.ReplicaExchange_do_exchange(self, myscore0, myscore1, findex)
402 
403 
404  def create_temperatures(self, tmin, tmax, nrep):
405  """create_temperatures(ReplicaExchange self, double tmin, double tmax, int nrep) -> IMP::Floats"""
406  return _IMP_mpi.ReplicaExchange_create_temperatures(self, tmin, tmax, nrep)
407 
408 
409  def get_my_index(self):
410  """get_my_index(ReplicaExchange self) -> int"""
411  return _IMP_mpi.ReplicaExchange_get_my_index(self)
412 
413 
414  def get_number_of_replicas(self):
415  """get_number_of_replicas(ReplicaExchange self) -> int"""
416  return _IMP_mpi.ReplicaExchange_get_number_of_replicas(self)
417 
418 
419  def get_version_info(self):
420  """get_version_info(ReplicaExchange self) -> VersionInfo"""
421  return _IMP_mpi.ReplicaExchange_get_version_info(self)
422 
423 
424  def __str__(self):
425  """__str__(ReplicaExchange self) -> std::string"""
426  return _IMP_mpi.ReplicaExchange___str__(self)
427 
428 
429  def __repr__(self):
430  """__repr__(ReplicaExchange self) -> std::string"""
431  return _IMP_mpi.ReplicaExchange___repr__(self)
432 
433 
434  @staticmethod
435  def get_from(o):
436  return _object_cast_to_ReplicaExchange(o)
437 
438 ReplicaExchange_swigregister = _IMP_mpi.ReplicaExchange_swigregister
439 ReplicaExchange_swigregister(ReplicaExchange)
440 
441 
442 def get_module_version():
443  """get_module_version() -> std::string const"""
444  return _IMP_mpi.get_module_version()
445 
446 def get_example_path(fname):
447  """get_example_path(std::string fname) -> std::string"""
448  return _IMP_mpi.get_example_path(fname)
449 
450 def get_data_path(fname):
451  """get_data_path(std::string fname) -> std::string"""
452  return _IMP_mpi.get_data_path(fname)
453 
454 from . import _version_check
455 _version_check.check_version(get_module_version())
456 __version__ = get_module_version()
457 
458 
459 
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.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
Common base class for heavy weight IMP objects.
Definition: Object.h:106