Changeset 614 for branches

Timestamp:

12/18/12 19:39:55 (3 years ago)

Author:

mmckerns

Message:

cleaned up documentation; bugfix for when nvars is less than list of variables;
added sympy-specific functions from alta's mystic.constraints

Location:

branches/decorate

Files:

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

branches/decorate/symbolic.py

@@ -215 +215 @@
 Returns a tuple of inequality constraints and a tuple of equality constraints.
 
+Inputs:
+    constraints -- a string of symbolic constraints, with one constraint
+        equation per line. Constraints can be equality and/or inequality
+        constraints. Standard python syntax should be followed (with the
+        math and numpy modules already imported).
+
     For example:
         >>> constraints = '''
@@ -221 +227 @@
         >>> penalty_parser(constraints, nvars=3)
         (('-(x[0] - (0.))',), ('x[2] - (x[0]/2.)',))
+
+Additional Inputs:
+    nvars -- number of variables. Includes variables not explicitly
+        given by the constraint equations (e.g. 'x2' in the example above).
+    variables -- desired variable name. Default is 'x'. A list of variable
+        name strings is also accepted for when desired variable names
+        don't have the same base, and can include variables that are not
+        found in the constraints equation string.
     """
    #from mystic.tools import src
    #ndim = len(get_variables(src(func), variables))
     if list_or_tuple_or_ndarray(variables):
+        if nvars: variables = variables[:nvars]
         constraints = replace_variables(constraints, variables)
         varname = '$'
@@ -287 +302 @@
 The left-hand side of each constraint must be simplified to support assignment.
 
+Inputs:
+    constraints -- a string of symbolic constraints, with one constraint
+        equation per line. Constraints can be equality and/or inequality
+        constraints. Standard python syntax should be followed (with the
+        math and numpy modules already imported).
+
     For example:
         >>> constraints = '''
@@ -293 +314 @@
         >>> constraints_parser(constraints, nvars=3)
         ('x[2] = x[0]/2.', 'x[0] = max(0., x[0])')
+
+Additional Inputs:
+    nvars -- number of variables. Includes variables not explicitly
+        given by the constraint equations (e.g. 'x2' in the example above).
+    variables -- desired variable name. Default is 'x'. A list of variable
+        name strings is also accepted for when desired variable names
+        don't have the same base, and can include variables that are not
+        found in the constraints equation string.
     """
    #from mystic.tools import src
    #ndim = len(get_variables(src(func), variables))
     if list_or_tuple_or_ndarray(variables):
+        if nvars: variables = variables[:nvars]
         constraints = replace_variables(constraints, variables)
         varname = '$'