home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fb.zip / octave / SCRIPTS.ZIP / scripts.fat / general / strerror.m < prev    next >
Text File  |  1999-12-24  |  2KB  |  67 lines
  1. ## Copyright (C) 1996, 1997 John W. Eaton
  2. ##
  3. ## This file is part of Octave.
  4. ##
  5. ## Octave is free software; you can redistribute it and/or modify it
  6. ## under the terms of the GNU General Public License as published by
  7. ## the Free Software Foundation; either version 2, or (at your option)
  8. ## any later version.
  9. ##
  10. ## Octave is distributed in the hope that it will be useful, but
  11. ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13. ## General Public License for more details.
  14. ##
  15. ## You should have received a copy of the GNU General Public License
  16. ## along with Octave; see the file COPYING.  If not, write to the Free
  17. ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  18. ## 02111-1307, USA.
  19.  
  20. ## -*- texinfo -*-
  21. ## @deftypefn {Function File} {} strerror (@var{name}, @var{num})
  22. ## Return the text of an error message for function @var{name}
  23. ## corresponding to the error number @var{num}.  This function is intended
  24. ## to be used to print useful error messages for those functions that
  25. ## return numeric error codes.
  26. ## @end deftypefn
  27.  
  28. ## Author: jwe
  29.  
  30. function msg = strerror (name, err)
  31.  
  32.   if (nargin != 2)
  33.     usage ("strerror (name, err)");
  34.   endif
  35.  
  36.   if (! isstr (name))
  37.     error ("strerror: first argument must be a string");
  38.   endif
  39.  
  40.   if (! is_scal (err))
  41.     error ("strerror: second argument must be a scalar");
  42.   endif
  43.  
  44.   if (strcmp (name, "fsolve"))
  45.  
  46.     if (err == -2)
  47.       msg = "input error\n";
  48.     elseif (err == -1)
  49.       msg = "error encountered in user-supplied function\n";
  50.     elseif (err == 1)
  51.       msg = "solution converged to requested tolerance\n";
  52.     elseif (err == 4)
  53.       msg = "iteration limit exceeded\n";
  54.     elseif (err == 3)
  55.       msg = "iteration is not making good progress\n";
  56.     else
  57.       error ("strerror: unrecognized error code for fsolve");
  58.     endif
  59.  
  60.   else
  61.  
  62.     error ("strerror: unrecognized function name");
  63.  
  64.   endif
  65.  
  66. endfunction
  67.