diff src/DLD-FUNCTIONS/minmax.cc @ 3443:bf22deaf04ed

[project @ 2000-01-17 08:28:27 by jwe]
author jwe
date Mon, 17 Jan 2000 08:28:27 +0000
parents ca92c9d3f882
children a908150a3a32
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/minmax.cc	Mon Jan 17 08:18:42 2000 +0000
+++ b/src/DLD-FUNCTIONS/minmax.cc	Mon Jan 17 08:28:27 2000 +0000
@@ -274,7 +274,20 @@
 }
 
 DEFUN_DLD (min, args, nargout,
-  "min (X): minimum value(s) of a vector (matrix)")
+  "-*- texinfo -*-\n\
+For a vector argument, return the minimum value.  For a matrix\n\
+argument, return the minimum value from each column, as a row\n\
+vector.  Thus,\n\
+\n\
+@example\n\
+min (min (@var{x}))\n\
+@end example\n\
+\n\
+@noindent\n\
+returns the smallest element of @var{x}.\n\
+\n\
+For complex arguments, the magnitude of the elements are used for\n\
+comparison.")
 {
   octave_value_list retval;
 
@@ -488,7 +501,20 @@
 }
 
 DEFUN_DLD (max, args, nargout,
-  "max (X): maximum value(s) of a vector (matrix)")
+  "-*- texinfo -*-\n\
+For a vector argument, return the maximum value.  For a matrix\n\
+argument, return the maximum value from each column, as a row\n\
+vector.  Thus,\n\
+\n\
+@example\n\
+max (max (@var{x}))\n\
+@end example\n\
+\n\
+@noindent\n\
+returns the largest element of @var{x}.\n\
+\n\
+For complex arguments, the magnitude of the elements are used for\n\
+comparison.")
 {
   octave_value_list retval;