Author: bugman
Date: Thu Jul 17 15:02:52 2014
New Revision: 24551
URL: http://svn.gna.org/viewcvs/relax?rev=24551&view=rev
Log:
Merged revisions 24549-24550 via svnmerge from
svn+ssh://bugman@xxxxxxxxxxx/svn/relax/trunk
........
r24549 | bugman | 2014-07-17 14:56:24 +0200 (Thu, 17 Jul 2014) | 5 lines
Removed the line wrapping in the epydoc parameter section of the
optimisation function docstrings.
This is for the pipe_control.minimise module.
........
r24550 | bugman | 2014-07-17 14:57:01 +0200 (Thu, 17 Jul 2014) | 3 lines
More docstring line wrapping removal from pipe_control.minimise.
........
Modified:
branches/zooming_grid_search/ (props changed)
branches/zooming_grid_search/pipe_control/minimise.py
Propchange: branches/zooming_grid_search/
------------------------------------------------------------------------------
--- svnmerge-integrated (original)
+++ svnmerge-integrated Thu Jul 17 15:02:52 2014
@@ -1 +1 @@
-/trunk:1-24543
+/trunk:1-24550
Modified: branches/zooming_grid_search/pipe_control/minimise.py
URL:
http://svn.gna.org/viewcvs/relax/branches/zooming_grid_search/pipe_control/minimise.py?rev=24551&r1=24550&r2=24551&view=diff
==============================================================================
--- branches/zooming_grid_search/pipe_control/minimise.py (original)
+++ branches/zooming_grid_search/pipe_control/minimise.py Thu Jul 17
15:02:52 2014
@@ -34,8 +34,7 @@
def calc(verbosity=1):
"""Function for calculating the function value.
- @param verbosity: The amount of information to print. The higher the
value, the greater
- the verbosity.
+ @param verbosity: The amount of information to print. The higher the
value, the greater the verbosity.
@type verbosity: int
"""
@@ -86,21 +85,15 @@
def grid_search(lower=None, upper=None, inc=None, constraints=True,
verbosity=1):
"""The grid search function.
- @param lower: The lower bounds of the grid search which must be
equal to the number of
- parameters in the model.
+ @param lower: The lower bounds of the grid search which must be
equal to the number of parameters in the model.
@type lower: array of numbers
- @param upper: The upper bounds of the grid search which must be
equal to the number of
- parameters in the model.
+ @param upper: The upper bounds of the grid search which must be
equal to the number of parameters in the model.
@type upper: array of numbers
- @param inc: The increments for each dimension of the space for
the grid search. The
- number of elements in the array must equal to the
number of parameters in
- the model.
+ @param inc: The increments for each dimension of the space for
the grid search. The number of elements in the array must equal to the
number of parameters in the model.
@type inc: array of int
- @param constraints: If True, constraints are applied during the grid
search (elinating parts of
- the grid). If False, no constraints are used.
+ @param constraints: If True, constraints are applied during the grid
search (elinating parts of the grid). If False, no constraints are used.
@type constraints: bool
- @param verbosity: The amount of information to print. The higher the
value, the greater
- the verbosity.
+ @param verbosity: The amount of information to print. The higher the
value, the greater the verbosity.
@type verbosity: int
"""
@@ -268,8 +261,7 @@
def reset_min_stats(data_pipe=None, spin=None):
"""Function for resetting the minimisation statistics.
- @param data_pipe: The name of the data pipe to reset the minimisation
statisics of. This
- defaults to the current data pipe.
+ @param data_pipe: The name of the data pipe to reset the minimisation
statisics of. This defaults to the current data pipe.
@type data_pipe: str
@param spin: The spin data container if spin specific data is to
be reset.
@type spin: SpinContainer
r24551 - in /branches/zooming_grid_search: ./ pipe_control/minimise.py