Mercurial > octave-nkf

comparison libinterp/corefcn/dot.cc @ 20207:4f45eaf83908 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 4197fc428c7d
children b2100e1659ac
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
104 } 104 }
105 105
106 DEFUN (dot, args, , 106 DEFUN (dot, args, ,
107 "-*- texinfo -*-\n\ 107 "-*- texinfo -*-\n\
108 @deftypefn {Built-in Function} {} dot (@var{x}, @var{y}, @var{dim})\n\ 108 @deftypefn {Built-in Function} {} dot (@var{x}, @var{y}, @var{dim})\n\
109 Compute the dot product of two vectors. If @var{x} and @var{y}\n\ 109 Compute the dot product of two vectors.\n\
110 are matrices, calculate the dot products along the first\n\ 110 \n\
111 non-singleton dimension. If the optional argument @var{dim} is\n\ 111 If @var{x} and @var{y} are matrices, calculate the dot products along the\n\
112 given, calculate the dot products along this dimension.\n\ 112 first non-singleton dimension.\n\
113 \n\
114 If the optional argument @var{dim} is given, calculate the dot products\n\
115 along this dimension.\n\
113 \n\ 116 \n\
114 This is equivalent to\n\ 117 This is equivalent to\n\
115 @code{sum (conj (@var{X}) .* @var{Y}, @var{dim})},\n\ 118 @code{sum (conj (@var{X}) .* @var{Y}, @var{dim})},\n\
116 but avoids forming a temporary array and is faster. When @var{X} and\n\ 119 but avoids forming a temporary array and is faster. When @var{X} and\n\
117 @var{Y} are column vectors, the result is equivalent to\n\ 120 @var{Y} are column vectors, the result is equivalent to\n\
279 */ 282 */
280 283
281 DEFUN (blkmm, args, , 284 DEFUN (blkmm, args, ,
282 "-*- texinfo -*-\n\ 285 "-*- texinfo -*-\n\
283 @deftypefn {Built-in Function} {} blkmm (@var{A}, @var{B})\n\ 286 @deftypefn {Built-in Function} {} blkmm (@var{A}, @var{B})\n\
284 Compute products of matrix blocks. The blocks are given as\n\ 287 Compute products of matrix blocks.\n\
285 2-dimensional subarrays of the arrays @var{A}, @var{B}.\n\ 288 \n\
286 The size of @var{A} must have the form @code{[m,k,@dots{}]} and\n\ 289 The blocks are given as 2-dimensional subarrays of the arrays @var{A},\n\
287 size of @var{B} must be @code{[k,n,@dots{}]}. The result is\n\ 290 @var{B}. The size of @var{A} must have the form @code{[m,k,@dots{}]} and\n\
288 then of size @code{[m,n,@dots{}]} and is computed as follows:\n\ 291 size of @var{B} must be @code{[k,n,@dots{}]}. The result is then of size\n\
292 @code{[m,n,@dots{}]} and is computed as follows:\n\
289 \n\ 293 \n\
290 @example\n\ 294 @example\n\
291 @group\n\ 295 @group\n\
292 for i = 1:prod (size (@var{A})(3:end))\n\ 296 for i = 1:prod (size (@var{A})(3:end))\n\
293 @var{C}(:,:,i) = @var{A}(:,:,i) * @var{B}(:,:,i)\n\ 297 @var{C}(:,:,i) = @var{A}(:,:,i) * @var{B}(:,:,i)\n\