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
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Private Functions (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Private Functions (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Private Functions (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Function-Files.html" rel="up" title="Function Files">
<link href="Nested-Functions.html" rel="next" title="Nested Functions">
<link href="Subfunctions.html" rel="prev" title="Subfunctions">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="Private-Functions">
<div class="nav-panel">
<p>
Next: <a href="Nested-Functions.html" accesskey="n" rel="next">Nested Functions</a>, Previous: <a href="Subfunctions.html" accesskey="p" rel="prev">Subfunctions</a>, Up: <a href="Function-Files.html" accesskey="u" rel="up">Function Files</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Private-Functions-1"><span>11.10.3 Private Functions<a class="copiable-link" href="#Private-Functions-1"> ¶</a></span></h4>
<p>In many cases one function needs to access one or more helper
functions. If the helper function is limited to the scope of a single
function, then subfunctions as discussed above might be used. However,
if a single helper function is used by more than one function, then
this is no longer possible. In this case the helper functions might
be placed in a subdirectory, called "private", of the directory in which
the functions needing access to this helper function are found.
</p>
<p>As a simple example, consider a function <code class="code">func1</code>, that calls a helper
function <code class="code">func2</code> to do much of the work. For example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">function y = func1 (x)
y = func2 (x);
endfunction
</pre></div></div>
<p>Then if the path to <code class="code">func1</code> is <code class="code"><directory>/func1.m</code>, and if
<code class="code">func2</code> is found in the directory <code class="code"><directory>/private/func2.m</code>,
then <code class="code">func2</code> is only available for use of the functions, like
<code class="code">func1</code>, that are found in <code class="code"><directory></code>.
</p>
</div>
</body>
</html>
|
