IMP logo
IMP Reference Guide  2.6.2
The Integrative Modeling Platform
mpi/__init__.py
1 # This file was automatically generated by SWIG (http://www.swig.org).
2 # Version 3.0.8
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-2016 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 Exception:
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 Exception:
110  weakref_proxy = lambda x: x
111 
112 
113 class IMP_MPI_SwigPyIterator(object):
114  """Proxy of C++ swig::IMP_MPI_SwigPyIterator class."""
115 
116  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
117 
118  def __init__(self, *args, **kwargs):
119  raise AttributeError("No constructor defined - class is abstract")
120  __repr__ = _swig_repr
121  __swig_destroy__ = _IMP_mpi.delete_IMP_MPI_SwigPyIterator
122  __del__ = lambda self: None
123 
124  def value(self):
125  """value(IMP_MPI_SwigPyIterator self) -> PyObject *"""
126  return _IMP_mpi.IMP_MPI_SwigPyIterator_value(self)
127 
128 
129  def incr(self, n=1):
130  """
131  incr(IMP_MPI_SwigPyIterator self, size_t n=1) -> IMP_MPI_SwigPyIterator
132  incr(IMP_MPI_SwigPyIterator self) -> IMP_MPI_SwigPyIterator
133  """
134  return _IMP_mpi.IMP_MPI_SwigPyIterator_incr(self, n)
135 
136 
137  def decr(self, n=1):
138  """
139  decr(IMP_MPI_SwigPyIterator self, size_t n=1) -> IMP_MPI_SwigPyIterator
140  decr(IMP_MPI_SwigPyIterator self) -> IMP_MPI_SwigPyIterator
141  """
142  return _IMP_mpi.IMP_MPI_SwigPyIterator_decr(self, n)
143 
144 
145  def distance(self, x):
146  """distance(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> ptrdiff_t"""
147  return _IMP_mpi.IMP_MPI_SwigPyIterator_distance(self, x)
148 
149 
150  def equal(self, x):
151  """equal(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> bool"""
152  return _IMP_mpi.IMP_MPI_SwigPyIterator_equal(self, x)
153 
154 
155  def copy(self):
156  """copy(IMP_MPI_SwigPyIterator self) -> IMP_MPI_SwigPyIterator"""
157  return _IMP_mpi.IMP_MPI_SwigPyIterator_copy(self)
158 
159 
160  def next(self):
161  """next(IMP_MPI_SwigPyIterator self) -> PyObject *"""
162  return _IMP_mpi.IMP_MPI_SwigPyIterator_next(self)
163 
164 
165  def __next__(self):
166  """__next__(IMP_MPI_SwigPyIterator self) -> PyObject *"""
167  return _IMP_mpi.IMP_MPI_SwigPyIterator___next__(self)
168 
169 
170  def previous(self):
171  """previous(IMP_MPI_SwigPyIterator self) -> PyObject *"""
172  return _IMP_mpi.IMP_MPI_SwigPyIterator_previous(self)
173 
174 
175  def advance(self, n):
176  """advance(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
177  return _IMP_mpi.IMP_MPI_SwigPyIterator_advance(self, n)
178 
179 
180  def __eq__(self, x):
181  """__eq__(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> bool"""
182  return _IMP_mpi.IMP_MPI_SwigPyIterator___eq__(self, x)
183 
184 
185  def __ne__(self, x):
186  """__ne__(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> bool"""
187  return _IMP_mpi.IMP_MPI_SwigPyIterator___ne__(self, x)
188 
189 
190  def __iadd__(self, n):
191  """__iadd__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
192  return _IMP_mpi.IMP_MPI_SwigPyIterator___iadd__(self, n)
193 
194 
195  def __isub__(self, n):
196  """__isub__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
197  return _IMP_mpi.IMP_MPI_SwigPyIterator___isub__(self, n)
198 
199 
200  def __add__(self, n):
201  """__add__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator"""
202  return _IMP_mpi.IMP_MPI_SwigPyIterator___add__(self, n)
203 
204 
205  def __sub__(self, *args):
206  """
207  __sub__(IMP_MPI_SwigPyIterator self, ptrdiff_t n) -> IMP_MPI_SwigPyIterator
208  __sub__(IMP_MPI_SwigPyIterator self, IMP_MPI_SwigPyIterator x) -> ptrdiff_t
209  """
210  return _IMP_mpi.IMP_MPI_SwigPyIterator___sub__(self, *args)
211 
212  def __iter__(self):
213  return self
214 IMP_MPI_SwigPyIterator_swigregister = _IMP_mpi.IMP_MPI_SwigPyIterator_swigregister
215 IMP_MPI_SwigPyIterator_swigregister(IMP_MPI_SwigPyIterator)
216 
217 
218 _value_types=[]
219 _object_types=[]
220 _raii_types=[]
221 _plural_types=[]
222 
223 
224 _IMP_mpi.IMP_DEBUG_swigconstant(_IMP_mpi)
225 IMP_DEBUG = _IMP_mpi.IMP_DEBUG
226 
227 _IMP_mpi.IMP_RELEASE_swigconstant(_IMP_mpi)
228 IMP_RELEASE = _IMP_mpi.IMP_RELEASE
229 
230 _IMP_mpi.IMP_SILENT_swigconstant(_IMP_mpi)
231 IMP_SILENT = _IMP_mpi.IMP_SILENT
232 
233 _IMP_mpi.IMP_PROGRESS_swigconstant(_IMP_mpi)
234 IMP_PROGRESS = _IMP_mpi.IMP_PROGRESS
235 
236 _IMP_mpi.IMP_TERSE_swigconstant(_IMP_mpi)
237 IMP_TERSE = _IMP_mpi.IMP_TERSE
238 
239 _IMP_mpi.IMP_VERBOSE_swigconstant(_IMP_mpi)
240 IMP_VERBOSE = _IMP_mpi.IMP_VERBOSE
241 
242 _IMP_mpi.IMP_MEMORY_swigconstant(_IMP_mpi)
243 IMP_MEMORY = _IMP_mpi.IMP_MEMORY
244 
245 _IMP_mpi.IMP_NONE_swigconstant(_IMP_mpi)
246 IMP_NONE = _IMP_mpi.IMP_NONE
247 
248 _IMP_mpi.IMP_USAGE_swigconstant(_IMP_mpi)
249 IMP_USAGE = _IMP_mpi.IMP_USAGE
250 
251 _IMP_mpi.IMP_INTERNAL_swigconstant(_IMP_mpi)
252 IMP_INTERNAL = _IMP_mpi.IMP_INTERNAL
253 
254 _IMP_mpi.IMP_KERNEL_HAS_LOG4CXX_swigconstant(_IMP_mpi)
255 IMP_KERNEL_HAS_LOG4CXX = _IMP_mpi.IMP_KERNEL_HAS_LOG4CXX
256 
257 _IMP_mpi.IMP_COMPILER_HAS_AUTO_swigconstant(_IMP_mpi)
258 IMP_COMPILER_HAS_AUTO = _IMP_mpi.IMP_COMPILER_HAS_AUTO
259 
260 _IMP_mpi.IMP_COMPILER_HAS_DEBUG_VECTOR_swigconstant(_IMP_mpi)
261 IMP_COMPILER_HAS_DEBUG_VECTOR = _IMP_mpi.IMP_COMPILER_HAS_DEBUG_VECTOR
262 
263 _IMP_mpi.IMP_COMPILER_HAS_UNIQUE_PTR_swigconstant(_IMP_mpi)
264 IMP_COMPILER_HAS_UNIQUE_PTR = _IMP_mpi.IMP_COMPILER_HAS_UNIQUE_PTR
265 
266 _IMP_mpi.IMP_KERNEL_HAS_BOOST_RANDOM_swigconstant(_IMP_mpi)
267 IMP_KERNEL_HAS_BOOST_RANDOM = _IMP_mpi.IMP_KERNEL_HAS_BOOST_RANDOM
268 
269 _IMP_mpi.IMP_KERNEL_HAS_GPERFTOOLS_swigconstant(_IMP_mpi)
270 IMP_KERNEL_HAS_GPERFTOOLS = _IMP_mpi.IMP_KERNEL_HAS_GPERFTOOLS
271 
272 _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER_swigconstant(_IMP_mpi)
273 IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER = _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER
274 
275 _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER_swigconstant(_IMP_mpi)
276 IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER = _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER
277 
278 _IMP_mpi.IMPKERNEL_SHOW_WARNINGS_swigconstant(_IMP_mpi)
279 IMPKERNEL_SHOW_WARNINGS = _IMP_mpi.IMPKERNEL_SHOW_WARNINGS
280 
281 import sys
282 class _DirectorObjects(object):
283  """@internal Simple class to keep references to director objects
284  to prevent premature deletion."""
285  def __init__(self):
286  self._objects = []
287  def register(self, obj):
288  """Take a reference to a director object; will only work for
289  refcounted C++ classes"""
290  if hasattr(obj, 'get_ref_count'):
291  self._objects.append(obj)
292  def cleanup(self):
293  """Only drop our reference and allow cleanup by Python if no other
294  Python references exist (we hold 3 references: one in self._objects,
295  one in x, and one in the argument list for getrefcount) *and* no
296  other C++ references exist (the Python object always holds one)"""
297  objs = [x for x in self._objects if sys.getrefcount(x) > 3 \
298  or x.get_ref_count() > 1]
299 # Do in two steps so the references are kept until the end of the
300 # function (deleting references may trigger a fresh call to this method)
301  self._objects = objs
302  def get_object_count(self):
303  """Get number of director objects (useful for testing only)"""
304  return len(self._objects)
305 _director_objects = _DirectorObjects()
306 
307 class _ostream(object):
308  """Proxy of C++ std::ostream class."""
309 
310  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
311 
312  def __init__(self, *args, **kwargs):
313  raise AttributeError("No constructor defined")
314  __repr__ = _swig_repr
315 
316  def write(self, osa_buf):
317  """write(_ostream self, char const * osa_buf)"""
318  return _IMP_mpi._ostream_write(self, osa_buf)
319 
320 _ostream_swigregister = _IMP_mpi._ostream_swigregister
321 _ostream_swigregister(_ostream)
322 
323 
324 _IMP_mpi.IMP_COMPILER_HAS_OVERRIDE_swigconstant(_IMP_mpi)
325 IMP_COMPILER_HAS_OVERRIDE = _IMP_mpi.IMP_COMPILER_HAS_OVERRIDE
326 
327 _IMP_mpi.IMP_COMPILER_HAS_FINAL_swigconstant(_IMP_mpi)
328 IMP_COMPILER_HAS_FINAL = _IMP_mpi.IMP_COMPILER_HAS_FINAL
329 
330 _IMP_mpi.IMP_HAS_NOEXCEPT_swigconstant(_IMP_mpi)
331 IMP_HAS_NOEXCEPT = _IMP_mpi.IMP_HAS_NOEXCEPT
332 import IMP
333 
334 _IMP_mpi.IMP_MPI_HAS_BOOST_FILESYSTEM_swigconstant(_IMP_mpi)
335 IMP_MPI_HAS_BOOST_FILESYSTEM = _IMP_mpi.IMP_MPI_HAS_BOOST_FILESYSTEM
336 
337 _IMP_mpi.IMP_MPI_HAS_BOOST_PROGRAMOPTIONS_swigconstant(_IMP_mpi)
338 IMP_MPI_HAS_BOOST_PROGRAMOPTIONS = _IMP_mpi.IMP_MPI_HAS_BOOST_PROGRAMOPTIONS
339 
340 _IMP_mpi.IMP_MPI_HAS_BOOST_RANDOM_swigconstant(_IMP_mpi)
341 IMP_MPI_HAS_BOOST_RANDOM = _IMP_mpi.IMP_MPI_HAS_BOOST_RANDOM
342 
343 _IMP_mpi.IMP_MPI_HAS_BOOST_SYSTEM_swigconstant(_IMP_mpi)
344 IMP_MPI_HAS_BOOST_SYSTEM = _IMP_mpi.IMP_MPI_HAS_BOOST_SYSTEM
345 
346 _IMP_mpi.IMPMPI_SHOW_WARNINGS_swigconstant(_IMP_mpi)
347 IMPMPI_SHOW_WARNINGS = _IMP_mpi.IMPMPI_SHOW_WARNINGS
348 
349 _object_types.append("ReplicaExchange")
350 
351 
352 def _object_cast_to_ReplicaExchange(o):
353  """_object_cast_to_ReplicaExchange(Object o) -> ReplicaExchange"""
354  return _IMP_mpi._object_cast_to_ReplicaExchange(o)
355 class ReplicaExchange(IMP.Object):
356  """Proxy of C++ IMP::mpi::ReplicaExchange class."""
357 
358  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
359 
360  def __init__(self):
361  """__init__(IMP::mpi::ReplicaExchange self) -> ReplicaExchange"""
362  this = _IMP_mpi.new_ReplicaExchange()
363  try:
364  self.this.append(this)
365  except Exception:
366  self.this = this
367 
368  def set_my_parameter(self, key, values):
369  """set_my_parameter(ReplicaExchange self, std::string key, IMP::Floats values)"""
370  return _IMP_mpi.ReplicaExchange_set_my_parameter(self, key, values)
371 
372 
373  def get_my_parameter(self, key):
374  """get_my_parameter(ReplicaExchange self, std::string key) -> IMP::Floats"""
375  return _IMP_mpi.ReplicaExchange_get_my_parameter(self, key)
376 
377 
378  def get_friend_index(self, istep):
379  """get_friend_index(ReplicaExchange self, int istep) -> int"""
380  return _IMP_mpi.ReplicaExchange_get_friend_index(self, istep)
381 
382 
383  def get_exchange_array(self):
384  """get_exchange_array(ReplicaExchange self) -> IMP::Ints"""
385  return _IMP_mpi.ReplicaExchange_get_exchange_array(self)
386 
387 
388  def get_friend_parameter(self, key, findex):
389  """get_friend_parameter(ReplicaExchange self, std::string key, int findex) -> IMP::Floats"""
390  return _IMP_mpi.ReplicaExchange_get_friend_parameter(self, key, findex)
391 
392 
393  def do_exchange(self, myscore0, myscore1, findex):
394  """do_exchange(ReplicaExchange self, double myscore0, double myscore1, int findex) -> bool"""
395  return _IMP_mpi.ReplicaExchange_do_exchange(self, myscore0, myscore1, findex)
396 
397 
398  def create_temperatures(self, tmin, tmax, nrep):
399  """create_temperatures(ReplicaExchange self, double tmin, double tmax, int nrep) -> IMP::Floats"""
400  return _IMP_mpi.ReplicaExchange_create_temperatures(self, tmin, tmax, nrep)
401 
402 
403  def get_my_index(self):
404  """get_my_index(ReplicaExchange self) -> int"""
405  return _IMP_mpi.ReplicaExchange_get_my_index(self)
406 
407 
408  def get_number_of_replicas(self):
409  """get_number_of_replicas(ReplicaExchange self) -> int"""
410  return _IMP_mpi.ReplicaExchange_get_number_of_replicas(self)
411 
412 
413  def get_version_info(self):
414  """get_version_info(ReplicaExchange self) -> VersionInfo"""
415  return _IMP_mpi.ReplicaExchange_get_version_info(self)
416 
417 
418  def __str__(self):
419  """__str__(ReplicaExchange self) -> std::string"""
420  return _IMP_mpi.ReplicaExchange___str__(self)
421 
422 
423  def __repr__(self):
424  """__repr__(ReplicaExchange self) -> std::string"""
425  return _IMP_mpi.ReplicaExchange___repr__(self)
426 
427 
428  @staticmethod
429  def get_from(o):
430  return _object_cast_to_ReplicaExchange(o)
431 
432 ReplicaExchange_swigregister = _IMP_mpi.ReplicaExchange_swigregister
433 ReplicaExchange_swigregister(ReplicaExchange)
434 
435 
436 def get_module_version():
437  """get_module_version() -> std::string const"""
438  return _IMP_mpi.get_module_version()
439 
440 def get_example_path(fname):
441  """get_example_path(std::string fname) -> std::string"""
442  return _IMP_mpi.get_example_path(fname)
443 
444 def get_data_path(fname):
445  """get_data_path(std::string fname) -> std::string"""
446  return _IMP_mpi.get_data_path(fname)
447 
448 from . import _version_check
449 _version_check.check_version(get_module_version())
450 __version__ = get_module_version()
451 
452 
453 
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.
Common base class for heavy weight IMP objects.
Definition: Object.h:106