annotate scripts/general/strerror.m @ 5607:4b33d802ef3c

[project @ 2006-02-08 18:56:54 by jwe]
author jwe
date Wed, 08 Feb 2006 18:56:54 +0000
parents ec8c33dcd1bf
children 34f96dd5441b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2314
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4030
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4030
diff changeset
18 ## 02110-1301, USA.
1576
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
19
3381
69b167451491 [project @ 1999-12-15 20:48:10 by jwe]
jwe
parents: 3373
diff changeset
20 ## -*- texinfo -*-
3373
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3045
diff changeset
21 ## @deftypefn {Function File} {} strerror (@var{name}, @var{num})
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3045
diff changeset
22 ## Return the text of an error message for function @var{name}
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3045
diff changeset
23 ## corresponding to the error number @var{num}. This function is intended
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3045
diff changeset
24 ## to be used to print useful error messages for those functions that
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3045
diff changeset
25 ## return numeric error codes.
36405da8e173 [project @ 1999-11-23 20:54:17 by jwe]
jwe
parents: 3045
diff changeset
26 ## @end deftypefn
1576
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
27
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
28 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
29
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
30 function msg = strerror (name, err)
1576
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
31
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
32 if (nargin != 2)
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
33 usage ("strerror (name, err)");
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
34 endif
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
35
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5307
diff changeset
36 if (! ischar (name))
1576
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
37 error ("strerror: first argument must be a string");
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
38 endif
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
39
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3381
diff changeset
40 if (! isscalar (err))
1576
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
41 error ("strerror: second argument must be a scalar");
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
42 endif
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
43
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
44 if (strcmp (name, "fsolve"))
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
45
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
46 if (err == -2)
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
47 msg = "input error\n";
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
48 elseif (err == -1)
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
49 msg = "error encountered in user-supplied function\n";
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
50 elseif (err == 1)
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
51 msg = "solution converged to requested tolerance\n";
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
52 elseif (err == 4)
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
53 msg = "iteration limit exceeded\n";
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
54 elseif (err == 3)
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
55 msg = "iteration is not making good progress\n";
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
56 else
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
57 error ("strerror: unrecognized error code for fsolve");
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
58 endif
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
59
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
60 else
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
61
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
62 error ("strerror: unrecognized function name");
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
63
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
64 endif
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
65
75077e1455dd [project @ 1995-10-19 04:46:37 by jwe]
jwe
parents:
diff changeset
66 endfunction