Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 3e60ff9d4d6f58c8fbd17208f14089fa > files > 273

octave-doc-3.2.3-3mdv2010.0.i586.rpm

<html lang="en">
<head>
<title>Mathematical Constants - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Arithmetic.html#Arithmetic" title="Arithmetic">
<link rel="prev" href="Coordinate-Transformations.html#Coordinate-Transformations" title="Coordinate Transformations">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<a name="Mathematical-Constants"></a>
<p>
Previous:&nbsp;<a rel="previous" accesskey="p" href="Coordinate-Transformations.html#Coordinate-Transformations">Coordinate Transformations</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Arithmetic.html#Arithmetic">Arithmetic</a>
<hr>
</div>

<h3 class="section">17.8 Mathematical Constants</h3>

<!-- data.cc -->
<p><a name="doc_002de"></a>

<div class="defun">
&mdash; Built-in Function:  <b>e</b><var><a name="index-e-1509"></a></var><br>
&mdash; Built-in Function:  <b>e</b> (<var>n</var>)<var><a name="index-e-1510"></a></var><br>
&mdash; Built-in Function:  <b>e</b> (<var>n, m</var>)<var><a name="index-e-1511"></a></var><br>
&mdash; Built-in Function:  <b>e</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-e-1512"></a></var><br>
&mdash; Built-in Function:  <b>e</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-e-1513"></a></var><br>
<blockquote><p>Return a scalar, matrix, or N-dimensional array whose elements are all equal
to the base of natural logarithms.  The constant
&lsquo;<samp><span class="samp">e</span></samp>&rsquo; satisfies the equation <code>log</code> (e) = 1.

        <p>When called with no arguments, return a scalar with the value e.  When
called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002dpi"></a>

<div class="defun">
&mdash; Built-in Function:  <b>pi</b><var><a name="index-pi-1514"></a></var><br>
&mdash; Built-in Function:  <b>pi</b> (<var>n</var>)<var><a name="index-pi-1515"></a></var><br>
&mdash; Built-in Function:  <b>pi</b> (<var>n, m</var>)<var><a name="index-pi-1516"></a></var><br>
&mdash; Built-in Function:  <b>pi</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-pi-1517"></a></var><br>
&mdash; Built-in Function:  <b>pi</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-pi-1518"></a></var><br>
<blockquote><p>Return a scalar, matrix, or N-dimensional array whose elements are all equal
to the ratio of the circumference of a circle to its
diameter. 
Internally, <code>pi</code> is computed as &lsquo;<samp><span class="samp">4.0 * atan (1.0)</span></samp>&rsquo;.

        <p>When called with no arguments, return a scalar with the value of
pi. 
When called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002dI"></a>

<div class="defun">
&mdash; Built-in Function:  <b>I</b><var><a name="index-I-1519"></a></var><br>
&mdash; Built-in Function:  <b>I</b> (<var>n</var>)<var><a name="index-I-1520"></a></var><br>
&mdash; Built-in Function:  <b>I</b> (<var>n, m</var>)<var><a name="index-I-1521"></a></var><br>
&mdash; Built-in Function:  <b>I</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-I-1522"></a></var><br>
&mdash; Built-in Function:  <b>I</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-I-1523"></a></var><br>
<blockquote><p>Return a scalar, matrix, or N-dimensional array whose elements are all equal
to the pure imaginary unit, defined as
<code>sqrt (-1)</code>. 
 I, and its equivalents i, J, and j, are functions so any of the names may
be reused for other purposes (such as i for a counter variable).

        <p>When called with no arguments, return a scalar with the value i.  When
called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002dInf"></a>

<div class="defun">
&mdash; Built-in Function:  <b>Inf</b><var><a name="index-Inf-1524"></a></var><br>
&mdash; Built-in Function:  <b>Inf</b> (<var>n</var>)<var><a name="index-Inf-1525"></a></var><br>
&mdash; Built-in Function:  <b>Inf</b> (<var>n, m</var>)<var><a name="index-Inf-1526"></a></var><br>
&mdash; Built-in Function:  <b>Inf</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-Inf-1527"></a></var><br>
&mdash; Built-in Function:  <b>Inf</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-Inf-1528"></a></var><br>
<blockquote><p>Return a scalar, matrix or N-dimensional array whose elements are all equal
to the IEEE representation for positive infinity.

        <p>Infinity is produced when results are too large to be represented using the
the IEEE floating point format for numbers.  Two common examples which
produce infinity are division by zero and overflow.
     <pre class="example">          [1/0 e^800]
          &rArr;
          Inf   Inf
</pre>
        <p>When called with no arguments, return a scalar with the value &lsquo;<samp><span class="samp">Inf</span></samp>&rsquo;. 
When called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->

     <p class="noindent"><strong>See also:</strong> <a href="doc_002disinf.html#doc_002disinf">isinf</a>. 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002dNaN"></a>

<div class="defun">
&mdash; Built-in Function:  <b>NaN</b><var><a name="index-NaN-1529"></a></var><br>
&mdash; Built-in Function:  <b>NaN</b> (<var>n</var>)<var><a name="index-NaN-1530"></a></var><br>
&mdash; Built-in Function:  <b>NaN</b> (<var>n, m</var>)<var><a name="index-NaN-1531"></a></var><br>
&mdash; Built-in Function:  <b>NaN</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-NaN-1532"></a></var><br>
&mdash; Built-in Function:  <b>NaN</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-NaN-1533"></a></var><br>
<blockquote><p>Return a scalar, matrix, or N-dimensional array whose elements are all equal
to the IEEE symbol NaN (Not a Number). 
NaN is the result of operations which do not produce a well defined numerical
result.  Common operations which produce a NaN are arithmetic with infinity
(Inf - Inf), zero divided by zero (0/0),
and any operation involving another NaN value (5 + NaN).

        <p>Note that NaN always compares not equal to NaN (NaN != NaN).  This behavior
