Mercurial > octave-nkf

changeset 12572:dffd30f12752

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add blkmm function to documentation.
author Rik <octave@nomad.inbox5.com>
date Sun, 03 Apr 2011 13:55:58 -0700
parents bed932910eb9
children 232a90612254
files doc/ChangeLog doc/interpreter/linalg.txi src/ChangeLog src/DLD-FUNCTIONS/dot.cc
diffstat 4 files changed, 18 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Sun Apr 03 07:24:38 2011 -0700
+++ b/doc/ChangeLog	Sun Apr 03 13:55:58 2011 -0700
@@ -1,3 +1,7 @@
+2011-04-03  Rik  <octave@nomad.inbox5.com>
+
+	* interpreter/linalg.txi: Add blkmm function to documentation.
+
 2011-04-02  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/stats.txi: Add quantile, prctile functions to
--- a/doc/interpreter/linalg.txi	Sun Apr 03 07:24:38 2011 -0700
+++ b/doc/interpreter/linalg.txi	Sun Apr 03 13:55:58 2011 -0700
@@ -180,6 +180,8 @@
 
 @DOCSTRING(kron)
 
+@DOCSTRING(blkmm)
+
 @DOCSTRING(syl)
 
 @node Specialized Solvers
--- a/src/ChangeLog	Sun Apr 03 07:24:38 2011 -0700
+++ b/src/ChangeLog	Sun Apr 03 13:55:58 2011 -0700
@@ -1,3 +1,7 @@
+2011-04-03  Rik  <octave@nomad.inbox5.com>
+
+	* DLD-FUNCTIONS/dot.cc (blkmm): Improve docstring.
+
 2011-04-03  Rik  <octave@nomad.inbox5.com>
 
 	* data.cc (diag): Add documentation for 3-input form of diag.  Add new
--- a/src/DLD-FUNCTIONS/dot.cc	Sun Apr 03 07:24:38 2011 -0700
+++ b/src/DLD-FUNCTIONS/dot.cc	Sun Apr 03 13:55:58 2011 -0700
@@ -242,17 +242,17 @@
 
 DEFUN_DLD (blkmm, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Loadable Function} {} blkmm (@var{x}, @var{y})\n\
+@deftypefn {Loadable Function} {} blkmm (@var{A}, @var{B})\n\
 Compute products of matrix blocks.  The blocks are given as\n\
-2-dimensional subarrays of the arrays @var{x}, @var{y}.\n\
-The size of @var{x} must have the form @code{[m,k,@dots{}]} and\n\
-size of @var{y} must be @code{[k,n,@dots{}]}.  The result is\n\
+2-dimensional subarrays of the arrays @var{A}, @var{B}.\n\
+The size of @var{A} must have the form @code{[m,k,@dots{}]} and\n\
+size of @var{B} must be @code{[k,n,@dots{}]}.  The result is\n\
 then of size @code{[m,n,@dots{}]} and is computed as follows:\n\
 \n\
 @example\n\
 @group\n\
-  for i = 1:prod (size (@var{x})(3:end))\n\
-    @var{z}(:,:,i) = @var{x}(:,:,i) * @var{y}(:,:,i)\n\
+  for i = 1:prod (size (@var{A})(3:end))\n\
+    @var{C}(:,:,i) = @var{A}(:,:,i) * @var{B}(:,:,i)\n\
   endfor\n\
 @end group\n\
 @end example\n\
@@ -335,12 +335,12 @@
             }
         }
       else
-        error ("blkmm: X and Y dimensions don't match: (%s) and (%s)",
+        error ("blkmm: A and B dimensions don't match: (%s) and (%s)",
                dimx.str ().c_str (), dimy.str ().c_str ());
 
     }
   else
-    error ("blkmm: X and Y must be numeric");
+    error ("blkmm: A and B must be numeric");
 
   return retval;
 }