Changeset ff7119b in sasmodels for sasmodels/dll.py

Timestamp:

Aug 26, 2014 8:27:06 PM (10 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

5d4777d

Parents:

a7684e5

Message:

docu update

File:

• sasmodels/dll.py (modified) (3 diffs)

sasmodels/dll.py

@@ -26 +26 @@
     for single and 'd', 'float64' or 'double' for double.  Double precision
     is an optional extension which may not be available on all devices.
+
+    Call :meth:`release` when done with the kernel.
     """
     def __init__(self, dllpath, info):
@@ -69 +71 @@
         return DllInput(q_vectors)
 
+    def release(self):
+        pass # TODO: should release the dll
+
 
 class DllInput(object):
@@ -100 +105 @@
 
 class DllKernel(object):
+    """
+    Callable SAS kernel.
+
+    *kernel* is the DllKernel object to call.
+
+    *info* is the module information
+
+    *input* is the DllInput q vectors at which the kernel should be
+    evaluated.
+
+    The resulting call method takes the *pars*, a list of values for
+    the fixed parameters to the kernel, and *pd_pars*, a list of (value,weight)
+    vectors for the polydisperse parameters.  *cutoff* determines the
+    integration limits: any points with combined weight less than *cutoff*
+    will not be calculated.
+
+    Call :meth:`release` when done with the kernel instance.
+    """
     def __init__(self, kernel, info, input):
         self.input = input
         self.kernel = kernel
-        self.info = info
         self.res = np.empty(input.nq, input.dtype)
         dim = '2d' if input.is_2D else '1d'