File: Exponents-and-Logarithms.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (277 lines) | stat: -rw-r--r-- 15,576 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
<!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>Exponents and Logarithms (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Exponents and Logarithms (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Exponents and Logarithms (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="Arithmetic.html" rel="up" title="Arithmetic">
<link href="Complex-Arithmetic.html" rel="next" title="Complex Arithmetic">
<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}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="section-level-extent" id="Exponents-and-Logarithms">
<div class="nav-panel">
<p>
Next: <a href="Complex-Arithmetic.html" accesskey="n" rel="next">Complex Arithmetic</a>, Up: <a href="Arithmetic.html" accesskey="u" rel="up">Arithmetic</a> &nbsp; [<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>
<h3 class="section" id="Exponents-and-Logarithms-1"><span>17.1 Exponents and Logarithms<a class="copiable-link" href="#Exponents-and-Logarithms-1"> &para;</a></span></h3>

<a class="anchor" id="XREFexp"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-exp"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">exp</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-exp"> &para;</a></span></dt>
<dd><p>Compute
<code class="code">e^x</code>
for each element of <var class="var">x</var>.
</p>
<p>To compute the matrix exponential, see <a class="pxref" href="Linear-Algebra.html">Linear Algebra</a>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFlog">log</a>.
</p></dd></dl>


<a class="anchor" id="XREFexpm1"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-expm1"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">expm1</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-expm1"> &para;</a></span></dt>
<dd><p>Compute
<code class="code">exp (<var class="var">x</var>) - 1</code>
accurately in the neighborhood of zero.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFexp">exp</a>.
</p></dd></dl>


<a class="anchor" id="XREFlog"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-log"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">log</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-log"> &para;</a></span></dt>
<dd><p>Compute the natural logarithm,
<code class="code">ln (<var class="var">x</var>)</code>,
for each element of <var class="var">x</var>.
</p>
<p>To compute the matrix logarithm, see <a class="pxref" href="Linear-Algebra.html">Linear Algebra</a>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFexp">exp</a>, <a class="ref" href="#XREFlog1p">log1p</a>, <a class="ref" href="#XREFlog2">log2</a>, <a class="ref" href="#XREFlog10">log10</a>, <a class="ref" href="Special-Utility-Matrices.html#XREFlogspace">logspace</a>.
</p></dd></dl>


<a class="anchor" id="XREFreallog"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-reallog"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">reallog</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-reallog"> &para;</a></span></dt>
<dd><p>Return the real-valued natural logarithm of each element of <var class="var">x</var>.
</p>
<p>If any element results in a complex return value <code class="code">reallog</code> aborts and
issues an error.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFlog">log</a>, <a class="ref" href="#XREFrealpow">realpow</a>, <a class="ref" href="#XREFrealsqrt">realsqrt</a>.
</p></dd></dl>


<a class="anchor" id="XREFlog1p"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-log1p"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">log1p</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-log1p"> &para;</a></span></dt>
<dd><p>Compute
<code class="code">log (1 + <var class="var">x</var>)</code>
accurately in the neighborhood of zero.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFlog">log</a>, <a class="ref" href="#XREFexp">exp</a>, <a class="ref" href="#XREFexpm1">expm1</a>.
</p></dd></dl>


<a class="anchor" id="XREFlog10"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-log10"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">log10</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-log10"> &para;</a></span></dt>
<dd><p>Compute the base-10 logarithm of each element of <var class="var">x</var>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFlog">log</a>, <a class="ref" href="#XREFlog2">log2</a>, <a class="ref" href="Special-Utility-Matrices.html#XREFlogspace">logspace</a>, <a class="ref" href="#XREFexp">exp</a>.
</p></dd></dl>


<a class="anchor" id="XREFlog2"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-log2"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">log2</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-log2"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-log2-1"><span><code class="def-type">[<var class="var">f</var>, <var class="var">e</var>] =</code> <strong class="def-name">log2</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-log2-1"> &para;</a></span></dt>
<dd><p>Compute the base-2 logarithm of each element of <var class="var">x</var>.
</p>
<p>If called with one output, compute the base-2 logarithm such that
<code class="code">2^<var class="var">y</var> = <var class="var">x</var></code>.
</p>
<p>If called with two output arguments, split <var class="var">x</var> into binary mantissa
(<var class="var">f</var>) and exponent (<var class="var">e</var>) such that
<code class="code"><var class="var">x</var> = <var class="var">f</var> * 2^<var class="var">e</var></code>
where
<code class="code">1/2&nbsp;&lt;=&nbsp;abs&nbsp;(<var class="var">f</var>)&nbsp;&lt;&nbsp;1</code><!-- /@w -->
and <var class="var">e</var> is an integer.  If
<code class="code">x&nbsp;=&nbsp;0</code><!-- /@w -->, <code class="code">f&nbsp;=&nbsp;e&nbsp;=&nbsp;0</code><!-- /@w -->.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFpow2">pow2</a>, <a class="ref" href="#XREFlog">log</a>, <a class="ref" href="#XREFlog10">log10</a>, <a class="ref" href="#XREFexp">exp</a>.
</p></dd></dl>


<a class="anchor" id="XREFpow2"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-pow2"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">pow2</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-pow2"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-pow2-1"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">pow2</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">e</var>)</code><a class="copiable-link" href="#index-pow2-1"> &para;</a></span></dt>
<dd><p>With one input argument, compute
y = 2 .^ x
for each element of <var class="var">x</var>.
</p>
<p>With two input arguments, return
y = f .* (2 .^ e).
where for complex inputs only the real part of both inputs is regarded
and from <var class="var">e</var> only the real integer part.  This calling form corresponds
to C/C++ standard function <code class="code">ldexp()</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFlog2">log2</a>, <a class="ref" href="#XREFnextpow2">nextpow2</a>, <a class="ref" href="Arithmetic-Ops.html#XREFpower">power</a>.
</p></dd></dl>


<a class="anchor" id="XREFnextpow2"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-nextpow2"><span><code class="def-type"><var class="var">n</var> =</code> <strong class="def-name">nextpow2</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-nextpow2"> &para;</a></span></dt>
<dd><p>Compute the exponent of the next power of two not smaller than the input.
</p>
<p>For each element in the input array <var class="var">x</var>, return the smallest integer
<var class="var">n</var> such that
<code class="code">2^<var class="var">n</var> &ge; abs (<var class="var">x</var>)</code>.
For input elements equal to zero, return zero.
</p>

<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFpow2">pow2</a>, <a class="ref" href="#XREFlog2">log2</a>.
</p></dd></dl>


<a class="anchor" id="XREFrealpow"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-realpow"><span><code class="def-type"><var class="var">z</var> =</code> <strong class="def-name">realpow</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">y</var>)</code><a class="copiable-link" href="#index-realpow"> &para;</a></span></dt>
<dd><p>Compute the real-valued, element-by-element power operator.
</p>
<p>This is equivalent to <code class="code"><var class="var">x</var>&nbsp;.^&nbsp;<var class="var">y</var></code><!-- /@w -->, except that
<code class="code">realpow</code> reports an error if any return value is complex.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="Arithmetic-Ops.html#XREFpower">power</a>, <a class="ref" href="#XREFreallog">reallog</a>, <a class="ref" href="#XREFrealsqrt">realsqrt</a>.
</p></dd></dl>


<a class="anchor" id="XREFsqrt"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-sqrt"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">sqrt</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-sqrt"> &para;</a></span></dt>
<dd><p>Compute the square root of each element of <var class="var">x</var>.
</p>
<p>If <var class="var">x</var> is negative, a complex result is returned.
</p>
<p>To compute the matrix square root, see <a class="pxref" href="Linear-Algebra.html">Linear Algebra</a>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFrealsqrt">realsqrt</a>, <a class="ref" href="#XREFnthroot">nthroot</a>.
</p></dd></dl>


<a class="anchor" id="XREFrealsqrt"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-realsqrt"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">realsqrt</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-realsqrt"> &para;</a></span></dt>
<dd><p>Return the real-valued square root of each element of <var class="var">x</var>.
</p>
<p>If any element results in a complex return value <code class="code">realsqrt</code> aborts and
issues an error.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFsqrt">sqrt</a>, <a class="ref" href="#XREFrealpow">realpow</a>, <a class="ref" href="#XREFreallog">reallog</a>.
</p></dd></dl>


<a class="anchor" id="XREFcbrt"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-cbrt"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">cbrt</strong> <code class="def-code-arguments">(<var class="var">x</var>)</code><a class="copiable-link" href="#index-cbrt"> &para;</a></span></dt>
<dd><p>Compute the real-valued cube root of each element of <var class="var">x</var>.
</p>
<p>Unlike <code class="code"><var class="var">x</var>^(1/3)</code>, the result will be negative if <var class="var">x</var> is
negative.
</p>
<p>If any element of <var class="var">x</var> is complex, <code class="code">cbrt</code> aborts with an error.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFnthroot">nthroot</a>.
</p></dd></dl>


<a class="anchor" id="XREFnthroot"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-nthroot"><span><code class="def-type"><var class="var">y</var> =</code> <strong class="def-name">nthroot</strong> <code class="def-code-arguments">(<var class="var">x</var>, <var class="var">n</var>)</code><a class="copiable-link" href="#index-nthroot"> &para;</a></span></dt>
<dd>
<p>Compute the real (non-complex) <var class="var">n</var>-th root of <var class="var">x</var>.
</p>
<p><var class="var">x</var> must have all real entries and <var class="var">n</var> must be a scalar.
If <var class="var">n</var> is an even integer and <var class="var">x</var> has negative entries then
<code class="code">nthroot</code> aborts and issues an error.
</p>
<p>Example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">nthroot (-1, 3)
&rArr; -1
(-1) ^ (1 / 3)
&rArr; 0.50000 - 0.86603i
</pre></div></div>

<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFrealsqrt">realsqrt</a>, <a class="ref" href="#XREFsqrt">sqrt</a>, <a class="ref" href="#XREFcbrt">cbrt</a>.
</p></dd></dl>


</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Complex-Arithmetic.html">Complex Arithmetic</a>, Up: <a href="Arithmetic.html">Arithmetic</a> &nbsp; [<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>



</body>
</html>