r26340 - /trunk/lib/arg_check.py -- October 22, 2014 - 11:38

Author: bugman
Date: Wed Oct 22 11:38:09 2014
New Revision: 26340

URL: http://svn.gna.org/viewcvs/relax?rev=26340&view=rev
Log:
Expanded the lib.arg_check.is_float_matrix() function by adding the 
none_elements argument.

This matches a number of the other module functions, and allows for entire 
rows of the matrix to be
None.


Modified:
    trunk/lib/arg_check.py

Modified: trunk/lib/arg_check.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/lib/arg_check.py?rev=26340&r1=26339&r2=26340&view=diff
==============================================================================
--- trunk/lib/arg_check.py      (original)
+++ trunk/lib/arg_check.py      Wed Oct 22 11:38:09 2014
@@ -150,7 +150,7 @@
     return True
 
 
-def is_float_matrix(arg, name=None, dim=(3, 3), can_be_none=False, 
raise_error=True):
+def is_float_matrix(arg, name=None, dim=(3, 3), can_be_none=False, 
none_elements=False, raise_error=True):
     """Test if the argument is a matrix of floats.
 
     @param arg:                         The argument.
@@ -161,6 +161,8 @@
     @type dim:                          tuple of int
     @keyword can_be_none:               A flag specifying if the argument 
can be none.
     @type can_be_none:                  bool
+    @keyword none_elements:             A flag which if True allows the list 
to contain None.
+    @type none_elements:                bool
     @keyword raise_error:               A flag which if True will cause 
RelaxErrors to be raised.
     @type raise_error:                  bool
     @raise RelaxMatrixFloatError:       If not a matrix of floats (and the 
raise_error flag is set).
@@ -195,6 +197,12 @@
     # Loop over the first dimension.
     else:
         for i in range(len(arg)):
+            # Catch None elements.
+            if arg[i] == None:
+                if not none_elements:
+                    fail = True
+                continue
+
             # Fail if not a list.
             if not (isinstance(arg[i], list) or isinstance(arg[i], ndarray)):
                 fail = True