File: array_reshape.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 (125 lines) | stat: -rw-r--r-- 4,947 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
<!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: RESHAPE Reshape An Array</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_reshape.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">RESHAPE Reshape An Array </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>Reshapes an array from one size to another. Two seperate syntaxes are possible. The first syntax specifies the array dimensions as a sequence of scalar dimensions: </p>
<pre class="fragment">   y = reshape(x,d1,d2,...,dn).
</pre><p> The resulting array has the given dimensions, and is filled with the contents of <code>x</code>. The type of <code>y</code> is the same as <code>x</code>.</p>
<p>As a special case, you can specify exactly one of the dimensions as an empty matrix <code>[]</code>, in which case FreeMat will compute the size required in that dimension to make the reshape work. The syntax for this version is </p>
<pre class="fragment">   y = reshape(x,d1,...,da,[],db,...,dn)
</pre><p>The second syntax specifies the array dimensions as a vector, where each element in the vector specifies a dimension length: </p>
<pre class="fragment">   y = reshape(x,[d1,d2,...,dn]).
</pre><p> This syntax is more convenient for calling <code>reshape</code> using a variable for the argument. The <code>reshape</code> function requires that the length of <code>x</code> equal the product of the <code>di</code> values. Note that arrays are stored in column format, which means that elements in <code>x</code> are transferred to the new array <code>y</code> starting with the first column first element, then proceeding to the last element of the first column, then the first element of the second column, etc. </p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>Here are several examples of the use of <code>reshape</code> applied to various arrays. The first example reshapes a row vector into a matrix.</p>
<pre class="fragment">--&gt; a = uint8(1:6)

a = 
 1 2 3 4 5 6 

--&gt; reshape(a,2,3)

ans = 
 1 3 5 
 2 4 6 
</pre><p>The second example reshapes a longer row vector into a volume with two planes.</p>
<pre class="fragment">--&gt; a = uint8(1:12)

a = 
  1  2  3  4  5  6  7  8  9 10 11 12 

--&gt; reshape(a,[2,3,2])

ans = 

(:,:,1) = 
  1  3  5 
  2  4  6 

(:,:,2) = 
  7  9 11 
  8 10 12 
</pre><p>The third example reshapes a matrix into another matrix.</p>
<pre class="fragment">--&gt; a = [1,6,7;3,4,2]

a = 
 1 6 7 
 3 4 2 

--&gt; reshape(a,3,2)

ans = 
 1 4 
 3 7 
 6 2 
</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>