diff scripts/statistics/base/cov.m @ 3367:0748b03c3510

[project @ 1999-11-20 14:52:38 by jwe]
author jwe
date Sat, 20 Nov 1999 14:52:42 +0000
parents 781c930425fd
children f8dde1807dee
line wrap: on
line diff
--- a/scripts/statistics/base/cov.m
+++ b/scripts/statistics/base/cov.m
@@ -14,15 +14,14 @@
 ## along with this file.  If not, write to the Free Software Foundation,
 ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
-## usage:  cov (x [, y])
-##
-## The (i,j)-th entry of cov (x, y) is the covariance between the i-th
-## variable in x and the j-th variable in y.
-##
-## For matrices, each row is an observation and each column a variable;
-## vectors are always observations and may be row or column vectors.
-##
-## cov (x) is cov (x, x).
+## -*- texinfo -*-
+## @deftypefn {Function File} {} cov (@var{x}, @var{y})
+## If each row of @var{x} and @var{y} is an observation and each column is
+## a variable, the (@var{i},@var{j})-th entry of
+## @code{cov (@var{x}, @var{y})} is the covariance between the @var{i}-th
+## variable in @var{x} and the @var{j}-th variable in @var{y}.  If called
+## with one argument, compute @code{cov (@var{x}, @var{x})}.
+## @end deftypefn
 
 ## Author:  KH <Kurt.Hornik@ci.tuwien.ac.at>
 ## Description:  Compute covariances