annotate corr2.m @ 136:78b9878c50f0 Octave-Forge-2004.11.16

Add new functions
author pkienzle
date Tue, 16 Nov 2004 09:18:23 +0000
parents 587e29845b1d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
1 ## Copyright (C) 2000 Kai Habel
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
2 ##
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
6 ## (at your option) any later version.
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
7 ##
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
11 ## GNU General Public License for more details.
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
12 ##
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
16
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
17 ## -*- texinfo -*-
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
18 ## @deftypefn {Function File} @var{r}= corr2 (@var{I},@var{J})
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
19 ## returns the correlation coefficient between @var{I} and @var{j}.
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
20 ## @var{I,J} must be real type matrices or vectors of same size
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
21 ## @end deftypefn
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
22
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
23
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
24 ## Author: Kai Habel <kai.habel@gmx.de>
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
25 ## Date: 01/08/2000
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
26
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
27 function r = corr2 (I, J)
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
28
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
29 if !(nargin == 2)
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
30 usage ("corr2(I,J)");
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
31 endif
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
32
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
33 if !(is_matrix(I) && isreal(I) && is_matrix(J) && isreal(J))
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
34 error("argument must be a real type matrix");
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
35 endif
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
36
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
37 if (size (I) != size (J))
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
38 error("arguments must be of same size")
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
39 endif
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
40
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
41 r = cov (I, J) / (std2(I)*std2(J));
587e29845b1d Initial revision
pkienzle
parents:
diff changeset
42 endfunction