comparison src/DLD-FUNCTIONS/dot.cc @ 10846:a4f482e66b65

Grammarcheck more of the documentation. Use @noindent macro appropriately. Limit line length to 80 characters.
author Rik <octave@nomad.inbox5.com>
date Sun, 01 Aug 2010 20:22:17 -0700
parents 89f4d7e294cc
children 141b3fb5cef7
comparison
equal deleted inserted replaced
10845:c0ffe159ba1a 10846:a4f482e66b65
108 Computes the dot product of two vectors. If @var{x} and @var{y}\n\ 108 Computes the dot product of two vectors. If @var{x} and @var{y}\n\
109 are matrices, calculate the dot products along the first \n\ 109 are matrices, calculate the dot products along the first \n\
110 non-singleton dimension. If the optional argument @var{dim} is\n\ 110 non-singleton dimension. If the optional argument @var{dim} is\n\
111 given, calculate the dot products along this dimension.\n\ 111 given, calculate the dot products along this dimension.\n\
112 \n\ 112 \n\
113 This is equivalent to doing @code{sum (conj (@var{X}) .* @var{Y}, @var{dim})},\n\ 113 This is equivalent to doing\n\
114 but avoids forming a temporary array and is faster. When @var{X} and @var{Y}\n\ 114 @code{sum (conj (@var{X}) .* @var{Y}, @var{dim})},\n\
115 are column vectors, the result is equivalent to\n\ 115 but avoids forming a temporary array and is faster. When @var{X} and\n\
116 @var{Y} are column vectors, the result is equivalent to\n\
116 @code{ @var{X}'*@var{Y} }.\n\ 117 @code{ @var{X}'*@var{Y} }.\n\
117 @end deftypefn") 118 @end deftypefn")
118 { 119 {
119 octave_value retval; 120 octave_value retval;
120 int nargin = args.length (); 121 int nargin = args.length ();