changeset 1293:12ffe133862d octave-forge

fix an error message
author mcreel
date Tue, 17 Feb 2004 09:42:35 +0000
parents 0478f3e7db44
children 2f102759becb
files main/optim/Optimize/BFGSMin.m
diffstat 1 files changed, 8 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/main/optim/Optimize/BFGSMin.m	Mon Feb 16 17:17:14 2004 +0000
+++ b/main/optim/Optimize/BFGSMin.m	Tue Feb 17 09:42:35 2004 +0000
@@ -43,7 +43,7 @@
 # Input arguments:  
 #	func - (string) the function to minimize
 #	args - arguments, in a cell array.
-#	control - OPTIONAL 4x1 vector OR a string, e.g., "default"
+#	control - OPTIONAL 3x1 vector OR a string, e.g., "default"
 #		* 1st elem. controls maximum iterations
 #			scalar > 0 - max. iters
 #			or -1 for infinity (default)
@@ -56,8 +56,12 @@
 #				are all tested (default)
 #			0 = only function conv tested
 #
-#	OR, if you want defaults for control but want to set gradient,
-#	set control to a string, e.g., "defaults"
+#	OR
+#
+#	If you want defaults for control but want to set gradient
+#	(the following argument), set control to a string,
+#	e.g., "defaults". This is just for convenience, so that
+#	you don't have to remember the defaults.
 # 
 #	gradient - OPTIONAL: controls for analytic or numeric gradient
 #		* not provided, or not a string: use numeric gradient (default),
@@ -102,7 +106,7 @@
 	if nargin > 2 
 		if !ischar(control);
 			if (rows(control) != 3)
-				error("\nBFGSMin: 3rd argument must be a 4x1 vector\n");
+				error("\nBFGSMin: 3rd argument (control) must be a 3x1 vector\n");
 			else;
 				max_iters = control(1,:);
 				if max_iters == -1, max_iters = inf; endif