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
|
<!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: RETURN Return From 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('flow_return.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">RETURN Return From Function </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_flow.html">Flow Control</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>The <code>return</code> statement is used to immediately return from a function, or to return from a <code>keyboard</code> session. The syntax for its use is </p>
<pre class="fragment"> return
</pre><p> Inside a function, a <code>return</code> statement causes FreeMat to exit the function immediately. When a <code>keyboard</code> session is active, the <code>return</code> statement causes execution to resume where the <code>keyboard</code> session started. </p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>In the first example, we define a function that uses a <code>return</code> to exit the function if a certain test condition is satisfied.</p>
<pre class="fragment"> return_func.m
</pre><pre class="fragment">function ret = return_func(a,b)
ret = 'a is greater';
if (a > b)
return;
end
ret = 'b is greater';
printf('finishing up...\n');
</pre><p>Next we exercise the function with a few simple test cases:</p>
<pre class="fragment">--> return_func(1,3)
finishing up...
ans =
b is greater
--> return_func(5,2)
ans =
a is greater
</pre><p>In the second example, we take the function and rewrite it to use a <code>keyboard</code> statement inside the <code>if</code> statement.</p>
<pre class="fragment"> return_func2.m
</pre><pre class="fragment">function ret = return_func2(a,b)
if (a > b)
ret = 'a is greater';
keyboard;
else
ret = 'b is greater';
end
printf('finishing up...\n');
</pre><p>Now, we call the function with a larger first argument, which triggers the <code>keyboard</code> session. After verifying a few values inside the <code>keyboard</code> session, we issue a <code>return</code> statement to resume execution.</p>
<pre class="fragment">--> return_func2(2,4)
finishing up...
ans =
b is greater
--> return_func2(5,1)
[return_func2,4]--> ret
ans =
a is greater
[return_func2,4]--> a
ans =
5
[return_func2,4]--> b
ans =
1
[return_func2,4]--> return
finishing up...
ans =
a is greater
</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_flow.html">Flow Control</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>
|
