/usr/share/doc/octave/octave.html/Default-Arguments.html is in octave-doc 4.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Default Arguments (GNU Octave)</title>
<meta name="description" content="Default Arguments (GNU Octave)">
<meta name="keywords" content="Default Arguments (GNU Octave)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Functions-and-Scripts.html#Functions-and-Scripts" rel="up" title="Functions and Scripts">
<link href="Function-Files.html#Function-Files" rel="next" title="Function Files">
<link href="Returning-from-a-Function.html#Returning-from-a-Function" rel="prev" title="Returning from a Function">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<a name="Default-Arguments"></a>
<div class="header">
<p>
Next: <a href="Function-Files.html#Function-Files" accesskey="n" rel="next">Function Files</a>, Previous: <a href="Returning-from-a-Function.html#Returning-from-a-Function" accesskey="p" rel="prev">Returning from a Function</a>, Up: <a href="Functions-and-Scripts.html#Functions-and-Scripts" accesskey="u" rel="up">Functions and Scripts</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Default-Arguments-1"></a>
<h3 class="section">11.8 Default Arguments</h3>
<a name="index-default-arguments"></a>
<p>Since Octave supports variable number of input arguments, it is very useful
to assign default values to some input arguments. When an input argument
is declared in the argument list it is possible to assign a default
value to the argument like this
</p>
<div class="example">
<pre class="example">function <var>name</var> (<var>arg1</var> = <var>val1</var>, …)
<var>body</var>
endfunction
</pre></div>
<p>If no value is assigned to <var>arg1</var> by the user, it will have the
value <var>val1</var>.
</p>
<p>As an example, the following function implements a variant of the classic
“Hello, World” program.
</p>
<div class="example">
<pre class="example">function hello (who = "World")
printf ("Hello, %s!\n", who);
endfunction
</pre></div>
<p>When called without an input argument the function prints the following
</p>
<div class="example">
<pre class="example">hello ();
-| Hello, World!
</pre></div>
<p>and when it’s called with an input argument it prints the following
</p>
<div class="example">
<pre class="example">hello ("Beautiful World of Free Software");
-| Hello, Beautiful World of Free Software!
</pre></div>
<p>Sometimes it is useful to explicitly tell Octave to use the default value
of an input argument. This can be done writing a ‘<samp>:</samp>’ as the value
of the input argument when calling the function.
</p>
<div class="example">
<pre class="example">hello (:);
-| Hello, World!
</pre></div>
</body>
</html>
|