r4520 - /branches/N_state_model/specific_fns/n_state_model.py -- January 09, 2008 - 10:23

Author: bugman
Date: Wed Jan  9 10:23:40 2008
New Revision: 4520

URL: http://svn.gna.org/viewcvs/relax?rev=4520&view=rev
Log:
Changed a few of the arguments of the N-state model minimise() function.

The 'print_flag' arg has been renamed to 'verbosity' as it really isn't a 
flag.  And the 0/1 args
have been converted to True/False args.


Modified:
    branches/N_state_model/specific_fns/n_state_model.py

Modified: branches/N_state_model/specific_fns/n_state_model.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/N_state_model/specific_fns/n_state_model.py?rev=4520&r1=4519&r2=4520&view=diff
==============================================================================
--- branches/N_state_model/specific_fns/n_state_model.py (original)
+++ branches/N_state_model/specific_fns/n_state_model.py Wed Jan  9 10:23:40 
2008
@@ -69,7 +69,7 @@
         """Dummy function nornally for deselecting spins with insufficient 
data for minimisation."""
 
 
-    def minimise(self, min_algor=None, min_options=None, func_tol=None, 
grad_tol=None, max_iterations=None, constraints=0, scaling=1, print_flag=0, 
sim_index=None):
+    def minimise(self, min_algor=None, min_options=None, func_tol=None, 
grad_tol=None, max_iterations=None, constraints=False, scaling=True, 
verbosity=0, sim_index=None):
         """Minimisation function.
 
         @param min_algor:       The minimisation algorithm to use.
@@ -84,14 +84,14 @@
         @type grad_tol:         None or float
         @param max_iterations:  The maximum number of iterations for the 
algorithm.
         @type max_iterations:   int
-        @param constraints:     If true, constraints are used during 
optimisation.
+        @param constraints:     If True, constraints are used during 
optimisation.
         @type constraints:      bool
-        @param scaling:         If true, diagonal scaling is enabled during 
optimisation to allow
+        @param scaling:         If True, diagonal scaling is enabled during 
optimisation to allow
                                 the problem to be better conditioned.
         @type scaling:          bool
-        @param print_flag:      A flag specifying the amount of information 
to print.  The higher
+        @param verbosity:       A flag specifying the amount of information 
to print.  The higher
                                 the value, the greater the verbosity.
-        @type print_flag:       int
+        @type verbosity:        int
         @param sim_index:       The index of the simulation to optimise.  
This should be None if
                                 normal optimisation is desired.
         @type sim_index:        None or int