is specified by the IEEE standard for floating point arithmetic.  To
find NaN values, use the <code>isnan</code> function.

        <p>When called with no arguments, return a scalar with the value &lsquo;<samp><span class="samp">NaN</span></samp>&rsquo;. 
When called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->

     <p class="noindent"><strong>See also:</strong> <a href="doc_002disnan.html#doc_002disnan">isnan</a>. 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002deps"></a>

<div class="defun">
&mdash; Built-in Function:  <b>eps</b><var><a name="index-eps-1534"></a></var><br>
&mdash; Built-in Function:  <b>eps</b> (<var>x</var>)<var><a name="index-eps-1535"></a></var><br>
&mdash; Built-in Function:  <b>eps</b> (<var>n, m</var>)<var><a name="index-eps-1536"></a></var><br>
&mdash; Built-in Function:  <b>eps</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-eps-1537"></a></var><br>
&mdash; Built-in Function:  <b>eps</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-eps-1538"></a></var><br>
<blockquote><p>Return a scalar, matrix or N-dimensional array whose elements are all eps,
the machine precision.  More precisely, <code>eps</code> is the relative spacing
between any two adjacent numbers in the machine's floating point system. 
This number is obviously system dependent.  On machines that support IEEE
floating point arithmetic, <code>eps</code> is approximately
2.2204e-16 for double precision and 1.1921e-07
for single precision.

        <p>When called with no arguments, return a scalar with the value
<code>eps(1.0)</code>. 
Given a single argument <var>x</var>, return the distance between <var>x</var> and
the next largest value. 
When called with more than one argument the first two arguments are taken as
the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002drealmax"></a>

<div class="defun">
&mdash; Built-in Function:  <b>realmax</b><var><a name="index-realmax-1539"></a></var><br>
&mdash; Built-in Function:  <b>realmax</b> (<var>n</var>)<var><a name="index-realmax-1540"></a></var><br>
&mdash; Built-in Function:  <b>realmax</b> (<var>n, m</var>)<var><a name="index-realmax-1541"></a></var><br>
&mdash; Built-in Function:  <b>realmax</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-realmax-1542"></a></var><br>
&mdash; Built-in Function:  <b>realmax</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-realmax-1543"></a></var><br>
<blockquote><p>Return a scalar, matrix or N-dimensional array whose elements are all equal
to the largest floating point number that is representable.  The actual
value is system dependent.  On machines that support IEEE
floating point arithmetic, <code>realmax</code> is approximately
1.7977e+308 for double precision and 3.4028e+38
for single precision.

        <p>When called with no arguments, return a scalar with the value
<code>realmax("double")</code>. 
When called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->

     <p class="noindent"><strong>See also:</strong> <a href="doc_002drealmin.html#doc_002drealmin">realmin</a>, <a href="doc_002dintmax.html#doc_002dintmax">intmax</a>, <a href="doc_002dbitmax.html#doc_002dbitmax">bitmax</a>. 
</p></blockquote></div>

<!-- data.cc -->
   <p><a name="doc_002drealmin"></a>

<div class="defun">
&mdash; Built-in Function:  <b>realmin</b><var><a name="index-realmin-1544"></a></var><br>
&mdash; Built-in Function:  <b>realmin</b> (<var>n</var>)<var><a name="index-realmin-1545"></a></var><br>
&mdash; Built-in Function:  <b>realmin</b> (<var>n, m</var>)<var><a name="index-realmin-1546"></a></var><br>
&mdash; Built-in Function:  <b>realmin</b> (<var>n, m, k, <small class="dots">...</small></var>)<var><a name="index-realmin-1547"></a></var><br>
&mdash; Built-in Function:  <b>realmin</b> (<var><small class="dots">...</small>, class</var>)<var><a name="index-realmin-1548"></a></var><br>
<blockquote><p>Return a scalar, matrix or N-dimensional array whose elements are all equal
to the smallest normalized floating point number that is representable. 
The actual value is system dependent.  On machines that support
IEEE floating point arithmetic, <code>realmin</code> is approximately
2.2251e-308 for double precision and 1.1755e-38
for single precision.

        <p>When called with no arguments, return a scalar with the value
<code>realmin("double")</code>. 
When called with a single argument, return a square matrix with the dimension
specified.  When called with more than one scalar argument the first two
arguments are taken as the number of rows and columns and any further
arguments specify additional matrix dimensions. 
The optional argument <var>class</var> specifies the return type and may be
either "double" or "single". 
<!-- Texinfo @sp should work but in practice produces ugly results for HTML. -->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->

     <p class="noindent"><strong>See also:</strong> <a href="doc_002drealmax.html#doc_002drealmax">realmax</a>, <a href="doc_002dintmin.html#doc_002dintmin">intmin</a>. 
</p></blockquote></div>

<!-- DO NOT EDIT!  Generated automatically by munge-texi. -->
<!-- Copyright (C) 1996, 1997, 2007, 2008, 2009 John W. Eaton -->
<!-- This file is part of Octave. -->
<!-- Octave is free software; you can redistribute it and/or modify it -->
<!-- under the terms of the GNU General Public License as published by the -->
<!-- Free Software Foundation; either version 3 of the License, or (at -->
<!-- your option) any later version. -->
<!-- Octave is distributed in the hope that it will be useful, but WITHOUT -->
<!-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -->
<!-- FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License -->
<!-- for more details. -->
<!-- You should have received a copy of the GNU General Public License -->
<!-- along with Octave; see the file COPYING.  If not, see -->
<!-- <http://www.gnu.org/licenses/>. -->
   </body></html>