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
|
<!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: MAX Maximum Function</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 Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related 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_max.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">MAX Maximum Function </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 maximum of an array along a given dimension, or alternately, computes two arrays (entry-wise) and keeps the smaller value for each array. As a result, the <code>max</code> function has a number of syntaxes. The first one computes the maximum of an array along a given dimension. The first general syntax for its use is either </p>
<pre class="fragment"> [y,n] = max(x,[],d)
</pre><p> where <code>x</code> is a multidimensional array of numerical type, in which case the output <code>y</code> is the maximum of <code>x</code> along dimension <code>d</code>. The second argument <code>n</code> is the index that results in the maximum. In the event that multiple maxima are present with the same value, the index of the first maximum is used. The second general syntax for the use of the <code>max</code> function is </p>
<pre class="fragment"> [y,n] = max(x)
</pre><p> In this case, the maximum is taken along the first non-singleton dimension of <code>x</code>. For complex data types, the maximum is based on the magnitude of the numbers. NaNs are ignored in the calculations. The third general syntax for the use of the <code>max</code> function is as a comparison function for pairs of arrays. Here, the general syntax is </p>
<pre class="fragment"> y = max(x,z)
</pre><p> where <code>x</code> and <code>z</code> are either both numerical arrays of the same dimensions, or one of the two is a scalar. In the first case, the output is the same size as both arrays, and is defined elementwise by the smaller of the two arrays. In the second case, the output is defined elementwise by the smaller of the array entries and the scalar. </p>
<h1><a class="anchor" id="Function"></a>
Internals</h1>
<p>In the general version of the <code>max</code> function which is applied to a single array (using the <code>max(x,[],d)</code> or <code>max(x)</code> syntaxes), The output is computed via </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ y(m_1,\ldots,m_{d-1},1,m_{d+1},\ldots,m_{p}) = \max_{k} x(m_1,\ldots,m_{d-1},k,m_{d+1},\ldots,m_{p}), \]" src="form_20.png"/>
</p>
<p> and the output array <code>n</code> of indices is calculated via </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ n(m_1,\ldots,m_{d-1},1,m_{d+1},\ldots,m_{p}) = \arg \max_{k} x(m_1,\ldots,m_{d-1},k,m_{d+1},\ldots,m_{p}) \]" src="form_21.png"/>
</p>
<p> In the two-array version (<code>max(x,z)</code>), the single output is computed as </p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ y(m_1,\ldots,m_{d-1},1,m_{d+1},\ldots,m_{p}) = \begin{cases} x(m_1,\ldots,m_{d-1},k,m_{d+1},\ldots,m_{p}) & x(\cdots) \leq z(\cdots) \\ z(m_1,\ldots,m_{d-1},k,m_{d+1},\ldots,m_{p}) & z(\cdots) < x(\cdots). \end{cases} \]" src="form_22.png"/>
</p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>The following piece of code demonstrates various uses of the maximum function. We start with the one-array version.</p>
<pre class="fragment">--> A = [5,1,3;3,2,1;0,3,1]
A =
5 1 3
3 2 1
0 3 1
</pre><p>We first take the maximum along the columns, resulting in a row vector.</p>
<pre class="fragment">--> max(A)
ans =
5 3 3
</pre><p>Next, we take the maximum along the rows, resulting in a column vector.</p>
<pre class="fragment">--> max(A,[],2)
ans =
5
3
3
</pre><p>When the dimension argument is not supplied, <code>max</code> acts along the first non-singular dimension. For a row vector, this is the column direction:</p>
<pre class="fragment">--> max([5,3,2,9])
ans =
9
</pre><p>For the two-argument version, we can compute the smaller of two arrays, as in this example:</p>
<pre class="fragment">--> a = int8(100*randn(4))
a =
-16 65 -38 -45
-33 -46 127 -14
-110 18 -15 -11
127 -128 -128 -120
--> b = int8(100*randn(4))
b =
-60 127 -128 91
71 -128 -36 -53
8 127 -106 -128
-128 47 -93 -34
--> max(a,b)
ans =
-16 127 -38 91
71 -46 127 -14
8 127 -15 -11
127 47 -93 -34
</pre><p>Or alternately, we can compare an array with a scalar</p>
<pre class="fragment">--> a = randn(2)
a =
-0.0574 1.1346
-1.3497 -2.3248
--> max(a,0)
ans =
0 1.1346
0 0
</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>
|
