Changeset 620

Timestamp:

12/20/12 15:39:12 (3 years ago)

Author:

mmckerns

Message:

pass constraint and penalty informative docstring built from underlying funcs

Location:

branches/decorate

Files:

• _symbolic.py (modified) (4 diffs)
• symbolic.py (modified) (4 diffs)

branches/decorate/_symbolic.py

@@ -240 +240 @@
         >>> print simplify_symbolic(equation, target='x2')
         x2 = 3.0 + x1*x3
+
+Further Inputs:
+    locals -- a dictionary of additional variables used in the symbolic
+        constraints equations, and their desired values.
 """ #XXX: an expanded version of this code is found in build_constraints XXX#
     # for now, we abort on multi-line equations or inequalities
@@ -376 +380 @@
         >>> f([1.0, 0.0, 0.0, 1.0])
         [1.0, 0.0, -1.0, -0.5]
+
+Further Inputs:
+    locals -- a dictionary of additional variables used in the symbolic
+        constraints equations, and their desired values.
 """
     """
-Further Inputs:
     guess -- list of parameter values proposed to solve the constraints.
     lower_bounds -- list of lower bounds on solution values.
@@ -639 +646 @@
         >>> f([1.0, 0.0, 0.0, 1.0])
         [1.0, 0.0, -1.0, -0.5]
+
+Further Inputs:
+    locals -- a dictionary of additional variables used in the symbolic
+        constraints equations, and their desired values.
 """
     """
-Further Inputs:
     guess -- list of parameter values proposed to solve the constraints.
     lower_bounds -- list of lower bounds on solution values.
@@ -699 +709 @@
         >>> f([1.0, 2.0, 3.0])
         [1.0, -0.33333333333333204, 3.0]
+
+Further Inputs:
+    locals -- a dictionary of additional variables used in the symbolic
+        constraints equations, and their desired values.
 """
     """
-Further Inputs:
     guess -- list of parameter values proposed to solve the constraints.
     lower_bounds -- list of lower bounds on solution values.

branches/decorate/symbolic.py

@@ -456 +456 @@
         code = """
 def %(container)s_%(name)s(x): return eval('%(equation)s')
+%(container)s_%(name)s.__name__ = '%(container)s'
 %(container)s_%(name)s.__doc__ = '%(equation)s'""" % fdict
         #XXX: should locals just be the above dict of functions, or should we...
@@ -531 +532 @@
     exec('%(equation)s')
     return x
+%(container)s_%(name)s.__name__ = '%(container)s'
 """ % fdict #XXX: better, check if constraint satisfied... if not, then solve
         #XXX: should locals just be the above dict of functions, or should we...
@@ -590 +592 @@
     # iterate through penalties, building a compound penalty function
     pf = lambda x:0.0
+    pfdoc = ""
     for penalty, condition in zip(ptype, conditions):
+        pfdoc += "%s: %s\n" % (penalty.__name__, condition.__doc__)
         apply = penalty(condition, **kwds)
         pf = apply(pf)
+    pf.__doc__ = pfdoc.rstrip('\n')
+    pf.__name__ = 'penalty'
     return pf
 
@@ -657 +663 @@
     # iterate through solvers, building a compound constraints solver
     cf = lambda x:x
+    cfdoc = ""
     for wrapper, condition in zip(ctype, conditions):
+        cfdoc += "%s: %s\n" % (wrapper.__name__, condition.__doc__)
         apply = wrapper(condition, **kwds)
         cf = apply(cf)
+    cf.__doc__ = cfdoc.rstrip('\n')
+    cf.__name__ = 'constraint'
     return cf