File: array_sort.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 (146 lines) | stat: -rw-r--r-- 5,335 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
<!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: SORT Sort</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_sort.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">SORT Sort </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>Sorts an n-dimensional array along the specified dimensional. The first form sorts the array along the first non-singular dimension. </p>
<pre class="fragment">  B = sort(A)
</pre><p> Alternately, the dimension along which to sort can be explicitly specified </p>
<pre class="fragment">  B = sort(A,dim)
</pre><p> FreeMat does not support vector arguments for <code>dim</code> - if you need <code>A</code> to be sorted along multiple dimensions (i.e., row first, then columns), make multiple calls to <code>sort</code>. Also, the direction of the sort can be specified using the <code>mode</code> argument </p>
<pre class="fragment">  B = sort(A,dim,mode)
</pre><p> where <code>mode = 'ascend'</code> means to sort the data in ascending order (the default), and <code>mode = 'descend'</code> means to sort the data into descending order.</p>
<p>When two outputs are requested from <code>sort</code>, the indexes are also returned. Thus, for </p>
<pre class="fragment">  [B,IX] = sort(A)
  [B,IX] = sort(A,dim)
  [B,IX] = sort(A,dim,mode)
</pre><p> an array <code>IX</code> of the same size as <code>A</code>, where <code>IX</code> records the indices of <code>A</code> (along the sorting dimension) corresponding to the output array <code>B</code>.</p>
<p>Two additional issues worth noting. First, a cell array can be sorted if each cell contains a <code>string</code>, in which case the strings are sorted by lexical order. The second issue is that FreeMat uses the same method as MATLAB to sort complex numbers. In particular, a complex number <code>a</code> is less than another complex number <code>b</code> if <code>abs(a) &lt; abs(b)</code>. If the magnitudes are the same then we test the angle of <code>a</code>, i.e. <code>angle(a) &lt; angle(b)</code>, where <code>angle(a)</code> is the phase of <code>a</code> between <code>-pi,pi</code>. </p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>Here are some examples of sorting on numerical arrays.</p>
<pre class="fragment">--&gt; A = int32(10*rand(4,3))

A = 
 8 2 8 
 0 5 5 
 2 5 7 
 3 7 1 

--&gt; [B,IX] = sort(A)
B = 
 0 2 1 
 2 5 5 
 3 5 7 
 8 7 8 

IX = 
 2 1 4 
 3 2 2 
 4 3 3 
 1 4 1 

--&gt; [B,IX] = sort(A,2)
B = 
 2 8 8 
 0 5 5 
 2 5 7 
 1 3 7 

IX = 
 2 1 3 
 1 2 3 
 1 2 3 
 3 1 2 

--&gt; [B,IX] = sort(A,1,'descend')
B = 
 8 7 8 
 3 5 7 
 2 5 5 
 0 2 1 

IX = 
 1 4 1 
 4 2 3 
 3 3 2 
 2 1 4 
</pre><p>Here we sort a cell array of strings.</p>
<pre class="fragment">--&gt; a = {'hello','abba','goodbye','jockey','cake'}

a = 
 [hello] [abba] [goodbye] [jockey] [cake] 

--&gt; b = sort(a)

b = 
 [abba] [cake] [goodbye] [hello] [jockey] 
</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>