changeset 8778:09ab0cc57ba6

improve cummin/cummax inline docs
author Jaroslav Hajek <highegg@gmail.com>
date Tue, 17 Feb 2009 11:40:40 +0100
parents 724c0f46d9d4
children 949708f930d0
files src/ChangeLog src/DLD-FUNCTIONS/max.cc
diffstat 2 files changed, 10 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Tue Feb 17 11:26:29 2009 +0100
+++ b/src/ChangeLog	Tue Feb 17 11:40:40 2009 +0100
@@ -1,3 +1,7 @@
+2009-02-17  Jaroslav Hajek  <highegg@gmail.com>
+
+	* DLD-FUNCTIONS/max.cc (Fcummin, Fcummax): Improve inline docs.
+
 2009-02-17  Jaroslav Hajek  <highegg@gmail.com>
 
 	* DLD-FUNCTIONS/max.cc (MINMAX_DOUBLE_SBODY): New macro.
--- a/src/DLD-FUNCTIONS/max.cc	Tue Feb 17 11:26:29 2009 +0100
+++ b/src/DLD-FUNCTIONS/max.cc	Tue Feb 17 11:40:40 2009 +0100
@@ -908,14 +908,15 @@
 @cindex Utility Functions\n\
 Return the cumulative minimum values. That means, the call\n\
 @example\n\
-  [@var{w}, @var{iw}] = cummin (@var{x}, @var{dim})}\n\
+  [@var{w}, @var{iw}] = cummin (@var{x}, @var{dim})\n\
 @end example\n\
 \n\
 @noindent\n\
 is equivalent to the following code:\n\
 @example\n\
   for i = 1:size (x, dim)\n\
-    [w(i), iw(i)] = min(x(:,@dots{},i,:,@dots{}), dim);\n\
+    [@var{w}(:,@dots{},i:,@dots{},), @var{iw}(:,@dots{},i:,@dots{},)] =\
+ min(@var{x}(:,@dots{},i,:,@dots{}), @var{dim});\n\
   endfor\n\
 @end example\n\
 \n\
@@ -935,14 +936,15 @@
 @cindex Utility Functions\n\
 Return the cumulative maximum values. That means, the call\n\
 @example\n\
-  [@var{w}, @var{iw}] = cummax (@var{x}, @var{dim})}\n\
+  [@var{w}, @var{iw}] = cummax (@var{x}, @var{dim})\n\
 @end example\n\
 \n\
 @noindent\n\
 is equivalent to the following code:\n\
 @example\n\
   for i = 1:size (x, dim)\n\
-    [w(i), iw(i)] = max(x(:,@dots{},i,:,@dots{}), dim);\n\
+    [@var{w}(:,@dots{},i:,@dots{},), @var{iw}(:,@dots{},i:,@dots{},)] =\
+ max(@var{x}(:,@dots{},i,:,@dots{}), @var{dim});\n\
   endfor\n\
 @end example\n\
 \n\