File: elementary_cov.html

package info (click to toggle)
freemat 4.2%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 141,800 kB
  • ctags: 14,082
  • sloc: ansic: 126,788; cpp: 62,046; python: 2,080; perl: 1,255; sh: 1,146; yacc: 1,019; lex: 239; makefile: 100
file content (120 lines) | stat: -rw-r--r-- 4,841 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: COV Covariance Matrix</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">FreeMat
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('elementary_cov.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">COV Covariance Matrix </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_elementary.html">Elementary Functions</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>Computes the covariance of a matrix or a vector. The general syntax for its use is </p>
<pre class="fragment">  y = cov(x)
</pre><p> where <code>x</code> is a matrix or a vector. If <code>x</code> is a vector then <code>cov</code> returns the variance of <code>x</code>. If <code>x</code> is a matrix then <code>cov</code> returns the covariance matrix of the columns of <code>x</code>. You can also call <code>cov</code> with two arguments to compute the matrix of cross correlations. The syntax for this mode is </p>
<pre class="fragment">  y = cov(x,z)
</pre><p> where <code>x</code> and <code>z</code> are matrices of the same size. Finally, you can provide a normalization flag <code>d</code> that is either <code>0</code> or <code>1</code>, which changes the normalization factor from <code>L-1</code> (for <code>d=0</code>) to <code>L</code> (for <code>d=1</code>) where <code>L</code> is the number of rows in the matrix <code>x</code>. In this case, the syntaxes are </p>
<pre class="fragment">  y = cov(x,z,d)
</pre><p> for the two-argument case, and </p>
<pre class="fragment">  y = cov(x,d)
</pre><p> for the one-argument case. </p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>The following demonstrates some uses of the <code>cov</code> function</p>
<pre class="fragment">--&gt; A = [5,1,3;3,2,1;0,3,1]

A = 
 5 1 3 
 3 2 1 
 0 3 1 

--&gt; B = [4,-2,0;1,5,2;-2,0,1];
</pre><p>We start with the covariance matrix for <code>A</code></p>
<pre class="fragment">--&gt; cov(A)

ans = 
    4.2222   -1.6667    1.5556 
   -1.6667    0.6667   -0.6667 
    1.5556   -0.6667    0.8889 
</pre><p>and again with the (biased) normalization</p>
<pre class="fragment">--&gt; cov(A,1)

ans = 
    4.2222   -1.6667    1.5556 
   -1.6667    0.6667   -0.6667 
    1.5556   -0.6667    0.8889 
</pre><p>Here we compute the cross covariance between <code>A</code> and <code>B</code></p>
<pre class="fragment">--&gt; cov(A,B)

ans = 
    2.0988    1.6667 
    1.6667    5.1111 
</pre><p>and again with biased normalization</p>
<pre class="fragment">--&gt; cov(A,B,1)

ans = 
    2.0988    1.6667 
    1.6667    5.1111 
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_elementary.html">Elementary Functions</a></li>
    <li class="footer">Generated on Thu Jul 25 2013 18:58:17 for FreeMat by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>