File: array_norm.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 (160 lines) | stat: -rw-r--r-- 4,559 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!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: NORM Norm Calculation</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('array_norm.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">NORM Norm Calculation </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_array.html">Array Generation and Manipulations</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>Calculates the norm of a matrix. There are two ways to use the <code>norm</code> function. The general syntax is </p>
<pre class="fragment">   y = norm(A,p)
</pre><p> where <code>A</code> is the matrix to analyze, and <code>p</code> is the type norm to compute. The following choices of <code>p</code> are supported </p>
<ul>
<li>
<code>p = 1</code> returns the 1-norm, or the max column sum of A  </li>
<li>
<code>p = 2</code> returns the 2-norm (largest singular value of A)  </li>
<li>
<code>p = inf</code> returns the infinity norm, or the max row sum of A  </li>
<li>
<code>p = 'fro'</code> returns the Frobenius-norm (vector Euclidean norm, or RMS value)  </li>
</ul>
<p>For a vector, the regular norm calculations are performed: </p>
<ul>
<li>
<code>1 &lt;= p &lt; inf</code> returns <code>sum(abs(A).^p)^(1/p)</code>  </li>
<li>
<code>p</code> unspecified returns <code>norm(A,2)</code>  </li>
<li>
<code>p = inf</code> returns max(abs(A))  </li>
<li>
<code>p = -inf</code> returns min(abs(A))  </li>
</ul>
<h1><a class="anchor" id="Examples"></a>
Examples</h1>
<p>Here are the various norms calculated for a sample matrix</p>
<pre class="fragment">--&gt; A = float(rand(3,4))

A = 
    0.8462    0.9465    0.6874    0.8668 
    0.1218    0.9206    0.5877    0.5837 
    0.7081    0.6608    0.2035    0.5083 

--&gt; norm(A,1)

ans = 
    2.5280 

--&gt; norm(A,2)

ans = 
    2.2997 

--&gt; norm(A,inf)

ans = 
    3.3470 

--&gt; norm(A,'fro')

ans = 
    2.3712 
</pre><p>Next, we calculate some vector norms.</p>
<pre class="fragment">--&gt; A = float(rand(4,1))

A = 
    0.3458 
    0.1427 
    0.3998 
    0.7194 

--&gt; norm(A,1)

ans = 
    1.6078 

--&gt; norm(A,2)

ans = 
    0.9041 

--&gt; norm(A,7)

ans = 
    0.7217 

--&gt; norm(A,inf)

ans = 
    0.7194 

--&gt; norm(A,-inf)

ans = 
    0.1427 
</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_array.html">Array Generation and Manipulations</a></li>
    <li class="footer">Generated on Thu Jul 25 2013 18:58:11 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>