Changeset 5110

Timestamp:

Dec 6, 2021 4:56:47 PM (2 years ago)

Author:

toby

Message:

constraint comments

Location:

trunk

Files:

• GSASIImapvars.py (modified) (3 diffs)
• GSASIIobj.py (modified) (1 diff)

trunk/GSASIImapvars.py

@@ -373 +373 @@
 
 The output from :func:`ProcessConstraints` will have the form as below, 
-where the first entry is a "Const", the second is a "New Var" and the final is a "Hold". 
+where the first entry is a "Const" and the second is a "New Var". 
 
   .. code-block:: python
@@ -379 +379 @@
     constrDict = [
          {'0:12:Scale': 2.0, '0:14:Scale': 4.0, '0:13:Scale': 3.0, '0:0:Scale': 0.5},
-         {'2::C(10,6,1)': 1.0, '1::C(10,6,1)': 1.0, '_vary':True},
-         {'0::A0': 0.0}]
-    fixedList = ['5.0', None, '0']
+         {'2::C(10,6,1)': 1.0, '1::C(10,6,1)': 1.0, '_vary':True}]
+    fixedList = ['5.0', None]
 
 .. _GenerateConstraints:
@@ -1729 +1728 @@
 
 def SubfromParmDict(s,prmDict):
+    '''Process a string as a multiplier and convert it to a float value. This
+    is done by subsituting any GSAS-II parameter names that appear in the 
+    string that have associated values in the parameter dict with the value 
+    for that parameter. 
+
+    :param str s: a string to be converted to a value
+    :param dict prmDict: a dictionary with keys as GSAS-II parameter names
+      and values the corresponding parameter value.
+    :returns: the evaluated expression as a float.
+    '''
+    # TODO: perhaps SubfromParmDict should be called to convert the
+    # fixed-val in constraint equations from strings to values.
     for key in prmDict:
         if key in s:

trunk/GSASIIobj.py

@@ -76 +76 @@
 
   * <mult> is a multiplier for the constraint (float)
-  * <var> a :class:`G2VarObj` object (previously a str variable name of form
-      'p:h:name[:at]')
+  * <var> a :class:`G2VarObj` object. (Note that in very old .gpx files this might be a str with a variable name of form 'p:h:name[:at]')
 
 Note that the last three items in the list play a special role: