IMP logo
IMP Reference Guide  2.13.0
The Integrative Modeling Platform
mpi/__init__.py
1 # This file was automatically generated by SWIG (http://www.swig.org).
2 # Version 3.0.10
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-2020 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 as _swig_python_version_info
16 if _swig_python_version_info >= (2, 7, 0):
17  def swig_import_helper():
18  import importlib
19  pkg = __name__.rpartition('.')[0]
20  mname = '.'.join((pkg, '_IMP_mpi')).lstrip('.')
21  try:
22  return importlib.import_module(mname)
23  except ImportError:
24  return importlib.import_module('_IMP_mpi')
25  _IMP_mpi = swig_import_helper()
26  del swig_import_helper
27 elif _swig_python_version_info >= (2, 6, 0):
28  def swig_import_helper():
29  from os.path import dirname
30  import imp
31  fp = None
32  try:
33  fp, pathname, description = imp.find_module('_IMP_mpi', [dirname(__file__)])
34  except ImportError:
35  import _IMP_mpi
36  return _IMP_mpi
37  if fp is not None:
38  try:
39  _mod = imp.load_module('_IMP_mpi', fp, pathname, description)
40  finally:
41  fp.close()
42  return _mod
43  _IMP_mpi = swig_import_helper()
44  del swig_import_helper
45 else:
46  import _IMP_mpi
47 del _swig_python_version_info
48 try:
49  _swig_property = property
50 except NameError:
51  pass # Python < 2.2 doesn't have 'property'.
52 
53 try:
54  import builtins as __builtin__
55 except ImportError:
56  import __builtin__
57 
58 def _swig_setattr_nondynamic(self, class_type, name, value, static=1):
59  if (name == "thisown"):
60  return self.this.own(value)
61  if (name == "this"):
62  if type(value).__name__ == 'SwigPyObject':
63  self.__dict__[name] = value
64  return
65  method = class_type.__swig_setmethods__.get(name, None)
66  if method:
67  return method(self, value)
68  if (not static):
69  object.__setattr__(self, name, value)
70  else:
71  raise AttributeError("You cannot add attributes to %s" % self)
72 
73 
74 def _swig_setattr(self, class_type, name, value):
75  return _swig_setattr_nondynamic(self, class_type, name, value, 0)
76 
77 
78 def _swig_getattr(self, class_type, name):
79  if (name == "thisown"):
80  return self.this.own()
81  method = class_type.__swig_getmethods__.get(name, None)
82  if method:
83  return method(self)
84  raise AttributeError("'%s' object has no attribute '%s'" % (class_type.__name__, name))
85 
86 
87 def _swig_repr(self):
88  try:
89  strthis = "proxy of " + self.this.__repr__()
90  except __builtin__.Exception:
91  strthis = ""
92  return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
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 __builtin__.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 IMP_DEBUG = _IMP_mpi.IMP_DEBUG
224 IMP_RELEASE = _IMP_mpi.IMP_RELEASE
225 IMP_SILENT = _IMP_mpi.IMP_SILENT
226 IMP_PROGRESS = _IMP_mpi.IMP_PROGRESS
227 IMP_TERSE = _IMP_mpi.IMP_TERSE
228 IMP_VERBOSE = _IMP_mpi.IMP_VERBOSE
229 IMP_MEMORY = _IMP_mpi.IMP_MEMORY
230 IMP_NONE = _IMP_mpi.IMP_NONE
231 IMP_USAGE = _IMP_mpi.IMP_USAGE
232 IMP_INTERNAL = _IMP_mpi.IMP_INTERNAL
233 IMP_KERNEL_HAS_LOG4CXX = _IMP_mpi.IMP_KERNEL_HAS_LOG4CXX
234 IMP_COMPILER_HAS_AUTO = _IMP_mpi.IMP_COMPILER_HAS_AUTO
235 IMP_COMPILER_HAS_DEBUG_VECTOR = _IMP_mpi.IMP_COMPILER_HAS_DEBUG_VECTOR
236 IMP_COMPILER_HAS_UNIQUE_PTR = _IMP_mpi.IMP_COMPILER_HAS_UNIQUE_PTR
237 IMP_KERNEL_HAS_BOOST_RANDOM = _IMP_mpi.IMP_KERNEL_HAS_BOOST_RANDOM
238 IMP_KERNEL_HAS_NUMPY = _IMP_mpi.IMP_KERNEL_HAS_NUMPY
239 IMP_KERNEL_HAS_GPERFTOOLS = _IMP_mpi.IMP_KERNEL_HAS_GPERFTOOLS
240 IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER = _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER
241 IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER = _IMP_mpi.IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER
242 IMPKERNEL_SHOW_WARNINGS = _IMP_mpi.IMPKERNEL_SHOW_WARNINGS
243 
244 import sys
245 class _DirectorObjects(object):
246  """@internal Simple class to keep references to director objects
247  to prevent premature deletion."""
248  def __init__(self):
249  self._objects = []
250  def register(self, obj):
251  """Take a reference to a director object; will only work for
252  refcounted C++ classes"""
253  if hasattr(obj, 'get_ref_count'):
254  self._objects.append(obj)
255  def cleanup(self):
256  """Only drop our reference and allow cleanup by Python if no other
257  Python references exist (we hold 3 references: one in self._objects,
258  one in x, and one in the argument list for getrefcount) *and* no
259  other C++ references exist (the Python object always holds one)"""
260  objs = [x for x in self._objects if sys.getrefcount(x) > 3 \
261  or x.get_ref_count() > 1]
262 # Do in two steps so the references are kept until the end of the
263 # function (deleting references may trigger a fresh call to this method)
264  self._objects = objs
265  def get_object_count(self):
266  """Get number of director objects (useful for testing only)"""
267  return len(self._objects)
268 _director_objects = _DirectorObjects()
269 
270 class _ostream(object):
271  """Proxy of C++ std::ostream class."""
272 
273  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
274 
275  def __init__(self, *args, **kwargs):
276  raise AttributeError("No constructor defined")
277  __repr__ = _swig_repr
278 
279  def write(self, osa_buf):
280  """write(_ostream self, char const * osa_buf)"""
281  return _IMP_mpi._ostream_write(self, osa_buf)
282 
283 _ostream_swigregister = _IMP_mpi._ostream_swigregister
284 _ostream_swigregister(_ostream)
285 
286 IMP_COMPILER_HAS_OVERRIDE = _IMP_mpi.IMP_COMPILER_HAS_OVERRIDE
287 IMP_COMPILER_HAS_FINAL = _IMP_mpi.IMP_COMPILER_HAS_FINAL
288 IMP_HAS_NOEXCEPT = _IMP_mpi.IMP_HAS_NOEXCEPT
289 IMP_C_OPEN_BINARY = _IMP_mpi.IMP_C_OPEN_BINARY
290 import IMP
291 IMP_MPI_HAS_BOOST_FILESYSTEM = _IMP_mpi.IMP_MPI_HAS_BOOST_FILESYSTEM
292 IMP_MPI_HAS_BOOST_PROGRAMOPTIONS = _IMP_mpi.IMP_MPI_HAS_BOOST_PROGRAMOPTIONS
293 IMP_MPI_HAS_BOOST_RANDOM = _IMP_mpi.IMP_MPI_HAS_BOOST_RANDOM
294 IMP_MPI_HAS_BOOST_SYSTEM = _IMP_mpi.IMP_MPI_HAS_BOOST_SYSTEM
295 IMP_MPI_HAS_NUMPY = _IMP_mpi.IMP_MPI_HAS_NUMPY
296 IMPMPI_SHOW_WARNINGS = _IMP_mpi.IMPMPI_SHOW_WARNINGS
297 
298 _object_types.append("ReplicaExchange")
299 
300 
301 def _object_cast_to_ReplicaExchange(o):
302  """_object_cast_to_ReplicaExchange(Object o) -> ReplicaExchange"""
303  return _IMP_mpi._object_cast_to_ReplicaExchange(o)
304 class ReplicaExchange(IMP.Object):
305  """Proxy of C++ IMP::mpi::ReplicaExchange class."""
306 
307  thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
308 
309  def __init__(self):
310  """__init__(IMP::mpi::ReplicaExchange self) -> ReplicaExchange"""
311  this = _IMP_mpi.new_ReplicaExchange()
312  try:
313  self.this.append(this)
314  except __builtin__.Exception:
315  self.this = this
316 
317  def set_my_parameter(self, key, values):
318  """set_my_parameter(ReplicaExchange self, std::string key, IMP::Floats values)"""
319  return _IMP_mpi.ReplicaExchange_set_my_parameter(self, key, values)
320 
321 
322  def get_my_parameter(self, key):
323  """get_my_parameter(ReplicaExchange self, std::string key) -> IMP::Floats"""
324  return _IMP_mpi.ReplicaExchange_get_my_parameter(self, key)
325 
326 
327  def get_friend_index(self, istep):
328  """get_friend_index(ReplicaExchange self, int istep) -> int"""
329  return _IMP_mpi.ReplicaExchange_get_friend_index(self, istep)
330 
331 
332  def get_exchange_array(self):
333  """get_exchange_array(ReplicaExchange self) -> IMP::Ints"""
334  return _IMP_mpi.ReplicaExchange_get_exchange_array(self)
335 
336 
337  def get_friend_parameter(self, key, findex):
338  """get_friend_parameter(ReplicaExchange self, std::string key, int findex) -> IMP::Floats"""
339  return _IMP_mpi.ReplicaExchange_get_friend_parameter(self, key, findex)
340 
341 
342  def do_exchange(self, myscore0, myscore1, findex):
343  """do_exchange(ReplicaExchange self, double myscore0, double myscore1, int findex) -> bool"""
344  return _IMP_mpi.ReplicaExchange_do_exchange(self, myscore0, myscore1, findex)
345 
346 
347  def create_temperatures(self, tmin, tmax, nrep):
348  """create_temperatures(ReplicaExchange self, double tmin, double tmax, int nrep) -> IMP::Floats"""
349  return _IMP_mpi.ReplicaExchange_create_temperatures(self, tmin, tmax, nrep)
350 
351 
352  def get_my_index(self):
353  """get_my_index(ReplicaExchange self) -> int"""
354  return _IMP_mpi.ReplicaExchange_get_my_index(self)
355 
356 
357  def get_number_of_replicas(self):
358  """get_number_of_replicas(ReplicaExchange self) -> int"""
359  return _IMP_mpi.ReplicaExchange_get_number_of_replicas(self)
360 
361 
362  def get_version_info(self):
363  """get_version_info(ReplicaExchange self) -> VersionInfo"""
364  return _IMP_mpi.ReplicaExchange_get_version_info(self)
365 
366 
367  def __str__(self):
368  """__str__(ReplicaExchange self) -> std::string"""
369  return _IMP_mpi.ReplicaExchange___str__(self)
370 
371 
372  def __repr__(self):
373  """__repr__(ReplicaExchange self) -> std::string"""
374  return _IMP_mpi.ReplicaExchange___repr__(self)
375 
376 
377  @staticmethod
378  def get_from(o):
379  return _object_cast_to_ReplicaExchange(o)
380 
381 ReplicaExchange_swigregister = _IMP_mpi.ReplicaExchange_swigregister
382 ReplicaExchange_swigregister(ReplicaExchange)
383 
384 
385 def get_module_version():
386  """get_module_version() -> std::string const"""
387  return _IMP_mpi.get_module_version()
388 
389 def get_example_path(fname):
390  """get_example_path(std::string fname) -> std::string"""
391  return _IMP_mpi.get_example_path(fname)
392 
393 def get_data_path(fname):
394  """get_data_path(std::string fname) -> std::string"""
395  return _IMP_mpi.get_data_path(fname)
396 
397 from . import _version_check
398 _version_check.check_version(get_module_version())
399 __version__ = get_module_version()
400 
401 
402 
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