[gnumeric] first part of fixes to functions.xml
- From: Andreas J. Guelzow <guelzow src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gnumeric] first part of fixes to functions.xml
- Date: Sat, 9 Jan 2010 20:12:39 +0000 (UTC)
commit 7f30a72ae05e508268672d4478f092fb44be4718
Author: Andreas J. Guelzow <aguelzow pyrshep ca>
Date: Sat Jan 9 13:11:58 2010 -0700
first part of fixes to functions.xml
2010-01-07 Andreas J. Guelzow <aguelzow pyrshep>
* make-func-list.pl (process_function):
don't push refnamediv
(process_short_desc): close refnamediv
2010-01-09 Andreas J. Guelzow <aguelzow pyrshep>
* functions.xml: renewed
doc/C/ChangeLog | 4 +
doc/C/functions.xml |37478 ++++++++++++++++++++++++------------------------
doc/ChangeLog | 6 +
doc/make-func-list.pl | 3 +-
4 files changed, 18750 insertions(+), 18741 deletions(-)
---
diff --git a/doc/C/ChangeLog b/doc/C/ChangeLog
index 7aaefe3..20328f4 100644
--- a/doc/C/ChangeLog
+++ b/doc/C/ChangeLog
@@ -1,3 +1,7 @@
+2010-01-09 Andreas J. Guelzow <aguelzow pyrshep>
+
+ * functions.xml: renewed
+
2010-01-08 Andreas J. Guelzow <aguelzow pyrshep>
* func.defs: propagate changes and additions in
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index dff9bf9..2e48573 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -20,152 +20,152 @@
<function>BITAND</function>
</refname>
<refpurpose>
- bitwise and
- </refpurpose>
+ bitwise and
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BITAND</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BITAND</function> returns the bitwise and of the binary representations of its arguments.</para>
+ <para><parameter>a</parameter>: non-negative integer</para>
+ <para><parameter>b</parameter>: non-negative integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BITOR"><function>BITOR</function></link>,
+ <link linkend="gnumeric-BITXOR"><function>BITXOR</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>BITAND</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BITAND</function> returns the bitwise and of the binary representations of its arguments.</para>
- <para><parameter>a</parameter>: non-negative integer</para>
- <para><parameter>b</parameter>: non-negative integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BITOR"><function>BITOR</function></link>,
- <link linkend="gnumeric-BITXOR"><function>BITXOR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BITLSHIFT">
- <refmeta>
- <refentrytitle>
- <function>BITLSHIFT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BITLSHIFT</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-BITLSHIFT">
+ <refmeta>
+ <refentrytitle>
+ <function>BITLSHIFT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BITLSHIFT</function>
+ </refname>
+ <refpurpose>
bit-shift to the left
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BITLSHIFT</function>(<parameter>a</parameter>,<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BITLSHIFT</function> returns the binary representations of <parameter>a</parameter> shifted <parameter>n</parameter> positions to the left.</para>
- <para><parameter>a</parameter>: non-negative integer</para>
- <para><parameter>n</parameter>: integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> is negative, <function>BITLSHIFT</function> shifts the bits to the right by ABS(<parameter>n</parameter>) positions.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BITRSHIFT"><function>BITRSHIFT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BITOR">
- <refmeta>
- <refentrytitle>
- <function>BITOR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BITOR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BITLSHIFT</function>(<parameter>a</parameter>,<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BITLSHIFT</function> returns the binary representations of <parameter>a</parameter> shifted <parameter>n</parameter> positions to the left.</para>
+ <para><parameter>a</parameter>: non-negative integer</para>
+ <para><parameter>n</parameter>: integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> is negative, <function>BITLSHIFT</function> shifts the bits to the right by ABS(<parameter>n</parameter>) positions.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BITRSHIFT"><function>BITRSHIFT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BITOR">
+ <refmeta>
+ <refentrytitle>
+ <function>BITOR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BITOR</function>
+ </refname>
+ <refpurpose>
bitwise or
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BITOR</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BITOR</function> returns the bitwise or of the binary representations of its arguments.</para>
- <para><parameter>a</parameter>: non-negative integer</para>
- <para><parameter>b</parameter>: non-negative integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BITXOR"><function>BITXOR</function></link>,
- <link linkend="gnumeric-BITAND"><function>BITAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BITRSHIFT">
- <refmeta>
- <refentrytitle>
- <function>BITRSHIFT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BITRSHIFT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BITOR</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BITOR</function> returns the bitwise or of the binary representations of its arguments.</para>
+ <para><parameter>a</parameter>: non-negative integer</para>
+ <para><parameter>b</parameter>: non-negative integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BITXOR"><function>BITXOR</function></link>,
+ <link linkend="gnumeric-BITAND"><function>BITAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BITRSHIFT">
+ <refmeta>
+ <refentrytitle>
+ <function>BITRSHIFT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BITRSHIFT</function>
+ </refname>
+ <refpurpose>
bit-shift to the right
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BITRSHIFT</function>(<parameter>a</parameter>,<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BITRSHIFT</function> returns the binary representations of <parameter>a</parameter> shifted <parameter>n</parameter> positions to the right.</para>
- <para><parameter>a</parameter>: non-negative integer</para>
- <para><parameter>n</parameter>: integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> is negative, <function>BITRSHIFT</function> shifts the bits to the left by ABS(<parameter>n</parameter>) positions.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BITLSHIFT"><function>BITLSHIFT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BITXOR">
- <refmeta>
- <refentrytitle>
- <function>BITXOR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BITXOR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BITRSHIFT</function>(<parameter>a</parameter>,<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BITRSHIFT</function> returns the binary representations of <parameter>a</parameter> shifted <parameter>n</parameter> positions to the right.</para>
+ <para><parameter>a</parameter>: non-negative integer</para>
+ <para><parameter>n</parameter>: integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> is negative, <function>BITRSHIFT</function> shifts the bits to the left by ABS(<parameter>n</parameter>) positions.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BITLSHIFT"><function>BITLSHIFT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BITXOR">
+ <refmeta>
+ <refentrytitle>
+ <function>BITXOR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BITXOR</function>
+ </refname>
+ <refpurpose>
bitwise exclusive or
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BITXOR</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BITXOR</function> returns the bitwise exclusive or of the binary representations of its arguments.</para>
- <para><parameter>a</parameter>: non-negative integer</para>
- <para><parameter>b</parameter>: non-negative integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BITOR"><function>BITOR</function></link>,
- <link linkend="gnumeric-BITAND"><function>BITAND</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BITXOR</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BITXOR</function> returns the bitwise exclusive or of the binary representations of its arguments.</para>
+ <para><parameter>a</parameter>: non-negative integer</para>
+ <para><parameter>b</parameter>: non-negative integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BITOR"><function>BITOR</function></link>,
+ <link linkend="gnumeric-BITAND"><function>BITAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Complex">
<title>Complex</title>
<refentry id="gnumeric-COMPLEX">
@@ -179,1327 +179,1327 @@
<function>COMPLEX</function>
</refname>
<refpurpose>
- a complex number of the form <parameter>x</parameter> + <parameter>y</parameter><parameter>i</parameter>.
- </refpurpose>
+ a complex number of the form <parameter>x</parameter> + <parameter>y</parameter><parameter>i</parameter>.
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COMPLEX</function>(<parameter>x</parameter>,<parameter>y</parameter>,<parameter>i</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: real part</para>
+ <para><parameter>y</parameter>: imaginary part</para>
+ <para><parameter>i</parameter>: the suffix for the complex number, either "i" or "j"; defaults to "i".</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>i</parameter> is neither "i" nor "j", <function>COMPLEX</function> returns #VALUE!</para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>COMPLEX</function>(<parameter>x</parameter>,<parameter>y</parameter>,<parameter>i</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: real part</para>
- <para><parameter>y</parameter>: imaginary part</para>
- <para><parameter>i</parameter>: the suffix for the complex number, either "i" or "j"; defaults to "i".</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>i</parameter> is neither "i" nor "j", <function>COMPLEX</function> returns #VALUE!</para>
- </refsect1>
- <refentry id="gnumeric-IMABS">
- <refmeta>
- <refentrytitle>
- <function>IMABS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMABS</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-IMABS">
+ <refmeta>
+ <refentrytitle>
+ <function>IMABS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMABS</function>
+ </refname>
+ <refpurpose>
the absolute value of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMABS</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>,
- <link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMAGINARY">
- <refmeta>
- <refentrytitle>
- <function>IMAGINARY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMAGINARY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMABS</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>,
+ <link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMAGINARY">
+ <refmeta>
+ <refentrytitle>
+ <function>IMAGINARY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMAGINARY</function>
+ </refname>
+ <refpurpose>
the imaginary part of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMAGINARY</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCCOS">
- <refmeta>
- <refentrytitle>
- <function>IMARCCOS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCCOS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMAGINARY</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCCOS">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCCOS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCCOS</function>
+ </refname>
+ <refpurpose>
the complex arccosine of the complex number
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCCOS</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCCOS</function> returns the complex arccosine of the complex number <parameter>z</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSIN"><function>IMARCSIN</function></link>,
- <link linkend="gnumeric-IMARCTAN"><function>IMARCTAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCCOSH">
- <refmeta>
- <refentrytitle>
- <function>IMARCCOSH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCCOSH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCCOS</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IMARCCOS</function> returns the complex arccosine of the complex number <parameter>z</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSIN"><function>IMARCSIN</function></link>,
+ <link linkend="gnumeric-IMARCTAN"><function>IMARCTAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCCOSH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCCOSH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCCOSH</function>
+ </refname>
+ <refpurpose>
the complex hyperbolic arccosine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCCOSH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCCOSH</function> returns the complex hyperbolic arccosine of the complex number <parameter>z</parameter>. The branch cut is on the real axis, less than 1.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSINH"><function>IMARCSINH</function></link>,
- <link linkend="gnumeric-IMARCTANH"><function>IMARCTANH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCCOT">
- <refmeta>
- <refentrytitle>
- <function>IMARCCOT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCCOT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCCOSH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IMARCCOSH</function> returns the complex hyperbolic arccosine of the complex number <parameter>z</parameter>. The branch cut is on the real axis, less than 1.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSINH"><function>IMARCSINH</function></link>,
+ <link linkend="gnumeric-IMARCTANH"><function>IMARCTANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCCOT">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCCOT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCCOT</function>
+ </refname>
+ <refpurpose>
the complex arccotangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCCOT</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSEC"><function>IMARCSEC</function></link>,
- <link linkend="gnumeric-IMARCCSC"><function>IMARCCSC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCCOTH">
- <refmeta>
- <refentrytitle>
- <function>IMARCCOTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCCOTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCCOT</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSEC"><function>IMARCSEC</function></link>,
+ <link linkend="gnumeric-IMARCCSC"><function>IMARCCSC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCCOTH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCCOTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCCOTH</function>
+ </refname>
+ <refpurpose>
the complex hyperbolic arccotangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCCOTH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSECH"><function>IMARCSECH</function></link>,
- <link linkend="gnumeric-IMARCCSCH"><function>IMARCCSCH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCCSC">
- <refmeta>
- <refentrytitle>
- <function>IMARCCSC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCCSC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCCOTH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSECH"><function>IMARCSECH</function></link>,
+ <link linkend="gnumeric-IMARCCSCH"><function>IMARCCSCH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCCSC">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCCSC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCCSC</function>
+ </refname>
+ <refpurpose>
the complex arccosecant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCCSC</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSEC"><function>IMARCSEC</function></link>,
- <link linkend="gnumeric-IMARCCOT"><function>IMARCCOT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCCSCH">
- <refmeta>
- <refentrytitle>
- <function>IMARCCSCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCCSCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCCSC</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSEC"><function>IMARCSEC</function></link>,
+ <link linkend="gnumeric-IMARCCOT"><function>IMARCCOT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCCSCH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCCSCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCCSCH</function>
+ </refname>
+ <refpurpose>
the complex hyperbolic arccosecant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCCSCH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSECH"><function>IMARCSECH</function></link>,
- <link linkend="gnumeric-IMARCCOTH"><function>IMARCCOTH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCSEC">
- <refmeta>
- <refentrytitle>
- <function>IMARCSEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCSEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCCSCH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSECH"><function>IMARCSECH</function></link>,
+ <link linkend="gnumeric-IMARCCOTH"><function>IMARCCOTH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCSEC">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCSEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCSEC</function>
+ </refname>
+ <refpurpose>
the complex arcsecant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCSEC</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCCSC"><function>IMARCCSC</function></link>,
- <link linkend="gnumeric-IMARCCOT"><function>IMARCCOT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCSECH">
- <refmeta>
- <refentrytitle>
- <function>IMARCSECH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCSECH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCSEC</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCCSC"><function>IMARCCSC</function></link>,
+ <link linkend="gnumeric-IMARCCOT"><function>IMARCCOT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCSECH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCSECH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCSECH</function>
+ </refname>
+ <refpurpose>
the complex hyperbolic arcsecant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCSECH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCCSCH"><function>IMARCCSCH</function></link>,
- <link linkend="gnumeric-IMARCCOTH"><function>IMARCCOTH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCSIN">
- <refmeta>
- <refentrytitle>
- <function>IMARCSIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCSIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCSECH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCCSCH"><function>IMARCCSCH</function></link>,
+ <link linkend="gnumeric-IMARCCOTH"><function>IMARCCOTH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCSIN">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCSIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCSIN</function>
+ </refname>
+ <refpurpose>
the complex arcsine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCSIN</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCSIN</function> returns the complex arcsine of the complex number <parameter>z</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCCOS"><function>IMARCCOS</function></link>,
- <link linkend="gnumeric-IMARCTAN"><function>IMARCTAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCSINH">
- <refmeta>
- <refentrytitle>
- <function>IMARCSINH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCSINH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCSIN</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IMARCSIN</function> returns the complex arcsine of the complex number <parameter>z</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCCOS"><function>IMARCCOS</function></link>,
+ <link linkend="gnumeric-IMARCTAN"><function>IMARCTAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCSINH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCSINH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCSINH</function>
+ </refname>
+ <refpurpose>
the complex hyperbolic arcsine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCSINH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCSINH</function> returns the complex hyperbolic arcsine of the complex number <parameter>z</parameter>. The branch cuts are on the imaginary axis, below -i and above i.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCCOSH"><function>IMARCCOSH</function></link>,
- <link linkend="gnumeric-IMARCTANH"><function>IMARCTANH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCTAN">
- <refmeta>
- <refentrytitle>
- <function>IMARCTAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCTAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCSINH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IMARCSINH</function> returns the complex hyperbolic arcsine of the complex number <parameter>z</parameter>. The branch cuts are on the imaginary axis, below -i and above i.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCCOSH"><function>IMARCCOSH</function></link>,
+ <link linkend="gnumeric-IMARCTANH"><function>IMARCTANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCTAN">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCTAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCTAN</function>
+ </refname>
+ <refpurpose>
the complex arctangent of the complex number
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCTAN</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCTAN</function> returns the complex arctangent of the complex number <parameter>z</parameter>. The branch cuts are on the imaginary axis, below -i and above i.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSIN"><function>IMARCSIN</function></link>,
- <link linkend="gnumeric-IMARCCOS"><function>IMARCCOS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARCTANH">
- <refmeta>
- <refentrytitle>
- <function>IMARCTANH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARCTANH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCTAN</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IMARCTAN</function> returns the complex arctangent of the complex number <parameter>z</parameter>. The branch cuts are on the imaginary axis, below -i and above i.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSIN"><function>IMARCSIN</function></link>,
+ <link linkend="gnumeric-IMARCCOS"><function>IMARCCOS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARCTANH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARCTANH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARCTANH</function>
+ </refname>
+ <refpurpose>
the complex hyperbolic arctangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARCTANH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCTANH</function> returns the complex hyperbolic arctangent of the complex number <parameter>z</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMARCSINH"><function>IMARCSINH</function></link>,
- <link linkend="gnumeric-IMARCCOSH"><function>IMARCCOSH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMARGUMENT">
- <refmeta>
- <refentrytitle>
- <function>IMARGUMENT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMARGUMENT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARCTANH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IMARCTANH</function> returns the complex hyperbolic arctangent of the complex number <parameter>z</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMARCSINH"><function>IMARCSINH</function></link>,
+ <link linkend="gnumeric-IMARCCOSH"><function>IMARCCOSH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMARGUMENT">
+ <refmeta>
+ <refentrytitle>
+ <function>IMARGUMENT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMARGUMENT</function>
+ </refname>
+ <refpurpose>
the argument theta of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMARGUMENT</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The argument theta of a complex number is its angle in radians from the real axis.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refentry id="gnumeric-IMCONJUGATE">
- <refmeta>
- <refentrytitle>
- <function>IMCONJUGATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCONJUGATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMARGUMENT</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The argument theta of a complex number is its angle in radians from the real axis.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCONJUGATE">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCONJUGATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCONJUGATE</function>
+ </refname>
+ <refpurpose>
the complex conjugate of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCONJUGATE</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>,
- <link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMCOS">
- <refmeta>
- <refentrytitle>
- <function>IMCOS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCOS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCONJUGATE</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>,
+ <link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCOS">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCOS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCOS</function>
+ </refname>
+ <refpurpose>
the cosine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCOS</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSIN"><function>IMSIN</function></link>,
- <link linkend="gnumeric-IMTAN"><function>IMTAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMCOSH">
- <refmeta>
- <refentrytitle>
- <function>IMCOSH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCOSH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCOS</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSIN"><function>IMSIN</function></link>,
+ <link linkend="gnumeric-IMTAN"><function>IMTAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCOSH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCOSH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCOSH</function>
+ </refname>
+ <refpurpose>
the hyperbolic cosine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCOSH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSINH"><function>IMSINH</function></link>,
- <link linkend="gnumeric-IMTANH"><function>IMTANH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMCOT">
- <refmeta>
- <refentrytitle>
- <function>IMCOT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCOT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCOSH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSINH"><function>IMSINH</function></link>,
+ <link linkend="gnumeric-IMTANH"><function>IMTANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCOT">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCOT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCOT</function>
+ </refname>
+ <refpurpose>
the cotangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCOT</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>cotz = cosz/sinz.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSEC"><function>IMSEC</function></link>,
- <link linkend="gnumeric-IMCSC"><function>IMCSC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMCOTH">
- <refmeta>
- <refentrytitle>
- <function>IMCOTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCOTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCOT</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>cotz = cosz/sinz.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSEC"><function>IMSEC</function></link>,
+ <link linkend="gnumeric-IMCSC"><function>IMCSC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCOTH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCOTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCOTH</function>
+ </refname>
+ <refpurpose>
the hyperbolic cotangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCOTH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSECH"><function>IMSECH</function></link>,
- <link linkend="gnumeric-IMCSCH"><function>IMCSCH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMCSC">
- <refmeta>
- <refentrytitle>
- <function>IMCSC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCSC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCOTH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSECH"><function>IMSECH</function></link>,
+ <link linkend="gnumeric-IMCSCH"><function>IMCSCH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCSC">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCSC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCSC</function>
+ </refname>
+ <refpurpose>
the cosecant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCSC</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>cscz = 1/sinz.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSEC"><function>IMSEC</function></link>,
- <link linkend="gnumeric-IMCOT"><function>IMCOT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMCSCH">
- <refmeta>
- <refentrytitle>
- <function>IMCSCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMCSCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCSC</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>cscz = 1/sinz.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSEC"><function>IMSEC</function></link>,
+ <link linkend="gnumeric-IMCOT"><function>IMCOT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMCSCH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMCSCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMCSCH</function>
+ </refname>
+ <refpurpose>
the hyperbolic cosecant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMCSCH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSECH"><function>IMSECH</function></link>,
- <link linkend="gnumeric-IMCOTH"><function>IMCOTH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMDIV">
- <refmeta>
- <refentrytitle>
- <function>IMDIV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMDIV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMCSCH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSECH"><function>IMSECH</function></link>,
+ <link linkend="gnumeric-IMCOTH"><function>IMCOTH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMDIV">
+ <refmeta>
+ <refentrytitle>
+ <function>IMDIV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMDIV</function>
+ </refname>
+ <refpurpose>
the quotient of two complex numbers <parameter>z1</parameter>/<parameter>z2</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMDIV</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z1</parameter>: a complex number</para>
- <para><parameter>z2</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z1</parameter> or <parameter>z2</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMPRODUCT"><function>IMPRODUCT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMEXP">
- <refmeta>
- <refentrytitle>
- <function>IMEXP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMEXP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMDIV</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z1</parameter>: a complex number</para>
+ <para><parameter>z2</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z1</parameter> or <parameter>z2</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMPRODUCT"><function>IMPRODUCT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMEXP">
+ <refmeta>
+ <refentrytitle>
+ <function>IMEXP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMEXP</function>
+ </refname>
+ <refpurpose>
the exponential of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMEXP</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMINV">
- <refmeta>
- <refentrytitle>
- <function>IMINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMEXP</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMINV">
+ <refmeta>
+ <refentrytitle>
+ <function>IMINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMINV</function>
+ </refname>
+ <refpurpose>
the reciprocal, or inverse, of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMINV</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refentry id="gnumeric-IMLN">
- <refmeta>
- <refentrytitle>
- <function>IMLN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMLN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMINV</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMLN">
+ <refmeta>
+ <refentrytitle>
+ <function>IMLN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMLN</function>
+ </refname>
+ <refpurpose>
the natural logarithm of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMLN</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The result will have an imaginary part between -Ï? and +Ï?.</para>
- <para>The natural logarithm is not uniquely defined on complex numbers. You may need to add or subtract an even multiple of Ï? to the imaginary part.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMEXP"><function>IMEXP</function></link>,
- <link linkend="gnumeric-IMLOG2"><function>IMLOG2</function></link>,
- <link linkend="gnumeric-IMLOG10"><function>IMLOG10</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMLOG10">
- <refmeta>
- <refentrytitle>
- <function>IMLOG10</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMLOG10</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMLN</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The result will have an imaginary part between -Ï? and +Ï?.</para>
+ <para>The natural logarithm is not uniquely defined on complex numbers. You may need to add or subtract an even multiple of Ï? to the imaginary part.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMEXP"><function>IMEXP</function></link>,
+ <link linkend="gnumeric-IMLOG2"><function>IMLOG2</function></link>,
+ <link linkend="gnumeric-IMLOG10"><function>IMLOG10</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMLOG10">
+ <refmeta>
+ <refentrytitle>
+ <function>IMLOG10</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMLOG10</function>
+ </refname>
+ <refpurpose>
the base-10 logarithm of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMLOG10</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>,
- <link linkend="gnumeric-IMLOG2"><function>IMLOG2</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMLOG2">
- <refmeta>
- <refentrytitle>
- <function>IMLOG2</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMLOG2</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMLOG10</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>,
+ <link linkend="gnumeric-IMLOG2"><function>IMLOG2</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMLOG2">
+ <refmeta>
+ <refentrytitle>
+ <function>IMLOG2</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMLOG2</function>
+ </refname>
+ <refpurpose>
the base-2 logarithm of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMLOG2</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>,
- <link linkend="gnumeric-IMLOG10"><function>IMLOG10</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMNEG">
- <refmeta>
- <refentrytitle>
- <function>IMNEG</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMNEG</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMLOG2</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>,
+ <link linkend="gnumeric-IMLOG10"><function>IMLOG10</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMNEG">
+ <refmeta>
+ <refentrytitle>
+ <function>IMNEG</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMNEG</function>
+ </refname>
+ <refpurpose>
the negative of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMNEG</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refentry id="gnumeric-IMPOWER">
- <refmeta>
- <refentrytitle>
- <function>IMPOWER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMPOWER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMNEG</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMPOWER">
+ <refmeta>
+ <refentrytitle>
+ <function>IMPOWER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMPOWER</function>
+ </refname>
+ <refpurpose>
the complex number <parameter>z1</parameter> raised to the <parameter>z2</parameter>th power
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMPOWER</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z1</parameter>: a complex number</para>
- <para><parameter>z2</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z1</parameter> or <parameter>z2</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSQRT"><function>IMSQRT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMPRODUCT">
- <refmeta>
- <refentrytitle>
- <function>IMPRODUCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMPRODUCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMPOWER</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z1</parameter>: a complex number</para>
+ <para><parameter>z2</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z1</parameter> or <parameter>z2</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSQRT"><function>IMSQRT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMPRODUCT">
+ <refmeta>
+ <refentrytitle>
+ <function>IMPRODUCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMPRODUCT</function>
+ </refname>
+ <refpurpose>
the product of the given complex numbers.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMPRODUCT</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z1</parameter>: a complex number</para>
- <para><parameter>z2</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If any of <parameter>z1</parameter>, <parameter>z2</parameter>,... is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMDIV"><function>IMDIV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMREAL">
- <refmeta>
- <refentrytitle>
- <function>IMREAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMREAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMPRODUCT</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z1</parameter>: a complex number</para>
+ <para><parameter>z2</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If any of <parameter>z1</parameter>, <parameter>z2</parameter>,... is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMDIV"><function>IMDIV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMREAL">
+ <refmeta>
+ <refentrytitle>
+ <function>IMREAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMREAL</function>
+ </refname>
+ <refpurpose>
the real part of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMREAL</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSEC">
- <refmeta>
- <refentrytitle>
- <function>IMSEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMREAL</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSEC">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSEC</function>
+ </refname>
+ <refpurpose>
the secant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSEC</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>secz = 1/cosz.</para>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMCSC"><function>IMCSC</function></link>,
- <link linkend="gnumeric-IMCOT"><function>IMCOT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSECH">
- <refmeta>
- <refentrytitle>
- <function>IMSECH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSECH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSEC</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>secz = 1/cosz.</para>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMCSC"><function>IMCSC</function></link>,
+ <link linkend="gnumeric-IMCOT"><function>IMCOT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSECH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSECH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSECH</function>
+ </refname>
+ <refpurpose>
the hyperbolic secant of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSECH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMCSCH"><function>IMCSCH</function></link>,
- <link linkend="gnumeric-IMCOTH"><function>IMCOTH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSIN">
- <refmeta>
- <refentrytitle>
- <function>IMSIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSECH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMCSCH"><function>IMCSCH</function></link>,
+ <link linkend="gnumeric-IMCOTH"><function>IMCOTH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSIN">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSIN</function>
+ </refname>
+ <refpurpose>
the sine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSIN</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMCOS"><function>IMCOS</function></link>,
- <link linkend="gnumeric-IMTAN"><function>IMTAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSINH">
- <refmeta>
- <refentrytitle>
- <function>IMSINH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSINH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSIN</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMCOS"><function>IMCOS</function></link>,
+ <link linkend="gnumeric-IMTAN"><function>IMTAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSINH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSINH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSINH</function>
+ </refname>
+ <refpurpose>
the hyperbolic sine of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSINH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMCOSH"><function>IMCOSH</function></link>,
- <link linkend="gnumeric-IMTANH"><function>IMTANH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSQRT">
- <refmeta>
- <refentrytitle>
- <function>IMSQRT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSQRT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSINH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMCOSH"><function>IMCOSH</function></link>,
+ <link linkend="gnumeric-IMTANH"><function>IMTANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSQRT">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSQRT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSQRT</function>
+ </refname>
+ <refpurpose>
the square root of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSQRT</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMPOWER"><function>IMPOWER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSUB">
- <refmeta>
- <refentrytitle>
- <function>IMSUB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSUB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSQRT</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMPOWER"><function>IMPOWER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSUB">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSUB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSUB</function>
+ </refname>
+ <refpurpose>
the difference of two complex numbers.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSUB</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z1</parameter>: a complex number</para>
- <para><parameter>z2</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z1</parameter> or <parameter>z2</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSUM"><function>IMSUM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMSUM">
- <refmeta>
- <refentrytitle>
- <function>IMSUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMSUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSUB</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z1</parameter>: a complex number</para>
+ <para><parameter>z2</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z1</parameter> or <parameter>z2</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSUM"><function>IMSUM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMSUM">
+ <refmeta>
+ <refentrytitle>
+ <function>IMSUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMSUM</function>
+ </refname>
+ <refpurpose>
the sum of the given complex numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMSUM</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z1</parameter>: a complex number</para>
- <para><parameter>z2</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If any of <parameter>z1</parameter>, <parameter>z2</parameter>,... is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSUB"><function>IMSUB</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMTAN">
- <refmeta>
- <refentrytitle>
- <function>IMTAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMTAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMSUM</function>(<parameter>z1</parameter>,<parameter>z2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z1</parameter>: a complex number</para>
+ <para><parameter>z2</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If any of <parameter>z1</parameter>, <parameter>z2</parameter>,... is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSUB"><function>IMSUB</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMTAN">
+ <refmeta>
+ <refentrytitle>
+ <function>IMTAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMTAN</function>
+ </refname>
+ <refpurpose>
the tangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMTAN</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSIN"><function>IMSIN</function></link>,
- <link linkend="gnumeric-IMCOS"><function>IMCOS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IMTANH">
- <refmeta>
- <refentrytitle>
- <function>IMTANH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IMTANH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMTAN</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSIN"><function>IMSIN</function></link>,
+ <link linkend="gnumeric-IMCOS"><function>IMCOS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IMTANH">
+ <refmeta>
+ <refentrytitle>
+ <function>IMTANH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IMTANH</function>
+ </refname>
+ <refpurpose>
the hyperbolic tangent of the complex number <parameter>z</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IMTANH</function>(<parameter>z</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>z</parameter>: a complex number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IMSINH"><function>IMSINH</function></link>,
- <link linkend="gnumeric-IMCOSH"><function>IMCOSH</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IMTANH</function>(<parameter>z</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>z</parameter>: a complex number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>z</parameter> is not a valid complex number, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IMSINH"><function>IMSINH</function></link>,
+ <link linkend="gnumeric-IMCOSH"><function>IMCOSH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Database">
<title>Database</title>
<refentry id="gnumeric-DAVERAGE">
@@ -1513,488 +1513,488 @@
<function>DAVERAGE</function>
</refname>
<refpurpose>
- average of the values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
- </refpurpose>
+ average of the values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DAVERAGE</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>DAVERAGE</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DCOUNT">
- <refmeta>
- <refentrytitle>
- <function>DCOUNT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DCOUNT</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-DCOUNT">
+ <refmeta>
+ <refentrytitle>
+ <function>DCOUNT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DCOUNT</function>
+ </refname>
+ <refpurpose>
count of numbers in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DCOUNT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DAVERAGE"><function>DAVERAGE</function></link>,
- <link linkend="gnumeric-DCOUNTA"><function>DCOUNTA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DCOUNTA">
- <refmeta>
- <refentrytitle>
- <function>DCOUNTA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DCOUNTA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DCOUNT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DAVERAGE"><function>DAVERAGE</function></link>,
+ <link linkend="gnumeric-DCOUNTA"><function>DCOUNTA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DCOUNTA">
+ <refmeta>
+ <refentrytitle>
+ <function>DCOUNTA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DCOUNTA</function>
+ </refname>
+ <refpurpose>
count of cells with data in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DCOUNTA</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DGET">
- <refmeta>
- <refentrytitle>
- <function>DGET</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DGET</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DCOUNTA</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DGET">
+ <refmeta>
+ <refentrytitle>
+ <function>DGET</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DGET</function>
+ </refname>
+ <refpurpose>
a value from <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DGET</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If none of the records match the conditions, <function>DGET</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If more than one record match the conditions, <function>DGET</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DMAX">
- <refmeta>
- <refentrytitle>
- <function>DMAX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DMAX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DGET</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If none of the records match the conditions, <function>DGET</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If more than one record match the conditions, <function>DGET</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DMAX">
+ <refmeta>
+ <refentrytitle>
+ <function>DMAX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DMAX</function>
+ </refname>
+ <refpurpose>
largest number in <parameter>field</parameter> in <parameter>database</parameter> belonging to a record that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DMAX</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DMIN"><function>DMIN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DMIN">
- <refmeta>
- <refentrytitle>
- <function>DMIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DMIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DMAX</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DMIN"><function>DMIN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DMIN">
+ <refmeta>
+ <refentrytitle>
+ <function>DMIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DMIN</function>
+ </refname>
+ <refpurpose>
smallest number in <parameter>field</parameter> in <parameter>database</parameter> belonging to a record that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DMIN</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DPRODUCT">
- <refmeta>
- <refentrytitle>
- <function>DPRODUCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DPRODUCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DMIN</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DPRODUCT">
+ <refmeta>
+ <refentrytitle>
+ <function>DPRODUCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DPRODUCT</function>
+ </refname>
+ <refpurpose>
product of all values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DPRODUCT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DSUM"><function>DSUM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DSTDEV">
- <refmeta>
- <refentrytitle>
- <function>DSTDEV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DSTDEV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DPRODUCT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DSUM"><function>DSUM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DSTDEV">
+ <refmeta>
+ <refentrytitle>
+ <function>DSTDEV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DSTDEV</function>
+ </refname>
+ <refpurpose>
sample standard deviation of the values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DSTDEV</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DSTDEVP"><function>DSTDEVP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DSTDEVP">
- <refmeta>
- <refentrytitle>
- <function>DSTDEVP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DSTDEVP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DSTDEV</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DSTDEVP"><function>DSTDEVP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DSTDEVP">
+ <refmeta>
+ <refentrytitle>
+ <function>DSTDEVP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DSTDEVP</function>
+ </refname>
+ <refpurpose>
standard deviation of the population of values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DSTDEVP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DSTDEV"><function>DSTDEV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DSUM">
- <refmeta>
- <refentrytitle>
- <function>DSUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DSUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DSTDEVP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DSTDEV"><function>DSTDEV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DSUM">
+ <refmeta>
+ <refentrytitle>
+ <function>DSUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DSUM</function>
+ </refname>
+ <refpurpose>
sum of the values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DSUM</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DPRODUCT"><function>DPRODUCT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DVAR">
- <refmeta>
- <refentrytitle>
- <function>DVAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DVAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DSUM</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DPRODUCT"><function>DPRODUCT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DVAR">
+ <refmeta>
+ <refentrytitle>
+ <function>DVAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DVAR</function>
+ </refname>
+ <refpurpose>
sample variance of the values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DVAR</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DVARP"><function>DVARP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DVARP">
- <refmeta>
- <refentrytitle>
- <function>DVARP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DVARP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DVAR</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DVARP"><function>DVARP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DVARP">
+ <refmeta>
+ <refentrytitle>
+ <function>DVARP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DVARP</function>
+ </refname>
+ <refpurpose>
variance of the population of values in <parameter>field</parameter> in <parameter>database</parameter> belonging to records that match <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DVARP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
- <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
- <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
- <para><parameter>criteria</parameter>: a range containing conditions</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DVAR"><function>DVAR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GETPIVOTDATA">
- <refmeta>
- <refentrytitle>
- <function>GETPIVOTDATA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GETPIVOTDATA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DVARP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>database</parameter> is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column.</para>
+ <para><parameter>database</parameter>: a range in which rows of related information are records and columns of data are fields</para>
+ <para><parameter>field</parameter>: a string or integer specifying which field is to be used</para>
+ <para><parameter>criteria</parameter>: a range containing conditions</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying which field is to be used. If <parameter>field</parameter> is an integer n then the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>criteria</parameter> is a range containing conditions. The first row of a <parameter>criteria</parameter> should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of <parameter>criteria</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DVAR"><function>DVAR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GETPIVOTDATA">
+ <refmeta>
+ <refentrytitle>
+ <function>GETPIVOTDATA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GETPIVOTDATA</function>
+ </refname>
+ <refpurpose>
summary data from a pivot table
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GETPIVOTDATA</function>(<parameter>pivot_table</parameter>,<parameter>field_name</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>pivot_table</parameter>: cell range containing the pivot table</para>
- <para><parameter>field_name</parameter>: name of the field for which the summary data is requested</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the summary data is unavailable, <function>GETPIVOTDATA</function> returns #REF!</para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GETPIVOTDATA</function>(<parameter>pivot_table</parameter>,<parameter>field_name</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>pivot_table</parameter>: cell range containing the pivot table</para>
+ <para><parameter>field_name</parameter>: name of the field for which the summary data is requested</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the summary data is unavailable, <function>GETPIVOTDATA</function> returns #REF!</para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_DateTime">
<title>Date/Time</title>
<refentry id="gnumeric-ASCENSIONTHURSDAY">
@@ -2008,1184 +2008,1184 @@
<function>ASCENSIONTHURSDAY</function>
</refname>
<refpurpose>
- Ascension Thursday in the Gregorian calendar according to the Roman rite of the Christian Church
- </refpurpose>
+ Ascension Thursday in the Gregorian calendar according to the Roman rite of the Christian Church
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASCENSIONTHURSDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Ascension Thursday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ASCENSIONTHURSDAY</function>(<parameter>year</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Ascension Thursday</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ASHWEDNESDAY">
- <refmeta>
- <refentrytitle>
- <function>ASHWEDNESDAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ASHWEDNESDAY</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-ASHWEDNESDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>ASHWEDNESDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ASHWEDNESDAY</function>
+ </refname>
+ <refpurpose>
Ash Wednesday in the Gregorian calendar according to the Roman rite of the Christian Church
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ASHWEDNESDAY</function>(<parameter>year</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Ash Wednesday</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DATE">
- <refmeta>
- <refentrytitle>
- <function>DATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASHWEDNESDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Ash Wednesday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DATE">
+ <refmeta>
+ <refentrytitle>
+ <function>DATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DATE</function>
+ </refname>
+ <refpurpose>
create a date serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DATE</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>DATE</function> function creates date serial values. 1-Jan-1900 is serial value 1, 2-Jan-1900 is serial value 2, and so on. For compatibility reasons, a serial value is reserved for the non-existing date 29-Feb-1900.</para>
- <para><parameter>year</parameter>: year of date</para>
- <para><parameter>month</parameter>: month of year</para>
- <para><parameter>day</parameter>: day of month</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>month</parameter> or <parameter>day</parameter> is less than 1 or too big, then the year and/or month will be adjusted.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>For spreadsheets created with the Mac version of Excel, serial 1 is 1-Jan-1904.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TODAY"><function>TODAY</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>,
- <link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
- <link linkend="gnumeric-DAY"><function>DAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DATE2UNIX">
- <refmeta>
- <refentrytitle>
- <function>DATE2UNIX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DATE2UNIX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DATE</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>DATE</function> function creates date serial values. 1-Jan-1900 is serial value 1, 2-Jan-1900 is serial value 2, and so on. For compatibility reasons, a serial value is reserved for the non-existing date 29-Feb-1900.</para>
+ <para><parameter>year</parameter>: year of date</para>
+ <para><parameter>month</parameter>: month of year</para>
+ <para><parameter>day</parameter>: day of month</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>month</parameter> or <parameter>day</parameter> is less than 1 or too big, then the year and/or month will be adjusted.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>For spreadsheets created with the Mac version of Excel, serial 1 is 1-Jan-1904.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TODAY"><function>TODAY</function></link>,
+ <link linkend="gnumeric-YEAR"><function>YEAR</function></link>,
+ <link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
+ <link linkend="gnumeric-DAY"><function>DAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DATE2UNIX">
+ <refmeta>
+ <refentrytitle>
+ <function>DATE2UNIX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DATE2UNIX</function>
+ </refname>
+ <refpurpose>
translate a date serial value to a Unix timestamp
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DATE2UNIX</function>(<parameter>d</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>DATE2UNIX</function> function translates a date serial values into a Unix timestamp.</para>
- <para><parameter>d</parameter>: date serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-UNIX2DATE"><function>UNIX2DATE</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DATEDIF">
- <refmeta>
- <refentrytitle>
- <function>DATEDIF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DATEDIF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DATE2UNIX</function>(<parameter>d</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>DATE2UNIX</function> function translates a date serial values into a Unix timestamp.</para>
+ <para><parameter>d</parameter>: date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-UNIX2DATE"><function>UNIX2DATE</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DATEDIF">
+ <refmeta>
+ <refentrytitle>
+ <function>DATEDIF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DATEDIF</function>
+ </refname>
+ <refpurpose>
difference between dates
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DATEDIF</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>interval</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DATEDIF</function> returns the distance from <parameter>start_date</parameter> to <parameter>end_date</parameter> according to the unit specified by <parameter>interval</parameter>.</para>
- <para><parameter>start_date</parameter>: starting date serial value</para>
- <para><parameter>end_date</parameter>: ending date serial value</para>
- <para><parameter>interval</parameter>: counting unit</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>interval</parameter> is "y", "m", or "d" then the distance is measured in complete years, months, or days respectively.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>interval</parameter> is "ym" or "yd" then the distance is measured in complete months or days, respectively, but excluding any difference in years.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>interval</parameter> is "md" then the distance is measured in complete days but excluding any difference in months.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DAYS360"><function>DAYS360</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DATEVALUE">
- <refmeta>
- <refentrytitle>
- <function>DATEVALUE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DATEVALUE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DATEDIF</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>interval</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DATEDIF</function> returns the distance from <parameter>start_date</parameter> to <parameter>end_date</parameter> according to the unit specified by <parameter>interval</parameter>.</para>
+ <para><parameter>start_date</parameter>: starting date serial value</para>
+ <para><parameter>end_date</parameter>: ending date serial value</para>
+ <para><parameter>interval</parameter>: counting unit</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>interval</parameter> is "y", "m", or "d" then the distance is measured in complete years, months, or days respectively.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>interval</parameter> is "ym" or "yd" then the distance is measured in complete months or days, respectively, but excluding any difference in years.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>interval</parameter> is "md" then the distance is measured in complete days but excluding any difference in months.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DAYS360"><function>DAYS360</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DATEVALUE">
+ <refmeta>
+ <refentrytitle>
+ <function>DATEVALUE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DATEVALUE</function>
+ </refname>
+ <refpurpose>
the date part of a date and time serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DATEVALUE</function>(<parameter>serial</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DATEVALUE</function> returns the date serial value part of a date and time serial value.</para>
- <para><parameter>serial</parameter>: date and time serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TIMEVALUE"><function>TIMEVALUE</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DAY">
- <refmeta>
- <refentrytitle>
- <function>DAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DATEVALUE</function>(<parameter>serial</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DATEVALUE</function> returns the date serial value part of a date and time serial value.</para>
+ <para><parameter>serial</parameter>: date and time serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TIMEVALUE"><function>TIMEVALUE</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DAY">
+ <refmeta>
+ <refentrytitle>
+ <function>DAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DAY</function>
+ </refname>
+ <refpurpose>
the day-of-month part of a date serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DAY</function>(<parameter>date</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>DAY</function> function returns the day-of-month part of <parameter>date</parameter>.</para>
- <para><parameter>date</parameter>: date serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>,
- <link linkend="gnumeric-MONTH"><function>MONTH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DAYS">
- <refmeta>
- <refentrytitle>
- <function>DAYS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DAYS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DAY</function>(<parameter>date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>DAY</function> function returns the day-of-month part of <parameter>date</parameter>.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
+ <link linkend="gnumeric-YEAR"><function>YEAR</function></link>,
+ <link linkend="gnumeric-MONTH"><function>MONTH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DAYS">
+ <refmeta>
+ <refentrytitle>
+ <function>DAYS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DAYS</function>
+ </refname>
+ <refpurpose>
difference between dates in days
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DAYS</function> returns the positive or negative number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter>.</para>
- <para><parameter>start_date</parameter>: starting date serial value</para>
- <para><parameter>end_date</parameter>: ending date serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DAYS360">
- <refmeta>
- <refentrytitle>
- <function>DAYS360</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DAYS360</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DAYS</function> returns the positive or negative number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter>.</para>
+ <para><parameter>start_date</parameter>: starting date serial value</para>
+ <para><parameter>end_date</parameter>: ending date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DAYS360">
+ <refmeta>
+ <refentrytitle>
+ <function>DAYS360</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DAYS360</function>
+ </refname>
+ <refpurpose>
days between dates
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DAYS360</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>method</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DAYS360</function> returns the number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter>.</para>
- <para><parameter>start_date</parameter>: starting date serial value</para>
- <para><parameter>end_date</parameter>: ending date serial value</para>
- <para><parameter>method</parameter>: counting method</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 0, the default, the MS Excel (tm) US method will be used. This is a somewhat complicated industry standard method where the last day of February is considered to be the 30th day of the month, but only for <parameter>start_date</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 1, the European method will be used. In this case, if the day of the month is 31 it will be considered as 30</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 2, a saner version of the US method is used in which both dates get the same February treatment.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EASTERSUNDAY">
- <refmeta>
- <refentrytitle>
- <function>EASTERSUNDAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EASTERSUNDAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DAYS360</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>method</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DAYS360</function> returns the number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter>.</para>
+ <para><parameter>start_date</parameter>: starting date serial value</para>
+ <para><parameter>end_date</parameter>: ending date serial value</para>
+ <para><parameter>method</parameter>: counting method</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 0, the default, the MS Excel (tm) US method will be used. This is a somewhat complicated industry standard method where the last day of February is considered to be the 30th day of the month, but only for <parameter>start_date</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 1, the European method will be used. In this case, if the day of the month is 31 it will be considered as 30</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 2, a saner version of the US method is used in which both dates get the same February treatment.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EASTERSUNDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>EASTERSUNDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EASTERSUNDAY</function>
+ </refname>
+ <refpurpose>
Easter Sunday in the Gregorian calendar according to the Roman rite of the Christian Church
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EASTERSUNDAY</function>(<parameter>year</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Easter Sunday</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ASHWEDNESDAY"><function>ASHWEDNESDAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EDATE">
- <refmeta>
- <refentrytitle>
- <function>EDATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EDATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EASTERSUNDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Easter Sunday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ASHWEDNESDAY"><function>ASHWEDNESDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EDATE">
+ <refmeta>
+ <refentrytitle>
+ <function>EDATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EDATE</function>
+ </refname>
+ <refpurpose>
adjust a date by a number of months
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EDATE</function>(<parameter>date</parameter>,<parameter>months</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EDATE</function> returns <parameter>date</parameter> moved forward or backward the number of months specified by <parameter>months</parameter>.</para>
- <para><parameter>date</parameter>: date serial value</para>
- <para><parameter>months</parameter>: signed number of months</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EOMONTH">
- <refmeta>
- <refentrytitle>
- <function>EOMONTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EOMONTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EDATE</function>(<parameter>date</parameter>,<parameter>months</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>EDATE</function> returns <parameter>date</parameter> moved forward or backward the number of months specified by <parameter>months</parameter>.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ <para><parameter>months</parameter>: signed number of months</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EOMONTH">
+ <refmeta>
+ <refentrytitle>
+ <function>EOMONTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EOMONTH</function>
+ </refname>
+ <refpurpose>
end of month
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EOMONTH</function>(<parameter>date</parameter>,<parameter>months</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EOMONTH</function> returns the date serial value of the end of the month specified by <parameter>date</parameter> adjusted forward or backward the number of months specified by <parameter>months</parameter>.</para>
- <para><parameter>date</parameter>: date serial value</para>
- <para><parameter>months</parameter>: signed number of months</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EDATE"><function>EDATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GOODFRIDAY">
- <refmeta>
- <refentrytitle>
- <function>GOODFRIDAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GOODFRIDAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EOMONTH</function>(<parameter>date</parameter>,<parameter>months</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>EOMONTH</function> returns the date serial value of the end of the month specified by <parameter>date</parameter> adjusted forward or backward the number of months specified by <parameter>months</parameter>.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ <para><parameter>months</parameter>: signed number of months</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EDATE"><function>EDATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GOODFRIDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>GOODFRIDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GOODFRIDAY</function>
+ </refname>
+ <refpurpose>
Good Friday in the Gregorian calendar according to the Roman rite of the Christian Church
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GOODFRIDAY</function>(<parameter>year</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Good Friday</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HDATE">
- <refmeta>
- <refentrytitle>
- <function>HDATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HDATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GOODFRIDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Good Friday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE</function>
+ </refname>
+ <refpurpose>
Hebrew date
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HDATE_HEB"><function>HDATE_HEB</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HDATE</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year of date</para>
- <para><parameter>month</parameter>: month of year</para>
- <para><parameter>day</parameter>: day of month</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HDATE_DAY">
- <refmeta>
- <refentrytitle>
- <function>HDATE_DAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HDATE_DAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_HEB"><function>HDATE_HEB</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HDATE</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year of date</para>
+ <para><parameter>month</parameter>: month of year</para>
+ <para><parameter>day</parameter>: day of month</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_DAY">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_DAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_DAY</function>
+ </refname>
+ <refpurpose>
Hebrew day of Gregorian date
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HDATE_DAY</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: Gregorian year of date</para>
- <para><parameter>month</parameter>: Gregorian month of year</para>
- <para><parameter>day</parameter>: Gregorian day of month</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HDATE_HEB">
- <refmeta>
- <refentrytitle>
- <function>HDATE_HEB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HDATE_HEB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HDATE_DAY</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: Gregorian year of date</para>
+ <para><parameter>month</parameter>: Gregorian month of year</para>
+ <para><parameter>day</parameter>: Gregorian day of month</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_HEB">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_HEB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_HEB</function>
+ </refname>
+ <refpurpose>
Hebrew date in Hebrew
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HDATE"><function>HDATE</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HDATE_HEB</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year of date</para>
- <para><parameter>month</parameter>: month of year</para>
- <para><parameter>day</parameter>: day of month</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HDATE_JULIAN">
- <refmeta>
- <refentrytitle>
- <function>HDATE_JULIAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HDATE_JULIAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE"><function>HDATE</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HDATE_HEB</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year of date</para>
+ <para><parameter>month</parameter>: month of year</para>
+ <para><parameter>day</parameter>: day of month</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_JULIAN">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_JULIAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_JULIAN</function>
+ </refname>
+ <refpurpose>
Julian day number for given Gregorian date
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HDATE"><function>HDATE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HDATE_JULIAN</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: Gregorian year of date</para>
- <para><parameter>month</parameter>: Gregorian month of year</para>
- <para><parameter>day</parameter>: Gregorian day of month</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HDATE_MONTH">
- <refmeta>
- <refentrytitle>
- <function>HDATE_MONTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HDATE_MONTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE"><function>HDATE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HDATE_JULIAN</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: Gregorian year of date</para>
+ <para><parameter>month</parameter>: Gregorian month of year</para>
+ <para><parameter>day</parameter>: Gregorian day of month</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_MONTH">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_MONTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_MONTH</function>
+ </refname>
+ <refpurpose>
Hebrew month of Gregorian date
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HDATE_MONTH</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: Gregorian year of date</para>
- <para><parameter>month</parameter>: Gregorian month of year</para>
- <para><parameter>day</parameter>: Gregorian day of month</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HDATE_YEAR">
- <refmeta>
- <refentrytitle>
- <function>HDATE_YEAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HDATE_YEAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HDATE_MONTH</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: Gregorian year of date</para>
+ <para><parameter>month</parameter>: Gregorian month of year</para>
+ <para><parameter>day</parameter>: Gregorian day of month</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_YEAR">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_YEAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_YEAR</function>
+ </refname>
+ <refpurpose>
Hebrew year of Gregorian date
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HDATE_YEAR</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: Gregorian year of date</para>
- <para><parameter>month</parameter>: Gregorian month of year</para>
- <para><parameter>day</parameter>: Gregorian day of month</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HOUR">
- <refmeta>
- <refentrytitle>
- <function>HOUR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HOUR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HDATE_YEAR</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: Gregorian year of date</para>
+ <para><parameter>month</parameter>: Gregorian month of year</para>
+ <para><parameter>day</parameter>: Gregorian day of month</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HOUR">
+ <refmeta>
+ <refentrytitle>
+ <function>HOUR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HOUR</function>
+ </refname>
+ <refpurpose>
compute hour part of fractional day
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HOUR</function>(<parameter>time</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>HOUR</function> function computes the hour part of the fractional day given by <parameter>time</parameter>.</para>
- <para><parameter>time</parameter>: time of day as fractional day.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>,
- <link linkend="gnumeric-SECOND"><function>SECOND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ISOWEEKNUM">
- <refmeta>
- <refentrytitle>
- <function>ISOWEEKNUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISOWEEKNUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HOUR</function>(<parameter>time</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>HOUR</function> function computes the hour part of the fractional day given by <parameter>time</parameter>.</para>
+ <para><parameter>time</parameter>: time of day as fractional day.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TIME"><function>TIME</function></link>,
+ <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>,
+ <link linkend="gnumeric-SECOND"><function>SECOND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISOWEEKNUM">
+ <refmeta>
+ <refentrytitle>
+ <function>ISOWEEKNUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISOWEEKNUM</function>
+ </refname>
+ <refpurpose>
ISO week number
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISOWEEKNUM</function>(<parameter>date</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISOWEEKNUM</function> calculates the week number according to the ISO 8601 standard. Weeks start on Mondays and week 1 contains the first Thursday of the year.</para>
- <para><parameter>date</parameter>: date serial value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>January 1 of a year is sometimes in week 52 or 53 of the previous year. Similarly, December 31 is sometimes in week 1 of the following year.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISOYEAR"><function>ISOYEAR</function></link>,
- <link linkend="gnumeric-WEEKNUM"><function>WEEKNUM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ISOYEAR">
- <refmeta>
- <refentrytitle>
- <function>ISOYEAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISOYEAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISOWEEKNUM</function>(<parameter>date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ISOWEEKNUM</function> calculates the week number according to the ISO 8601 standard. Weeks start on Mondays and week 1 contains the first Thursday of the year.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>January 1 of a year is sometimes in week 52 or 53 of the previous year. Similarly, December 31 is sometimes in week 1 of the following year.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISOYEAR"><function>ISOYEAR</function></link>,
+ <link linkend="gnumeric-WEEKNUM"><function>WEEKNUM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISOYEAR">
+ <refmeta>
+ <refentrytitle>
+ <function>ISOYEAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISOYEAR</function>
+ </refname>
+ <refpurpose>
year corresponding to the ISO week number
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISOYEAR</function>(<parameter>date</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISOYEAR</function> calculates the year to go with week number according to the ISE 8601 standard.</para>
- <para><parameter>date</parameter>: date serial value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>January 1 of a year is sometimes in week 52 or 53 of the previous year. Similarly, December 31 is sometimes in week 1 of the following year.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MINUTE">
- <refmeta>
- <refentrytitle>
- <function>MINUTE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MINUTE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISOYEAR</function>(<parameter>date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ISOYEAR</function> calculates the year to go with week number according to the ISE 8601 standard.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>January 1 of a year is sometimes in week 52 or 53 of the previous year. Similarly, December 31 is sometimes in week 1 of the following year.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>,
+ <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MINUTE">
+ <refmeta>
+ <refentrytitle>
+ <function>MINUTE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MINUTE</function>
+ </refname>
+ <refpurpose>
compute minute part of fractional day
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MINUTE</function>(<parameter>time</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>MINUTE</function> function computes the minute part of the fractional day given by <parameter>time</parameter>.</para>
- <para><parameter>time</parameter>: time of day as fractional day.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-HOUR"><function>HOUR</function></link>,
- <link linkend="gnumeric-SECOND"><function>SECOND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MONTH">
- <refmeta>
- <refentrytitle>
- <function>MONTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MONTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MINUTE</function>(<parameter>time</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>MINUTE</function> function computes the minute part of the fractional day given by <parameter>time</parameter>.</para>
+ <para><parameter>time</parameter>: time of day as fractional day.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TIME"><function>TIME</function></link>,
+ <link linkend="gnumeric-HOUR"><function>HOUR</function></link>,
+ <link linkend="gnumeric-SECOND"><function>SECOND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MONTH">
+ <refmeta>
+ <refentrytitle>
+ <function>MONTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MONTH</function>
+ </refname>
+ <refpurpose>
the month part of a date serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MONTH</function>(<parameter>date</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>MONTH</function> function returns the month part of <parameter>date</parameter>.</para>
- <para><parameter>date</parameter>: date serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>,
- <link linkend="gnumeric-DAY"><function>DAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NETWORKDAYS">
- <refmeta>
- <refentrytitle>
- <function>NETWORKDAYS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NETWORKDAYS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MONTH</function>(<parameter>date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>MONTH</function> function returns the month part of <parameter>date</parameter>.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
+ <link linkend="gnumeric-YEAR"><function>YEAR</function></link>,
+ <link linkend="gnumeric-DAY"><function>DAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NETWORKDAYS">
+ <refmeta>
+ <refentrytitle>
+ <function>NETWORKDAYS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NETWORKDAYS</function>
+ </refname>
+ <refpurpose>
number of workdays in range
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NETWORKDAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>holidays</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NETWORKDAYS</function> calculates the number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter> skipping weekends and <parameter>holidays</parameter> in the process.</para>
- <para><parameter>start_date</parameter>: starting date serial value</para>
- <para><parameter>end_date</parameter>: ending date serial value</para>
- <para><parameter>holidays</parameter>: array of holidays</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-WORKDAY"><function>WORKDAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NOW">
- <refmeta>
- <refentrytitle>
- <function>NOW</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NOW</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NETWORKDAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>holidays</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NETWORKDAYS</function> calculates the number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter> skipping weekends and <parameter>holidays</parameter> in the process.</para>
+ <para><parameter>start_date</parameter>: starting date serial value</para>
+ <para><parameter>end_date</parameter>: ending date serial value</para>
+ <para><parameter>holidays</parameter>: array of holidays</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-WORKDAY"><function>WORKDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NOW">
+ <refmeta>
+ <refentrytitle>
+ <function>NOW</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NOW</function>
+ </refname>
+ <refpurpose>
the date and time serial value of the current time
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NOW</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>NOW</function> function returns the date and time serial value of the moment it is computed. Recomputing later will produce a different value.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PENTECOSTSUNDAY">
- <refmeta>
- <refentrytitle>
- <function>PENTECOSTSUNDAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PENTECOSTSUNDAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NOW</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>NOW</function> function returns the date and time serial value of the moment it is computed. Recomputing later will produce a different value.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PENTECOSTSUNDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>PENTECOSTSUNDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PENTECOSTSUNDAY</function>
+ </refname>
+ <refpurpose>
Pentecost Sunday in the Gregorian calendar according to the Roman rite of the Christian Church
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PENTECOSTSUNDAY</function>(<parameter>year</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Pentecost Sunday</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SECOND">
- <refmeta>
- <refentrytitle>
- <function>SECOND</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SECOND</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PENTECOSTSUNDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Pentecost Sunday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SECOND">
+ <refmeta>
+ <refentrytitle>
+ <function>SECOND</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SECOND</function>
+ </refname>
+ <refpurpose>
compute seconds part of fractional day
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SECOND</function>(<parameter>time</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>SECOND</function> function computes the seconds part of the fractional day given by <parameter>time</parameter>.</para>
- <para><parameter>time</parameter>: time of day as fractional day.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-HOUR"><function>HOUR</function></link>,
- <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TIME">
- <refmeta>
- <refentrytitle>
- <function>TIME</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TIME</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SECOND</function>(<parameter>time</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>SECOND</function> function computes the seconds part of the fractional day given by <parameter>time</parameter>.</para>
+ <para><parameter>time</parameter>: time of day as fractional day.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TIME"><function>TIME</function></link>,
+ <link linkend="gnumeric-HOUR"><function>HOUR</function></link>,
+ <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TIME">
+ <refmeta>
+ <refentrytitle>
+ <function>TIME</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TIME</function>
+ </refname>
+ <refpurpose>
create a time serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TIME</function>(<parameter>hour</parameter>,<parameter>minute</parameter>,<parameter>second</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>TIME</function> function computes the fractional day between midnight at the time given by <parameter>hour</parameter>, <parameter>minute</parameter>, and <parameter>second</parameter>.</para>
- <para><parameter>hour</parameter>: hour of the day</para>
- <para><parameter>minute</parameter>: minute within the hour</para>
- <para><parameter>second</parameter>: second within the minute</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HOUR"><function>HOUR</function></link>,
- <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>,
- <link linkend="gnumeric-SECOND"><function>SECOND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TIMEVALUE">
- <refmeta>
- <refentrytitle>
- <function>TIMEVALUE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TIMEVALUE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TIME</function>(<parameter>hour</parameter>,<parameter>minute</parameter>,<parameter>second</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>TIME</function> function computes the fractional day between midnight at the time given by <parameter>hour</parameter>, <parameter>minute</parameter>, and <parameter>second</parameter>.</para>
+ <para><parameter>hour</parameter>: hour of the day</para>
+ <para><parameter>minute</parameter>: minute within the hour</para>
+ <para><parameter>second</parameter>: second within the minute</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HOUR"><function>HOUR</function></link>,
+ <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>,
+ <link linkend="gnumeric-SECOND"><function>SECOND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TIMEVALUE">
+ <refmeta>
+ <refentrytitle>
+ <function>TIMEVALUE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TIMEVALUE</function>
+ </refname>
+ <refpurpose>
the time part of a date and time serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TIMEVALUE</function>(<parameter>serial</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TIMEVALUE</function> returns the time-of-day part of a date and time serial value.</para>
- <para><parameter>serial</parameter>: date and time serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATEVALUE"><function>DATEVALUE</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TODAY">
- <refmeta>
- <refentrytitle>
- <function>TODAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TODAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TIMEVALUE</function>(<parameter>serial</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>TIMEVALUE</function> returns the time-of-day part of a date and time serial value.</para>
+ <para><parameter>serial</parameter>: date and time serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATEVALUE"><function>DATEVALUE</function></link>,
+ <link linkend="gnumeric-TIME"><function>TIME</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TODAY">
+ <refmeta>
+ <refentrytitle>
+ <function>TODAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TODAY</function>
+ </refname>
+ <refpurpose>
the date serial value of today
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TODAY</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>TODAY</function> function returns the date serial value of the day it is computed. Recomputing on a later date will produce a different value.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-UNIX2DATE">
- <refmeta>
- <refentrytitle>
- <function>UNIX2DATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>UNIX2DATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TODAY</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>TODAY</function> function returns the date serial value of the day it is computed. Recomputing on a later date will produce a different value.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-UNIX2DATE">
+ <refmeta>
+ <refentrytitle>
+ <function>UNIX2DATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>UNIX2DATE</function>
+ </refname>
+ <refpurpose>
create a date value from a Unix timestamp
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>UNIX2DATE</function>(<parameter>t</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The UNIT2DATE function translates Unix timestamps into date serial values. Unix timestamps are number of seconds since Midnight 1-Jan-1900.</para>
- <para><parameter>t</parameter>: Unix time stamp</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE2UNIX"><function>DATE2UNIX</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-WEEKDAY">
- <refmeta>
- <refentrytitle>
- <function>WEEKDAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>WEEKDAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>UNIX2DATE</function>(<parameter>t</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The UNIT2DATE function translates Unix timestamps into date serial values. Unix timestamps are number of seconds since Midnight 1-Jan-1900.</para>
+ <para><parameter>t</parameter>: Unix time stamp</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE2UNIX"><function>DATE2UNIX</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-WEEKDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>WEEKDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>WEEKDAY</function>
+ </refname>
+ <refpurpose>
day-of-week
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>WEEKDAY</function>(<parameter>date</parameter>,<parameter>method</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>WEEKDAY</function> function returns the day-of-week of <parameter>date</parameter>. The value of <parameter>method</parameter> determines how days are numbered.</para>
- <para><parameter>date</parameter>: date serial value</para>
- <para><parameter>method</parameter>: numbering system</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 1, then Sunday is 1, Monday is 2, etc.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 2, then Monday is 1, Sunday is 2, etc.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 3, then Monday is 0, Sunday is 1, etc.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
- <link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-WEEKNUM">
- <refmeta>
- <refentrytitle>
- <function>WEEKNUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>WEEKNUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>WEEKDAY</function>(<parameter>date</parameter>,<parameter>method</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>WEEKDAY</function> function returns the day-of-week of <parameter>date</parameter>. The value of <parameter>method</parameter> determines how days are numbered.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ <para><parameter>method</parameter>: numbering system</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 1, then Sunday is 1, Monday is 2, etc.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 2, then Monday is 1, Sunday is 2, etc.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 3, then Monday is 0, Sunday is 1, etc.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
+ <link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-WEEKNUM">
+ <refmeta>
+ <refentrytitle>
+ <function>WEEKNUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>WEEKNUM</function>
+ </refname>
+ <refpurpose>
ISO week number
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>WEEKNUM</function>(<parameter>date</parameter>,<parameter>method</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>WEEKNUM</function> calculates the week number according to <parameter>method</parameter> which defaults to 1.</para>
- <para><parameter>date</parameter>: date serial value</para>
- <para><parameter>method</parameter>: numbering system</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 1, then weeks start on Sundays and days before first Sunday are in week 0.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 2, then weeks start on Mondays and days before first Monday are in week 0.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>method</parameter> is 150, then the ISO 8601 numbering is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-WORKDAY">
- <refmeta>
- <refentrytitle>
- <function>WORKDAY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>WORKDAY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>WEEKNUM</function>(<parameter>date</parameter>,<parameter>method</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>WEEKNUM</function> calculates the week number according to <parameter>method</parameter> which defaults to 1.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ <para><parameter>method</parameter>: numbering system</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 1, then weeks start on Sundays and days before first Sunday are in week 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 2, then weeks start on Mondays and days before first Monday are in week 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>method</parameter> is 150, then the ISO 8601 numbering is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-WORKDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>WORKDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>WORKDAY</function>
+ </refname>
+ <refpurpose>
add working days
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>WORKDAY</function>(<parameter>date</parameter>,<parameter>days</parameter>,<parameter>holidays</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>WORKDAY</function> adjusts <parameter>date</parameter> by <parameter>days</parameter> skipping over weekends and <parameter>holidays</parameter> in the process.</para>
- <para><parameter>date</parameter>: date serial value</para>
- <para><parameter>days</parameter>: number of days to add</para>
- <para><parameter>holidays</parameter>: array of holidays</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>days</parameter> may be negative.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NETWORKDAYS"><function>NETWORKDAYS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-YEAR">
- <refmeta>
- <refentrytitle>
- <function>YEAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>YEAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>WORKDAY</function>(<parameter>date</parameter>,<parameter>days</parameter>,<parameter>holidays</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>WORKDAY</function> adjusts <parameter>date</parameter> by <parameter>days</parameter> skipping over weekends and <parameter>holidays</parameter> in the process.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ <para><parameter>days</parameter>: number of days to add</para>
+ <para><parameter>holidays</parameter>: array of holidays</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>days</parameter> may be negative.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NETWORKDAYS"><function>NETWORKDAYS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-YEAR">
+ <refmeta>
+ <refentrytitle>
+ <function>YEAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>YEAR</function>
+ </refname>
+ <refpurpose>
the year part of a date serial value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>YEAR</function>(<parameter>date</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The <function>YEAR</function> function returns the year part of <parameter>date</parameter>.</para>
- <para><parameter>date</parameter>: date serial value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
- <link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
- <link linkend="gnumeric-DAY"><function>DAY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-YEARFRAC">
- <refmeta>
- <refentrytitle>
- <function>YEARFRAC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>YEARFRAC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>YEAR</function>(<parameter>date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The <function>YEAR</function> function returns the year part of <parameter>date</parameter>.</para>
+ <para><parameter>date</parameter>: date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
+ <link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
+ <link linkend="gnumeric-DAY"><function>DAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-YEARFRAC">
+ <refmeta>
+ <refentrytitle>
+ <function>YEARFRAC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>YEARFRAC</function>
+ </refname>
+ <refpurpose>
fractional number of years between dates
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>YEARFRAC</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>YEARFRAC</function> calculates the number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter> according to the calendar specified by <parameter>basis</parameter>, which defaults to 0, and expresses the result as a fractional number of years.</para>
- <para><parameter>start_date</parameter>: starting date serial value</para>
- <para><parameter>end_date</parameter>: ending date serial value</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>YEARFRAC</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>YEARFRAC</function> calculates the number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter> according to the calendar specified by <parameter>basis</parameter>, which defaults to 0, and expresses the result as a fractional number of years.</para>
+ <para><parameter>start_date</parameter>: starting date serial value</para>
+ <para><parameter>end_date</parameter>: ending date serial value</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Engineering">
<title>Engineering</title>
<refentry id="gnumeric-BASE">
@@ -3199,840 +3199,840 @@
<function>BASE</function>
</refname>
<refpurpose>
- string of digits representing the number <parameter>n</parameter> in base <parameter>b</parameter>
- </refpurpose>
+ string of digits representing the number <parameter>n</parameter> in base <parameter>b</parameter>
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BASE</function>(<parameter>n</parameter>,<parameter>b</parameter>,<parameter>length</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BASE</function> converts <parameter>n</parameter> to its string representation in base <parameter>b</parameter>. Leading zeroes will be added to reach the minimum length given by <parameter>length</parameter>.</para>
+ <para><parameter>n</parameter>: integer</para>
+ <para><parameter>b</parameter>: base (2 â?¤ <parameter>b</parameter> â?¤ 36)</para>
+ <para><parameter>length</parameter>: minimum length of the resulting string</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DECIMAL"><function>DECIMAL</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>BASE</function>(<parameter>n</parameter>,<parameter>b</parameter>,<parameter>length</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BASE</function> converts <parameter>n</parameter> to its string representation in base <parameter>b</parameter>. Leading zeroes will be added to reach the minimum length given by <parameter>length</parameter>.</para>
- <para><parameter>n</parameter>: integer</para>
- <para><parameter>b</parameter>: base (2 â?¤ <parameter>b</parameter> â?¤ 36)</para>
- <para><parameter>length</parameter>: minimum length of the resulting string</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DECIMAL"><function>DECIMAL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BESSELI">
- <refmeta>
- <refentrytitle>
- <function>BESSELI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BESSELI</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-BESSELI">
+ <refmeta>
+ <refentrytitle>
+ <function>BESSELI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BESSELI</function>
+ </refname>
+ <refpurpose>
Modified Bessel function of the first kind of order @{α} at <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BESSELI</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>X</parameter>: number</para>
- <para>@{α}: order (any number)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
- <link linkend="gnumeric-BESSELK"><function>BESSELK</function></link>,
- <link linkend="gnumeric-BESSELY"><function>BESSELY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BESSELJ">
- <refmeta>
- <refentrytitle>
- <function>BESSELJ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BESSELJ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BESSELI</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>X</parameter>: number</para>
+ <para>@{α}: order (any number)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
+ <link linkend="gnumeric-BESSELK"><function>BESSELK</function></link>,
+ <link linkend="gnumeric-BESSELY"><function>BESSELY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BESSELJ">
+ <refmeta>
+ <refentrytitle>
+ <function>BESSELJ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BESSELJ</function>
+ </refname>
+ <refpurpose>
Bessel function of the first kind of order @{α} at <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BESSELJ</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>X</parameter>: number</para>
- <para>@{α}: order (any non-negative integer)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. If @{α} is not an integer, it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
- <link linkend="gnumeric-BESSELK"><function>BESSELK</function></link>,
- <link linkend="gnumeric-BESSELY"><function>BESSELY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BESSELK">
- <refmeta>
- <refentrytitle>
- <function>BESSELK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BESSELK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BESSELJ</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>X</parameter>: number</para>
+ <para>@{α}: order (any non-negative integer)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. If @{α} is not an integer, it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
+ <link linkend="gnumeric-BESSELK"><function>BESSELK</function></link>,
+ <link linkend="gnumeric-BESSELY"><function>BESSELY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BESSELK">
+ <refmeta>
+ <refentrytitle>
+ <function>BESSELK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BESSELK</function>
+ </refname>
+ <refpurpose>
Modified Bessel function of the second kind of order @{α} at <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BESSELK</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>X</parameter>: number</para>
- <para>@{α}: order (any number)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
- <link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
- <link linkend="gnumeric-BESSELY"><function>BESSELY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BESSELY">
- <refmeta>
- <refentrytitle>
- <function>BESSELY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BESSELY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BESSELK</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>X</parameter>: number</para>
+ <para>@{α}: order (any number)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
+ <link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
+ <link linkend="gnumeric-BESSELY"><function>BESSELY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BESSELY">
+ <refmeta>
+ <refentrytitle>
+ <function>BESSELY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BESSELY</function>
+ </refname>
+ <refpurpose>
Bessel function of the second kind of order @{α} at <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BESSELY</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>X</parameter>: number</para>
- <para>@{α}: order (any non-negative integer)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. If @{α} is not an integer, it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
- <link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
- <link linkend="gnumeric-BESSELK"><function>BESSELK</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BIN2DEC">
- <refmeta>
- <refentrytitle>
- <function>BIN2DEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BIN2DEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BESSELY</function>(<parameter>X</parameter>,<parameter/>α)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>X</parameter>: number</para>
+ <para>@{α}: order (any non-negative integer)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. If @{α} is not an integer, it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
+ <link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
+ <link linkend="gnumeric-BESSELK"><function>BESSELK</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BIN2DEC">
+ <refmeta>
+ <refentrytitle>
+ <function>BIN2DEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BIN2DEC</function>
+ </refname>
+ <refpurpose>
decimal representation of the binary number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
- <link linkend="gnumeric-BIN2OCT"><function>BIN2OCT</function></link>,
- <link linkend="gnumeric-BIN2HEX"><function>BIN2HEX</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>BIN2DEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: a binary number, either as a string or as a number involving only the digits 0 and 1</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-BIN2HEX">
- <refmeta>
- <refentrytitle>
- <function>BIN2HEX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BIN2HEX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
+ <link linkend="gnumeric-BIN2OCT"><function>BIN2OCT</function></link>,
+ <link linkend="gnumeric-BIN2HEX"><function>BIN2HEX</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>BIN2DEC</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: a binary number, either as a string or as a number involving only the digits 0 and 1</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BIN2HEX">
+ <refmeta>
+ <refentrytitle>
+ <function>BIN2HEX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BIN2HEX</function>
+ </refname>
+ <refpurpose>
hexadecimal representation of the binary number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BIN2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>BIN2HEX</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>BIN2HEX</function> returns #NUM!</para>
- <para><parameter>x</parameter>: a binary number, either as a string or as a number involving only the digits 0 and 1</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HEX2BIN"><function>HEX2BIN</function></link>,
- <link linkend="gnumeric-BIN2OCT"><function>BIN2OCT</function></link>,
- <link linkend="gnumeric-BIN2DEC"><function>BIN2DEC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BIN2OCT">
- <refmeta>
- <refentrytitle>
- <function>BIN2OCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BIN2OCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BIN2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>BIN2HEX</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>BIN2HEX</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: a binary number, either as a string or as a number involving only the digits 0 and 1</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HEX2BIN"><function>HEX2BIN</function></link>,
+ <link linkend="gnumeric-BIN2OCT"><function>BIN2OCT</function></link>,
+ <link linkend="gnumeric-BIN2DEC"><function>BIN2DEC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BIN2OCT">
+ <refmeta>
+ <refentrytitle>
+ <function>BIN2OCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BIN2OCT</function>
+ </refname>
+ <refpurpose>
octal representation of the binary number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BIN2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>BIN2OCT</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>BIN2OCT</function> returns #NUM!</para>
- <para><parameter>x</parameter>: a binary number, either as a string or as a number involving only the digits 0 and 1</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OCT2BIN"><function>OCT2BIN</function></link>,
- <link linkend="gnumeric-BIN2DEC"><function>BIN2DEC</function></link>,
- <link linkend="gnumeric-BIN2HEX"><function>BIN2HEX</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CONVERT">
- <refmeta>
- <refentrytitle>
- <function>CONVERT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CONVERT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BIN2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>BIN2OCT</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>BIN2OCT</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: a binary number, either as a string or as a number involving only the digits 0 and 1</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OCT2BIN"><function>OCT2BIN</function></link>,
+ <link linkend="gnumeric-BIN2DEC"><function>BIN2DEC</function></link>,
+ <link linkend="gnumeric-BIN2HEX"><function>BIN2HEX</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CONVERT">
+ <refmeta>
+ <refentrytitle>
+ <function>CONVERT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CONVERT</function>
+ </refname>
+ <refpurpose>
a converted measurement
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CONVERT</function>(<parameter>x</parameter>,<parameter>from</parameter>,<parameter>to</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CONVERT</function> returns a conversion from one measurement system to another. <parameter>x</parameter> is a value in <parameter>from</parameter> units that is to be converted into <parameter>to</parameter> units.</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>from</parameter>: unit (string)</para>
- <para><parameter>to</parameter>: unit (string)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>from</parameter> and <parameter>to</parameter> are different types, <function>CONVERT</function> returns #N/A!</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>from</parameter> and <parameter>to</parameter> can be any of the following:</para>
- <para/>
- <para>Weight and mass:</para>
- <para> 'g' Gram</para>
- <para> 'sg' Slug</para>
- <para> 'lbm' Pound</para>
- <para> 'u' U (atomic mass)</para>
- <para> 'ozm' Ounce</para>
- <para/>
- <para>Distance:</para>
- <para> 'm' Meter</para>
- <para> 'mi' Statute mile</para>
- <para> 'Nmi' Nautical mile</para>
- <para> 'in' Inch</para>
- <para> 'ft' Foot</para>
- <para> 'yd' Yard</para>
- <para> 'ang' Angstrom</para>
- <para> 'Pica' Pica</para>
- <para/>
- <para>Time:</para>
- <para> 'yr' Year</para>
- <para> 'day' Day</para>
- <para> 'hr' Hour</para>
- <para> 'mn' Minute</para>
- <para> 'sec' Second</para>
- <para/>
- <para>Pressure:</para>
- <para> 'Pa' Pascal</para>
- <para> 'atm' Atmosphere</para>
- <para> 'mmHg' mm of Mercury</para>
- <para/>
- <para>Force:</para>
- <para> 'N' Newton</para>
- <para> 'dyn' Dyne</para>
- <para> 'lbf' Pound force</para>
- <para/>
- <para>Energy:</para>
- <para> 'J' Joule</para>
- <para> 'e' Erg</para>
- <para> 'c' Thermodynamic calorie</para>
- <para> 'cal' IT calorie</para>
- <para> 'eV' Electron volt</para>
- <para> 'HPh' Horsepower-hour</para>
- <para> 'Wh' Watt-hour</para>
- <para> 'flb' Foot-pound</para>
- <para> 'BTU' BTU</para>
- <para/>
- <para>Power:</para>
- <para> 'HP' Horsepower</para>
- <para> 'W' Watt</para>
- <para/>
- <para>Magnetism:</para>
- <para> 'T' Tesla</para>
- <para> 'ga' Gauss</para>
- <para/>
- <para>Temperature:</para>
- <para> 'C' Degree Celsius</para>
- <para> 'F' Degree Fahrenheit</para>
- <para> 'K' Degree Kelvin</para>
- <para/>
- <para>Liquid measure:</para>
- <para> 'tsp' Teaspoon</para>
- <para> 'tbs' Tablespoon</para>
- <para> 'oz' Fluid ounce</para>
- <para> 'cup' Cup</para>
- <para> 'pt' Pint</para>
- <para> 'qt' Quart</para>
- <para> 'gal' Gallon</para>
- <para> 'l' Liter</para>
- <para/>
- <para>For metric units any of the following prefixes can be used:</para>
- <para> 'Y' yotta 1E+24</para>
- <para> 'Z' zetta 1E+21</para>
- <para> 'E' exa 1E+18</para>
- <para> 'P' peta 1E+15</para>
- <para> 'T' tera 1E+12</para>
- <para> 'G' giga 1E+09</para>
- <para> 'M' mega 1E+06</para>
- <para> 'k' kilo 1E+03</para>
- <para> 'h' hecto 1E+02</para>
- <para> 'e' deca (deka) 1E+01</para>
- <para> 'd' deci 1E-01</para>
- <para> 'c' centi 1E-02</para>
- <para> 'm' milli 1E-03</para>
- <para> 'u' micro 1E-06</para>
- <para> 'n' nano 1E-09</para>
- <para> 'p' pico 1E-12</para>
- <para> 'f' femto 1E-15</para>
- <para> 'a' atto 1E-18</para>
- <para> 'z' zepto 1E-21</para>
- <para> 'y' yocto 1E-24</para>
- </refsect1>
- <refentry id="gnumeric-DEC2BIN">
- <refmeta>
- <refentrytitle>
- <function>DEC2BIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DEC2BIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CONVERT</function>(<parameter>x</parameter>,<parameter>from</parameter>,<parameter>to</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CONVERT</function> returns a conversion from one measurement system to another. <parameter>x</parameter> is a value in <parameter>from</parameter> units that is to be converted into <parameter>to</parameter> units.</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>from</parameter>: unit (string)</para>
+ <para><parameter>to</parameter>: unit (string)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>from</parameter> and <parameter>to</parameter> are different types, <function>CONVERT</function> returns #N/A!</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>from</parameter> and <parameter>to</parameter> can be any of the following:</para>
+ <para/>
+ <para>Weight and mass:</para>
+ <para> 'g' Gram</para>
+ <para> 'sg' Slug</para>
+ <para> 'lbm' Pound</para>
+ <para> 'u' U (atomic mass)</para>
+ <para> 'ozm' Ounce</para>
+ <para/>
+ <para>Distance:</para>
+ <para> 'm' Meter</para>
+ <para> 'mi' Statute mile</para>
+ <para> 'Nmi' Nautical mile</para>
+ <para> 'in' Inch</para>
+ <para> 'ft' Foot</para>
+ <para> 'yd' Yard</para>
+ <para> 'ang' Angstrom</para>
+ <para> 'Pica' Pica</para>
+ <para/>
+ <para>Time:</para>
+ <para> 'yr' Year</para>
+ <para> 'day' Day</para>
+ <para> 'hr' Hour</para>
+ <para> 'mn' Minute</para>
+ <para> 'sec' Second</para>
+ <para/>
+ <para>Pressure:</para>
+ <para> 'Pa' Pascal</para>
+ <para> 'atm' Atmosphere</para>
+ <para> 'mmHg' mm of Mercury</para>
+ <para/>
+ <para>Force:</para>
+ <para> 'N' Newton</para>
+ <para> 'dyn' Dyne</para>
+ <para> 'lbf' Pound force</para>
+ <para/>
+ <para>Energy:</para>
+ <para> 'J' Joule</para>
+ <para> 'e' Erg</para>
+ <para> 'c' Thermodynamic calorie</para>
+ <para> 'cal' IT calorie</para>
+ <para> 'eV' Electron volt</para>
+ <para> 'HPh' Horsepower-hour</para>
+ <para> 'Wh' Watt-hour</para>
+ <para> 'flb' Foot-pound</para>
+ <para> 'BTU' BTU</para>
+ <para/>
+ <para>Power:</para>
+ <para> 'HP' Horsepower</para>
+ <para> 'W' Watt</para>
+ <para/>
+ <para>Magnetism:</para>
+ <para> 'T' Tesla</para>
+ <para> 'ga' Gauss</para>
+ <para/>
+ <para>Temperature:</para>
+ <para> 'C' Degree Celsius</para>
+ <para> 'F' Degree Fahrenheit</para>
+ <para> 'K' Degree Kelvin</para>
+ <para/>
+ <para>Liquid measure:</para>
+ <para> 'tsp' Teaspoon</para>
+ <para> 'tbs' Tablespoon</para>
+ <para> 'oz' Fluid ounce</para>
+ <para> 'cup' Cup</para>
+ <para> 'pt' Pint</para>
+ <para> 'qt' Quart</para>
+ <para> 'gal' Gallon</para>
+ <para> 'l' Liter</para>
+ <para/>
+ <para>For metric units any of the following prefixes can be used:</para>
+ <para> 'Y' yotta 1E+24</para>
+ <para> 'Z' zetta 1E+21</para>
+ <para> 'E' exa 1E+18</para>
+ <para> 'P' peta 1E+15</para>
+ <para> 'T' tera 1E+12</para>
+ <para> 'G' giga 1E+09</para>
+ <para> 'M' mega 1E+06</para>
+ <para> 'k' kilo 1E+03</para>
+ <para> 'h' hecto 1E+02</para>
+ <para> 'e' deca (deka) 1E+01</para>
+ <para> 'd' deci 1E-01</para>
+ <para> 'c' centi 1E-02</para>
+ <para> 'm' milli 1E-03</para>
+ <para> 'u' micro 1E-06</para>
+ <para> 'n' nano 1E-09</para>
+ <para> 'p' pico 1E-12</para>
+ <para> 'f' femto 1E-15</para>
+ <para> 'a' atto 1E-18</para>
+ <para> 'z' zepto 1E-21</para>
+ <para> 'y' yocto 1E-24</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DEC2BIN">
+ <refmeta>
+ <refentrytitle>
+ <function>DEC2BIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DEC2BIN</function>
+ </refname>
+ <refpurpose>
binary representation of the decimal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DEC2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>DEC2BIN</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>DEC2BIN</function> returns #NUM!</para>
- <para><parameter>x</parameter>: integer</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BIN2DEC"><function>BIN2DEC</function></link>,
- <link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>,
- <link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DEC2HEX">
- <refmeta>
- <refentrytitle>
- <function>DEC2HEX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DEC2HEX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DEC2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>DEC2BIN</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>DEC2BIN</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: integer</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BIN2DEC"><function>BIN2DEC</function></link>,
+ <link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>,
+ <link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DEC2HEX">
+ <refmeta>
+ <refentrytitle>
+ <function>DEC2HEX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DEC2HEX</function>
+ </refname>
+ <refpurpose>
hexadecimal representation of the decimal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DEC2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>DEC2HEX</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>DEC2HEX</function> returns #NUM!</para>
- <para><parameter>x</parameter>: integer</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HEX2DEC"><function>HEX2DEC</function></link>,
- <link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
- <link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DEC2OCT">
- <refmeta>
- <refentrytitle>
- <function>DEC2OCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DEC2OCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DEC2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>DEC2HEX</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>DEC2HEX</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: integer</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HEX2DEC"><function>HEX2DEC</function></link>,
+ <link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
+ <link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DEC2OCT">
+ <refmeta>
+ <refentrytitle>
+ <function>DEC2OCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DEC2OCT</function>
+ </refname>
+ <refpurpose>
octal representation of the decimal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DEC2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>DEC2OCT</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>DEC2OCT</function> returns #NUM!</para>
- <para><parameter>x</parameter>: integer</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OCT2DEC"><function>OCT2DEC</function></link>,
- <link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
- <link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DECIMAL">
- <refmeta>
- <refentrytitle>
- <function>DECIMAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DECIMAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DEC2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>DEC2OCT</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>DEC2OCT</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: integer</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OCT2DEC"><function>OCT2DEC</function></link>,
+ <link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
+ <link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DECIMAL">
+ <refmeta>
+ <refentrytitle>
+ <function>DECIMAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DECIMAL</function>
+ </refname>
+ <refpurpose>
decimal representation of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BASE"><function>BASE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>DECIMAL</function>(<parameter>x</parameter>,<parameter>base</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number in base <parameter>base</parameter></para>
- <para><parameter>base</parameter>: base of <parameter>x</parameter>, (2 â?¤ <parameter>b</parameter> â?¤ 36)</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-DELTA">
- <refmeta>
- <refentrytitle>
- <function>DELTA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DELTA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BASE"><function>BASE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>DECIMAL</function>(<parameter>x</parameter>,<parameter>base</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number in base <parameter>base</parameter></para>
+ <para><parameter>base</parameter>: base of <parameter>x</parameter>, (2 â?¤ <parameter>b</parameter> â?¤ 36)</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DELTA">
+ <refmeta>
+ <refentrytitle>
+ <function>DELTA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DELTA</function>
+ </refname>
+ <refpurpose>
Kronecker delta function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DELTA</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DELTA</function> returns 1 if <parameter>x1</parameter> = <parameter>x0</parameter> and 0 otherwise.</para>
- <para><parameter>x0</parameter>: number</para>
- <para><parameter>x1</parameter>: number, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If either argument is non-numeric, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXACT"><function>EXACT</function></link>,
- <link linkend="gnumeric-GESTEP"><function>GESTEP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ERF">
- <refmeta>
- <refentrytitle>
- <function>ERF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ERF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DELTA</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DELTA</function> returns 1 if <parameter>x1</parameter> = <parameter>x0</parameter> and 0 otherwise.</para>
+ <para><parameter>x0</parameter>: number</para>
+ <para><parameter>x1</parameter>: number, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If either argument is non-numeric, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXACT"><function>EXACT</function></link>,
+ <link linkend="gnumeric-GESTEP"><function>GESTEP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ERF">
+ <refmeta>
+ <refentrytitle>
+ <function>ERF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ERF</function>
+ </refname>
+ <refpurpose>
Gauss error function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ERF</function>(<parameter>lower</parameter>,<parameter>upper</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ERF</function> returns 2/sqrt(Ï?)* integral from <parameter>lower</parameter> to <parameter>upper</parameter> of exp(-t*t) dt</para>
- <para><parameter>lower</parameter>: lower limit of the integral, defaults to 0</para>
- <para><parameter>upper</parameter>: upper limit of the integral</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ERFC"><function>ERFC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ERFC">
- <refmeta>
- <refentrytitle>
- <function>ERFC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ERFC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ERF</function>(<parameter>lower</parameter>,<parameter>upper</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ERF</function> returns 2/sqrt(Ï?)* integral from <parameter>lower</parameter> to <parameter>upper</parameter> of exp(-t*t) dt</para>
+ <para><parameter>lower</parameter>: lower limit of the integral, defaults to 0</para>
+ <para><parameter>upper</parameter>: upper limit of the integral</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ERFC"><function>ERFC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ERFC">
+ <refmeta>
+ <refentrytitle>
+ <function>ERFC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ERFC</function>
+ </refname>
+ <refpurpose>
Complementary Gauss error function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ERFC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ERFC</function> returns 2/sqrt(Ï?)* integral from <parameter>x</parameter> to â?? of exp(-t*t) dt</para>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ERF"><function>ERF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GESTEP">
- <refmeta>
- <refentrytitle>
- <function>GESTEP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GESTEP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ERFC</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ERFC</function> returns 2/sqrt(Ï?)* integral from <parameter>x</parameter> to â?? of exp(-t*t) dt</para>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ERF"><function>ERF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GESTEP">
+ <refmeta>
+ <refentrytitle>
+ <function>GESTEP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GESTEP</function>
+ </refname>
+ <refpurpose>
Step function with step at <parameter>x1</parameter> evaluated at <parameter>x0</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GESTEP</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GESTEP</function> returns 1 if <parameter>x1</parameter> â?¤ <parameter>x0</parameter> and 0 otherwise.</para>
- <para><parameter>x0</parameter>: number</para>
- <para><parameter>x1</parameter>: number, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If either argument is non-numeric, #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DELTA"><function>DELTA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HEX2BIN">
- <refmeta>
- <refentrytitle>
- <function>HEX2BIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HEX2BIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GESTEP</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>GESTEP</function> returns 1 if <parameter>x1</parameter> â?¤ <parameter>x0</parameter> and 0 otherwise.</para>
+ <para><parameter>x0</parameter>: number</para>
+ <para><parameter>x1</parameter>: number, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If either argument is non-numeric, #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DELTA"><function>DELTA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HEX2BIN">
+ <refmeta>
+ <refentrytitle>
+ <function>HEX2BIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HEX2BIN</function>
+ </refname>
+ <refpurpose>
binary representation of the hexadecimalal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HEX2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>HEX2BIN</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>HEX2BIN</function> returns #NUM!</para>
- <para><parameter>x</parameter>: a hexadecimal number, either as a string or as a number if no A to F are needed</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BIN2HEX"><function>BIN2HEX</function></link>,
- <link linkend="gnumeric-HEX2OCT"><function>HEX2OCT</function></link>,
- <link linkend="gnumeric-HEX2DEC"><function>HEX2DEC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HEX2DEC">
- <refmeta>
- <refentrytitle>
- <function>HEX2DEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HEX2DEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HEX2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>HEX2BIN</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>HEX2BIN</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: a hexadecimal number, either as a string or as a number if no A to F are needed</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BIN2HEX"><function>BIN2HEX</function></link>,
+ <link linkend="gnumeric-HEX2OCT"><function>HEX2OCT</function></link>,
+ <link linkend="gnumeric-HEX2DEC"><function>HEX2DEC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HEX2DEC">
+ <refmeta>
+ <refentrytitle>
+ <function>HEX2DEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HEX2DEC</function>
+ </refname>
+ <refpurpose>
decimal representation of the hexadecimal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>,
- <link linkend="gnumeric-HEX2BIN"><function>HEX2BIN</function></link>,
- <link linkend="gnumeric-HEX2OCT"><function>HEX2OCT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HEX2DEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: a hexadecimal number, either as a string or as a number if no A to F are needed</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HEX2OCT">
- <refmeta>
- <refentrytitle>
- <function>HEX2OCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HEX2OCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>,
+ <link linkend="gnumeric-HEX2BIN"><function>HEX2BIN</function></link>,
+ <link linkend="gnumeric-HEX2OCT"><function>HEX2OCT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HEX2DEC</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: a hexadecimal number, either as a string or as a number if no A to F are needed</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HEX2OCT">
+ <refmeta>
+ <refentrytitle>
+ <function>HEX2OCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HEX2OCT</function>
+ </refname>
+ <refpurpose>
octal representation of the hexadecimal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HEX2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>HEX2OCT</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>HEX2OCT</function> returns #NUM!</para>
- <para><parameter>x</parameter>: a hexadecimal number, either as a string or as a number if no A to F are needed</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OCT2HEX"><function>OCT2HEX</function></link>,
- <link linkend="gnumeric-HEX2BIN"><function>HEX2BIN</function></link>,
- <link linkend="gnumeric-HEX2DEC"><function>HEX2DEC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-INVSUMINV">
- <refmeta>
- <refentrytitle>
- <function>INVSUMINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INVSUMINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HEX2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>HEX2OCT</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>HEX2OCT</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: a hexadecimal number, either as a string or as a number if no A to F are needed</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OCT2HEX"><function>OCT2HEX</function></link>,
+ <link linkend="gnumeric-HEX2BIN"><function>HEX2BIN</function></link>,
+ <link linkend="gnumeric-HEX2DEC"><function>HEX2DEC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INVSUMINV">
+ <refmeta>
+ <refentrytitle>
+ <function>INVSUMINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INVSUMINV</function>
+ </refname>
+ <refpurpose>
the reciprocal of the sum of reciprocals of the arguments
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INVSUMINV</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x0</parameter>: non-negative number</para>
- <para><parameter>x1</parameter>: non-negative number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If any of the arguments is negative, #VALUE! is returned.</para>
- <para>If any argument is zero, the result is zero.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><function>INVSUMINV</function> sum calculates the reciprocal (the inverse) of the sum of reciprocals (inverses) of all its arguments.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HARMEAN"><function>HARMEAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OCT2BIN">
- <refmeta>
- <refentrytitle>
- <function>OCT2BIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OCT2BIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INVSUMINV</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x0</parameter>: non-negative number</para>
+ <para><parameter>x1</parameter>: non-negative number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If any of the arguments is negative, #VALUE! is returned.</para>
+ <para>If any argument is zero, the result is zero.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><function>INVSUMINV</function> sum calculates the reciprocal (the inverse) of the sum of reciprocals (inverses) of all its arguments.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HARMEAN"><function>HARMEAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OCT2BIN">
+ <refmeta>
+ <refentrytitle>
+ <function>OCT2BIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OCT2BIN</function>
+ </refname>
+ <refpurpose>
binary representation of the octal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OCT2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>OCT2BIN</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>OCT2BIN</function> returns #NUM!</para>
- <para><parameter>x</parameter>: a octal number, either as a string or as a number</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BIN2OCT"><function>BIN2OCT</function></link>,
- <link linkend="gnumeric-OCT2DEC"><function>OCT2DEC</function></link>,
- <link linkend="gnumeric-OCT2HEX"><function>OCT2HEX</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OCT2DEC">
- <refmeta>
- <refentrytitle>
- <function>OCT2DEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OCT2DEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OCT2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>OCT2BIN</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>OCT2BIN</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: a octal number, either as a string or as a number</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BIN2OCT"><function>BIN2OCT</function></link>,
+ <link linkend="gnumeric-OCT2DEC"><function>OCT2DEC</function></link>,
+ <link linkend="gnumeric-OCT2HEX"><function>OCT2HEX</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OCT2DEC">
+ <refmeta>
+ <refentrytitle>
+ <function>OCT2DEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OCT2DEC</function>
+ </refname>
+ <refpurpose>
decimal representation of the octal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>,
- <link linkend="gnumeric-OCT2BIN"><function>OCT2BIN</function></link>,
- <link linkend="gnumeric-OCT2HEX"><function>OCT2HEX</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OCT2DEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: a octal number, either as a string or as a number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OCT2HEX">
- <refmeta>
- <refentrytitle>
- <function>OCT2HEX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OCT2HEX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>,
+ <link linkend="gnumeric-OCT2BIN"><function>OCT2BIN</function></link>,
+ <link linkend="gnumeric-OCT2HEX"><function>OCT2HEX</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OCT2DEC</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: a octal number, either as a string or as a number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OCT2HEX">
+ <refmeta>
+ <refentrytitle>
+ <function>OCT2HEX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OCT2HEX</function>
+ </refname>
+ <refpurpose>
hexadecimal representation of the octal number <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OCT2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>places</parameter> is given, <function>OCT2HEX</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>OCT2HEX</function> returns #NUM!</para>
- <para><parameter>x</parameter>: a octal number, either as a string or as a number</para>
- <para><parameter>places</parameter>: number of digits</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HEX2OCT"><function>HEX2OCT</function></link>,
- <link linkend="gnumeric-OCT2BIN"><function>OCT2BIN</function></link>,
- <link linkend="gnumeric-OCT2DEC"><function>OCT2DEC</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OCT2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>places</parameter> is given, <function>OCT2HEX</function> pads the result with zeros to achieve exactly <parameter>places</parameter> digits. If this is not possible, <function>OCT2HEX</function> returns #NUM!</para>
+ <para><parameter>x</parameter>: a octal number, either as a string or as a number</para>
+ <para><parameter>places</parameter>: number of digits</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HEX2OCT"><function>HEX2OCT</function></link>,
+ <link linkend="gnumeric-OCT2BIN"><function>OCT2BIN</function></link>,
+ <link linkend="gnumeric-OCT2DEC"><function>OCT2DEC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Erlang">
<title>Erlang</title>
<refentry id="gnumeric-DIMCIRC">
@@ -4046,128 +4046,128 @@
<function>DIMCIRC</function>
</refname>
<refpurpose>
- number of circuits required
- </refpurpose>
+ number of circuits required
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DIMCIRC</function>(<parameter>traffic</parameter>,<parameter>gos</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DIMCIRC</function> returns the number of circuits required given <parameter>traffic</parameter> calls with grade of service <parameter>gos</parameter>.</para>
+ <para><parameter>traffic</parameter>: number of calls</para>
+ <para><parameter>gos</parameter>: grade of service</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OFFCAP"><function>OFFCAP</function></link>,
+ <link linkend="gnumeric-OFFTRAF"><function>OFFTRAF</function></link>,
+ <link linkend="gnumeric-PROBBLOCK"><function>PROBBLOCK</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>DIMCIRC</function>(<parameter>traffic</parameter>,<parameter>gos</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DIMCIRC</function> returns the number of circuits required given <parameter>traffic</parameter> calls with grade of service <parameter>gos</parameter>.</para>
- <para><parameter>traffic</parameter>: number of calls</para>
- <para><parameter>gos</parameter>: grade of service</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OFFCAP"><function>OFFCAP</function></link>,
- <link linkend="gnumeric-OFFTRAF"><function>OFFTRAF</function></link>,
- <link linkend="gnumeric-PROBBLOCK"><function>PROBBLOCK</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OFFCAP">
- <refmeta>
- <refentrytitle>
- <function>OFFCAP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OFFCAP</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-OFFCAP">
+ <refmeta>
+ <refentrytitle>
+ <function>OFFCAP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OFFCAP</function>
+ </refname>
+ <refpurpose>
traffic capacity
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OFFCAP</function>(<parameter>circuits</parameter>,<parameter>gos</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OFFCAP</function> returns the traffic capacity given <parameter>circuits</parameter> circuits with grade of service <parameter>gos</parameter>.</para>
- <para><parameter>circuits</parameter>: number of circuits</para>
- <para><parameter>gos</parameter>: grade of service</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DIMCIRC"><function>DIMCIRC</function></link>,
- <link linkend="gnumeric-OFFTRAF"><function>OFFTRAF</function></link>,
- <link linkend="gnumeric-PROBBLOCK"><function>PROBBLOCK</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OFFTRAF">
- <refmeta>
- <refentrytitle>
- <function>OFFTRAF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OFFTRAF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OFFCAP</function>(<parameter>circuits</parameter>,<parameter>gos</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OFFCAP</function> returns the traffic capacity given <parameter>circuits</parameter> circuits with grade of service <parameter>gos</parameter>.</para>
+ <para><parameter>circuits</parameter>: number of circuits</para>
+ <para><parameter>gos</parameter>: grade of service</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DIMCIRC"><function>DIMCIRC</function></link>,
+ <link linkend="gnumeric-OFFTRAF"><function>OFFTRAF</function></link>,
+ <link linkend="gnumeric-PROBBLOCK"><function>PROBBLOCK</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OFFTRAF">
+ <refmeta>
+ <refentrytitle>
+ <function>OFFTRAF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OFFTRAF</function>
+ </refname>
+ <refpurpose>
predicted number of offered calls
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OFFTRAF</function>(<parameter>traffic</parameter>,<parameter>circuits</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OFFTRAF</function> returns the predicted number of offered calls given <parameter>traffic</parameter> carried calls (taken from measurements) on <parameter>circuits</parameter> circuits.</para>
- <para><parameter>traffic</parameter>: number of carried calls</para>
- <para><parameter>circuits</parameter>: number of circuits</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>traffic</parameter> cannot exceed <parameter>circuits</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PROBBLOCK"><function>PROBBLOCK</function></link>,
- <link linkend="gnumeric-DIMCIRC"><function>DIMCIRC</function></link>,
- <link linkend="gnumeric-OFFCAP"><function>OFFCAP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PROBBLOCK">
- <refmeta>
- <refentrytitle>
- <function>PROBBLOCK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PROBBLOCK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OFFTRAF</function>(<parameter>traffic</parameter>,<parameter>circuits</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OFFTRAF</function> returns the predicted number of offered calls given <parameter>traffic</parameter> carried calls (taken from measurements) on <parameter>circuits</parameter> circuits.</para>
+ <para><parameter>traffic</parameter>: number of carried calls</para>
+ <para><parameter>circuits</parameter>: number of circuits</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>traffic</parameter> cannot exceed <parameter>circuits</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PROBBLOCK"><function>PROBBLOCK</function></link>,
+ <link linkend="gnumeric-DIMCIRC"><function>DIMCIRC</function></link>,
+ <link linkend="gnumeric-OFFCAP"><function>OFFCAP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PROBBLOCK">
+ <refmeta>
+ <refentrytitle>
+ <function>PROBBLOCK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PROBBLOCK</function>
+ </refname>
+ <refpurpose>
probability of blocking
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PROBBLOCK</function>(<parameter>traffic</parameter>,<parameter>circuits</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PROBBLOCK</function> returns probability of blocking when <parameter>traffic</parameter> calls load into <parameter>circuits</parameter> circuits.</para>
- <para><parameter>traffic</parameter>: number of calls</para>
- <para><parameter>circuits</parameter>: number of circuits</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>traffic</parameter> cannot exceed <parameter>circuits</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OFFTRAF"><function>OFFTRAF</function></link>,
- <link linkend="gnumeric-DIMCIRC"><function>DIMCIRC</function></link>,
- <link linkend="gnumeric-OFFCAP"><function>OFFCAP</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PROBBLOCK</function>(<parameter>traffic</parameter>,<parameter>circuits</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PROBBLOCK</function> returns probability of blocking when <parameter>traffic</parameter> calls load into <parameter>circuits</parameter> circuits.</para>
+ <para><parameter>traffic</parameter>: number of calls</para>
+ <para><parameter>circuits</parameter>: number of circuits</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>traffic</parameter> cannot exceed <parameter>circuits</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OFFTRAF"><function>OFFTRAF</function></link>,
+ <link linkend="gnumeric-DIMCIRC"><function>DIMCIRC</function></link>,
+ <link linkend="gnumeric-OFFCAP"><function>OFFCAP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Finance">
<title>Finance</title>
<refentry id="gnumeric-ACCRINT">
@@ -4181,3696 +4181,3696 @@
<function>ACCRINT</function>
</refname>
<refpurpose>
- accrued interest
- </refpurpose>
+ accrued interest
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ACCRINT</function>(<parameter>issue</parameter>,<parameter>first_interest</parameter>,<parameter>settlement</parameter>,<parameter>rate</parameter>,<parameter>par</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ACCRINT</function> calculates the accrued interest for a security that pays periodic interest.</para>
+ <para><parameter>issue</parameter>: date of issue</para>
+ <para><parameter>first_interest</parameter>: date of first interest payment</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>par</parameter>: par value</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ACCRINTM"><function>ACCRINTM</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ACCRINT</function>(<parameter>issue</parameter>,<parameter>first_interest</parameter>,<parameter>settlement</parameter>,<parameter>rate</parameter>,<parameter>par</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ACCRINT</function> calculates the accrued interest for a security that pays periodic interest.</para>
- <para><parameter>issue</parameter>: date of issue</para>
- <para><parameter>first_interest</parameter>: date of first interest payment</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>par</parameter>: par value</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ACCRINTM"><function>ACCRINTM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ACCRINTM">
- <refmeta>
- <refentrytitle>
- <function>ACCRINTM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ACCRINTM</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-ACCRINTM">
+ <refmeta>
+ <refentrytitle>
+ <function>ACCRINTM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ACCRINTM</function>
+ </refname>
+ <refpurpose>
accrued interest
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ACCRINTM</function>(<parameter>issue</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>par</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>ACCRINT calculates the accrued interest from <parameter>issue</parameter> to <parameter>maturity</parameter>.</para>
- <para><parameter>issue</parameter>: date of issue</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>par</parameter>: par value</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>par</parameter> defaults to $1000.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ACCRINT"><function>ACCRINT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-AMORDEGRC">
- <refmeta>
- <refentrytitle>
- <function>AMORDEGRC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AMORDEGRC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ACCRINTM</function>(<parameter>issue</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>par</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>ACCRINT calculates the accrued interest from <parameter>issue</parameter> to <parameter>maturity</parameter>.</para>
+ <para><parameter>issue</parameter>: date of issue</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>par</parameter>: par value</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>par</parameter> defaults to $1000.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ACCRINT"><function>ACCRINT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-AMORDEGRC">
+ <refmeta>
+ <refentrytitle>
+ <function>AMORDEGRC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AMORDEGRC</function>
+ </refname>
+ <refpurpose>
depreciation of an asset using French accounting conventions
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>AMORDEGRC</function>(<parameter>cost</parameter>,<parameter>purchase_date</parameter>,<parameter>first_period</parameter>,<parameter>salvage</parameter>,<parameter>period</parameter>,<parameter>rate</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>AMORDEGRC</function> calculates the depreciation of an asset using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account. This is similar to AMORLINC, except that a depreciation coefficient is applied in the calculation depending on the life of the assets.</para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>purchase_date</parameter>: date of purchase</para>
- <para><parameter>first_period</parameter>: end of first period</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>period</parameter>: subject period</para>
- <para><parameter>rate</parameter>: depreciation rate</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Named for AMORtissement DEGRessif Comptabilite.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AMORLINC"><function>AMORLINC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-AMORLINC">
- <refmeta>
- <refentrytitle>
- <function>AMORLINC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AMORLINC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>AMORDEGRC</function>(<parameter>cost</parameter>,<parameter>purchase_date</parameter>,<parameter>first_period</parameter>,<parameter>salvage</parameter>,<parameter>period</parameter>,<parameter>rate</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>AMORDEGRC</function> calculates the depreciation of an asset using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account. This is similar to AMORLINC, except that a depreciation coefficient is applied in the calculation depending on the life of the assets.</para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>purchase_date</parameter>: date of purchase</para>
+ <para><parameter>first_period</parameter>: end of first period</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>period</parameter>: subject period</para>
+ <para><parameter>rate</parameter>: depreciation rate</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Named for AMORtissement DEGRessif Comptabilite.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AMORLINC"><function>AMORLINC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-AMORLINC">
+ <refmeta>
+ <refentrytitle>
+ <function>AMORLINC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AMORLINC</function>
+ </refname>
+ <refpurpose>
depreciation of an asset using French accounting conventions
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>AMORLINC</function>(<parameter>cost</parameter>,<parameter>purchase_date</parameter>,<parameter>first_period</parameter>,<parameter>salvage</parameter>,<parameter>period</parameter>,<parameter>rate</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>AMORLINC</function> calculates the depreciation of an asset using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account. </para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>purchase_date</parameter>: date of purchase</para>
- <para><parameter>first_period</parameter>: end of first period</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>period</parameter>: subject period</para>
- <para><parameter>rate</parameter>: depreciation rate</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Named for AMORtissement LINeaire Comptabilite.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AMORDEGRC"><function>AMORDEGRC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ATL_LAST">
- <refmeta>
- <refentrytitle>
- <function>ATL_LAST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ATL_LAST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>AMORLINC</function>(<parameter>cost</parameter>,<parameter>purchase_date</parameter>,<parameter>first_period</parameter>,<parameter>salvage</parameter>,<parameter>period</parameter>,<parameter>rate</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>AMORLINC</function> calculates the depreciation of an asset using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account. </para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>purchase_date</parameter>: date of purchase</para>
+ <para><parameter>first_period</parameter>: end of first period</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>period</parameter>: subject period</para>
+ <para><parameter>rate</parameter>: depreciation rate</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Named for AMORtissement LINeaire Comptabilite.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AMORDEGRC"><function>AMORDEGRC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ATL_LAST">
+ <refmeta>
+ <refentrytitle>
+ <function>ATL_LAST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ATL_LAST</function>
+ </refname>
+ <refpurpose>
sample real-time data source
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ATL_LAST</function>(<parameter>tag</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ATL_LAST</function> is a sample implementation of a real time data source. It takes a string tag and monitors the named pipe ~/atl for changes to the value of that tag.</para>
- <para><parameter>tag</parameter>: tag to watch</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This is not intended to be generally enabled and is OFF by default.</para>
- </refsect1>
- <refentry id="gnumeric-COUPDAYBS">
- <refmeta>
- <refentrytitle>
- <function>COUPDAYBS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUPDAYBS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ATL_LAST</function>(<parameter>tag</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ATL_LAST</function> is a sample implementation of a real time data source. It takes a string tag and monitors the named pipe ~/atl for changes to the value of that tag.</para>
+ <para><parameter>tag</parameter>: tag to watch</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This is not intended to be generally enabled and is OFF by default.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUPDAYBS">
+ <refmeta>
+ <refentrytitle>
+ <function>COUPDAYBS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUPDAYBS</function>
+ </refname>
+ <refpurpose>
number of days from coupon period to settlement
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COUPDAYBS</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUPDAYBS</function> calculates the number of days from the beginning of the coupon period to the settlement date.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- <para><parameter>eom</parameter>: end-of-month flag</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUPDAYS">
- <refmeta>
- <refentrytitle>
- <function>COUPDAYS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUPDAYS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COUPDAYBS</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COUPDAYBS</function> calculates the number of days from the beginning of the coupon period to the settlement date.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ <para><parameter>eom</parameter>: end-of-month flag</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUPDAYS">
+ <refmeta>
+ <refentrytitle>
+ <function>COUPDAYS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUPDAYS</function>
+ </refname>
+ <refpurpose>
number of days in the coupon period of the settlement date
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COUPDAYS</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUPDAYS</function> calculates the number of days in the coupon period of the settlement date.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- <para><parameter>eom</parameter>: end-of-month flag</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>,
- <link linkend="gnumeric-COUPDAYSNC"><function>COUPDAYSNC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUPDAYSNC">
- <refmeta>
- <refentrytitle>
- <function>COUPDAYSNC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUPDAYSNC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COUPDAYS</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COUPDAYS</function> calculates the number of days in the coupon period of the settlement date.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ <para><parameter>eom</parameter>: end-of-month flag</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>,
+ <link linkend="gnumeric-COUPDAYSNC"><function>COUPDAYSNC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUPDAYSNC">
+ <refmeta>
+ <refentrytitle>
+ <function>COUPDAYSNC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUPDAYSNC</function>
+ </refname>
+ <refpurpose>
number of days from the settlement date to the next coupon period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COUPDAYSNC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUPDAYSNC</function> calculates number of days from the settlement date to the next coupon period.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- <para><parameter>eom</parameter>: end-of-month flag</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
- <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUPNCD">
- <refmeta>
- <refentrytitle>
- <function>COUPNCD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUPNCD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COUPDAYSNC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COUPDAYSNC</function> calculates number of days from the settlement date to the next coupon period.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ <para><parameter>eom</parameter>: end-of-month flag</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
+ <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUPNCD">
+ <refmeta>
+ <refentrytitle>
+ <function>COUPNCD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUPNCD</function>
+ </refname>
+ <refpurpose>
the next coupon date after settlement
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COUPNCD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUPNCD</function> calculates the coupon date following settlement.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- <para><parameter>eom</parameter>: end-of-month flag</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUPPCD"><function>COUPPCD</function></link>,
- <link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
- <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUPNUM">
- <refmeta>
- <refentrytitle>
- <function>COUPNUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUPNUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COUPNCD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COUPNCD</function> calculates the coupon date following settlement.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ <para><parameter>eom</parameter>: end-of-month flag</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUPPCD"><function>COUPPCD</function></link>,
+ <link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
+ <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUPNUM">
+ <refmeta>
+ <refentrytitle>
+ <function>COUPNUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUPNUM</function>
+ </refname>
+ <refpurpose>
number of coupons
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COUPNUM</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUPNUM</function> calculates the number of coupons to be paid between the settlement and maturity dates, rounded up.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- <para><parameter>eom</parameter>: end-of-month flag</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUPNCD"><function>COUPNCD</function></link>,
- <link linkend="gnumeric-COUPPCD"><function>COUPPCD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUPPCD">
- <refmeta>
- <refentrytitle>
- <function>COUPPCD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUPPCD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COUPNUM</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COUPNUM</function> calculates the number of coupons to be paid between the settlement and maturity dates, rounded up.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ <para><parameter>eom</parameter>: end-of-month flag</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUPNCD"><function>COUPNCD</function></link>,
+ <link linkend="gnumeric-COUPPCD"><function>COUPPCD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUPPCD">
+ <refmeta>
+ <refentrytitle>
+ <function>COUPPCD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUPPCD</function>
+ </refname>
+ <refpurpose>
the last coupon date before settlement
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COUPPCD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUPPCD</function> calculates the coupon date preceding settlement.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- <para><parameter>eom</parameter>: end-of-month flag</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUPNCD"><function>COUPNCD</function></link>,
- <link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
- <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CUM_BIV_NORM_DIST">
- <refmeta>
- <refentrytitle>
- <function>CUM_BIV_NORM_DIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CUM_BIV_NORM_DIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COUPPCD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>,<parameter>eom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COUPPCD</function> calculates the coupon date preceding settlement.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ <para><parameter>eom</parameter>: end-of-month flag</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUPNCD"><function>COUPNCD</function></link>,
+ <link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
+ <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CUM_BIV_NORM_DIST">
+ <refmeta>
+ <refentrytitle>
+ <function>CUM_BIV_NORM_DIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CUM_BIV_NORM_DIST</function>
+ </refname>
+ <refpurpose>
cumulative bivariate normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CUM_BIV_NORM_DIST</function>(<parameter>a</parameter>,<parameter>b</parameter>,<parameter>rho</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CUM_BIV_NORM_DIST</function> calculates the probability that two standard normal distributed random variables with correlation <parameter>rho</parameter> are respectively each less than <parameter>a</parameter> and <parameter>b</parameter>.</para>
- <para><parameter>a</parameter>: limit for first random variable</para>
- <para><parameter>b</parameter>: limit for second random variable</para>
- <para><parameter>rho</parameter>: correlation of the two random variables</para>
- </refsect1>
- <refentry id="gnumeric-CUMIPMT">
- <refmeta>
- <refentrytitle>
- <function>CUMIPMT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CUMIPMT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CUM_BIV_NORM_DIST</function>(<parameter>a</parameter>,<parameter>b</parameter>,<parameter>rho</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CUM_BIV_NORM_DIST</function> calculates the probability that two standard normal distributed random variables with correlation <parameter>rho</parameter> are respectively each less than <parameter>a</parameter> and <parameter>b</parameter>.</para>
+ <para><parameter>a</parameter>: limit for first random variable</para>
+ <para><parameter>b</parameter>: limit for second random variable</para>
+ <para><parameter>rho</parameter>: correlation of the two random variables</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CUMIPMT">
+ <refmeta>
+ <refentrytitle>
+ <function>CUMIPMT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CUMIPMT</function>
+ </refname>
+ <refpurpose>
cumulative interest payment
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CUMIPMT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>start_period</parameter>,<parameter>end_period</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CUMIPMT</function> calculates the cumulative interest paid on a loan from <parameter>start_period</parameter> to <parameter>end_period</parameter>.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>start_period</parameter>: first period to accumulate for</para>
- <para><parameter>end_period</parameter>: last period to accumulate for</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CUMPRINC">
- <refmeta>
- <refentrytitle>
- <function>CUMPRINC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CUMPRINC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CUMIPMT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>start_period</parameter>,<parameter>end_period</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CUMIPMT</function> calculates the cumulative interest paid on a loan from <parameter>start_period</parameter> to <parameter>end_period</parameter>.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>start_period</parameter>: first period to accumulate for</para>
+ <para><parameter>end_period</parameter>: last period to accumulate for</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CUMPRINC">
+ <refmeta>
+ <refentrytitle>
+ <function>CUMPRINC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CUMPRINC</function>
+ </refname>
+ <refpurpose>
cumulative principal
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CUMPRINC</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>start_period</parameter>,<parameter>end_period</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CUMPRINC</function> calculates the cumulative principal paid on a loan from <parameter>start_period</parameter> to <parameter>end_period</parameter>.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>start_period</parameter>: first period to accumulate for</para>
- <para><parameter>end_period</parameter>: last period to accumulate for</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DB">
- <refmeta>
- <refentrytitle>
- <function>DB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CUMPRINC</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>start_period</parameter>,<parameter>end_period</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CUMPRINC</function> calculates the cumulative principal paid on a loan from <parameter>start_period</parameter> to <parameter>end_period</parameter>.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>start_period</parameter>: first period to accumulate for</para>
+ <para><parameter>end_period</parameter>: last period to accumulate for</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DB">
+ <refmeta>
+ <refentrytitle>
+ <function>DB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DB</function>
+ </refname>
+ <refpurpose>
depreciation of an asset
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>,<parameter>month</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DB</function> calculates the depreciation of an asset for a given period using the fixed-declining balance method.</para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>life</parameter>: number of periods</para>
- <para><parameter>period</parameter>: subject period</para>
- <para><parameter>month</parameter>: number of months in first year of depreciation</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DDB"><function>DDB</function></link>,
- <link linkend="gnumeric-SLN"><function>SLN</function></link>,
- <link linkend="gnumeric-SYD"><function>SYD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DDB">
- <refmeta>
- <refentrytitle>
- <function>DDB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DDB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>,<parameter>month</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DB</function> calculates the depreciation of an asset for a given period using the fixed-declining balance method.</para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>life</parameter>: number of periods</para>
+ <para><parameter>period</parameter>: subject period</para>
+ <para><parameter>month</parameter>: number of months in first year of depreciation</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DDB"><function>DDB</function></link>,
+ <link linkend="gnumeric-SLN"><function>SLN</function></link>,
+ <link linkend="gnumeric-SYD"><function>SYD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DDB">
+ <refmeta>
+ <refentrytitle>
+ <function>DDB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DDB</function>
+ </refname>
+ <refpurpose>
depreciation of an asset
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DDB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>,<parameter>factor</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DDB</function> calculates the depreciation of an asset for a given period using the double-declining balance method.</para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>life</parameter>: number of periods</para>
- <para><parameter>period</parameter>: subject period</para>
- <para><parameter>factor</parameter>: factor at which the balance declines</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DB"><function>DB</function></link>,
- <link linkend="gnumeric-SLN"><function>SLN</function></link>,
- <link linkend="gnumeric-SYD"><function>SYD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DISC">
- <refmeta>
- <refentrytitle>
- <function>DISC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DISC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DDB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>,<parameter>factor</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DDB</function> calculates the depreciation of an asset for a given period using the double-declining balance method.</para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>life</parameter>: number of periods</para>
+ <para><parameter>period</parameter>: subject period</para>
+ <para><parameter>factor</parameter>: factor at which the balance declines</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DB"><function>DB</function></link>,
+ <link linkend="gnumeric-SLN"><function>SLN</function></link>,
+ <link linkend="gnumeric-SYD"><function>SYD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DISC">
+ <refmeta>
+ <refentrytitle>
+ <function>DISC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DISC</function>
+ </refname>
+ <refpurpose>
discount rate
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>par</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DISC</function> calculates the discount rate for a security.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>par</parameter>: price per $100 face value</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>redemption</parameter> is the redemption value per $100 face value.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PRICEMAT"><function>PRICEMAT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DOLLARDE">
- <refmeta>
- <refentrytitle>
- <function>DOLLARDE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DOLLARDE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>par</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DISC</function> calculates the discount rate for a security.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>par</parameter>: price per $100 face value</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>redemption</parameter> is the redemption value per $100 face value.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PRICEMAT"><function>PRICEMAT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DOLLARDE">
+ <refmeta>
+ <refentrytitle>
+ <function>DOLLARDE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DOLLARDE</function>
+ </refname>
+ <refpurpose>
convert to decimal dollar amount
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DOLLARDE</function>(<parameter>fractional_dollar</parameter>,<parameter>fraction</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DOLLARDE</function> converts a fractional dollar amount into a decimal amount. This is the inverse of the DOLLARFR function.</para>
- <para><parameter>fractional_dollar</parameter>: amount to convert</para>
- <para><parameter>fraction</parameter>: denominator</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DOLLARFR"><function>DOLLARFR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DOLLARFR">
- <refmeta>
- <refentrytitle>
- <function>DOLLARFR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DOLLARFR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DOLLARDE</function>(<parameter>fractional_dollar</parameter>,<parameter>fraction</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DOLLARDE</function> converts a fractional dollar amount into a decimal amount. This is the inverse of the DOLLARFR function.</para>
+ <para><parameter>fractional_dollar</parameter>: amount to convert</para>
+ <para><parameter>fraction</parameter>: denominator</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DOLLARFR"><function>DOLLARFR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DOLLARFR">
+ <refmeta>
+ <refentrytitle>
+ <function>DOLLARFR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DOLLARFR</function>
+ </refname>
+ <refpurpose>
convert to dollar fraction
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DOLLARFR</function>(<parameter>decimal_dollar</parameter>,<parameter>fraction</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DOLLARFR</function> converts a fractional dollar amount into a fraction which is represented as the digits after the decimal point. For example, 2/8 would be represented as .2 while 3/16 would be represented as .03.</para>
- <para><parameter>decimal_dollar</parameter>: amount to convert</para>
- <para><parameter>fraction</parameter>: denominator</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DOLLARDE"><function>DOLLARDE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DURATION">
- <refmeta>
- <refentrytitle>
- <function>DURATION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DURATION</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DOLLARFR</function>(<parameter>decimal_dollar</parameter>,<parameter>fraction</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DOLLARFR</function> converts a fractional dollar amount into a fraction which is represented as the digits after the decimal point. For example, 2/8 would be represented as .2 while 3/16 would be represented as .03.</para>
+ <para><parameter>decimal_dollar</parameter>: amount to convert</para>
+ <para><parameter>fraction</parameter>: denominator</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DOLLARDE"><function>DOLLARDE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DURATION">
+ <refmeta>
+ <refentrytitle>
+ <function>DURATION</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DURATION</function>
+ </refname>
+ <refpurpose>
the duration of a security
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DURATION</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>coupon</parameter>,<parameter>yield</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DURATION</function> calculates the duration of a security.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>coupon</parameter>: annual coupon rate</para>
- <para><parameter>yield</parameter>: annual yield of security</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MDURATION"><function>MDURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EFFECT">
- <refmeta>
- <refentrytitle>
- <function>EFFECT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EFFECT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DURATION</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>coupon</parameter>,<parameter>yield</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DURATION</function> calculates the duration of a security.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>coupon</parameter>: annual coupon rate</para>
+ <para><parameter>yield</parameter>: annual yield of security</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MDURATION"><function>MDURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EFFECT">
+ <refmeta>
+ <refentrytitle>
+ <function>EFFECT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EFFECT</function>
+ </refname>
+ <refpurpose>
effective interest rate
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EFFECT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EFFECT</function> calculates the effective interest rate using the formula (1+<parameter>rate</parameter>/<parameter>nper</parameter>)^<parameter>nper</parameter>-1.</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>nper</parameter>: number of periods used for compounding</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NOMINAL"><function>NOMINAL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EURO">
- <refmeta>
- <refentrytitle>
- <function>EURO</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EURO</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EFFECT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>EFFECT</function> calculates the effective interest rate using the formula (1+<parameter>rate</parameter>/<parameter>nper</parameter>)^<parameter>nper</parameter>-1.</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>nper</parameter>: number of periods used for compounding</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NOMINAL"><function>NOMINAL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EURO">
+ <refmeta>
+ <refentrytitle>
+ <function>EURO</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EURO</function>
+ </refname>
+ <refpurpose>
equivalent of 1 EUR
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EURO</function>(<parameter>currency</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EURO</function> calculates the national currency amount corresponding to 1 EUR for any of the national currencies that were replaced by the Euro on its introduction.</para>
- <para><parameter>currency</parameter>: three-letter currency code</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>currency</parameter> must be one of ATS (Austria), BEF (Belgium), CYP (Cyprus), DEM (Germany), ESP (Spain), EUR (Euro), FIM (Finland), FRF (France), GRD (Greece), IEP (Ireland), ITL (Italy), LUF (Luxembourg), MTL (Malta), NLG (The Netherlands), PTE (Portugal), SIT (Slovenia), or SKK (Slovakia).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function is not likely to be useful anymore.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EUROCONVERT"><function>EUROCONVERT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EUROCONVERT">
- <refmeta>
- <refentrytitle>
- <function>EUROCONVERT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EUROCONVERT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EURO</function>(<parameter>currency</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>EURO</function> calculates the national currency amount corresponding to 1 EUR for any of the national currencies that were replaced by the Euro on its introduction.</para>
+ <para><parameter>currency</parameter>: three-letter currency code</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>currency</parameter> must be one of ATS (Austria), BEF (Belgium), CYP (Cyprus), DEM (Germany), ESP (Spain), EUR (Euro), FIM (Finland), FRF (France), GRD (Greece), IEP (Ireland), ITL (Italy), LUF (Luxembourg), MTL (Malta), NLG (The Netherlands), PTE (Portugal), SIT (Slovenia), or SKK (Slovakia).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function is not likely to be useful anymore.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EUROCONVERT"><function>EUROCONVERT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EUROCONVERT">
+ <refmeta>
+ <refentrytitle>
+ <function>EUROCONVERT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EUROCONVERT</function>
+ </refname>
+ <refpurpose>
pre-Euro amount from one currency to another
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EUROCONVERT</function>(<parameter>n</parameter>,<parameter>source</parameter>,<parameter>target</parameter>,<parameter>full_precision</parameter>,<parameter>triangulation_precision</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EUROCONVERT</function> converts <parameter>n</parameter> units of currency <parameter>source</parameter> to currency <parameter>target</parameter>. The rates used are the official ones used on the introduction of the Euro.</para>
- <para><parameter>n</parameter>: amount</para>
- <para><parameter>source</parameter>: three-letter source currency code</para>
- <para><parameter>target</parameter>: three-letter target currency code</para>
- <para><parameter>full_precision</parameter>: if true, the result is not rounded; if false the result is rounded to 0 or 2 decimals depending on the target currency; defaults to false.</para>
- <para><parameter>triangulation_precision</parameter>: number of digits (at least 3) to be rounded to after the source currency has been converted to euro; omitting this argument results in no rounding.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>source</parameter> and <parameter>target</parameter> must be one of the currencies listed for the EURO function.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function is not likely to be useful anymore.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EURO"><function>EURO</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FV">
- <refmeta>
- <refentrytitle>
- <function>FV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EUROCONVERT</function>(<parameter>n</parameter>,<parameter>source</parameter>,<parameter>target</parameter>,<parameter>full_precision</parameter>,<parameter>triangulation_precision</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>EUROCONVERT</function> converts <parameter>n</parameter> units of currency <parameter>source</parameter> to currency <parameter>target</parameter>. The rates used are the official ones used on the introduction of the Euro.</para>
+ <para><parameter>n</parameter>: amount</para>
+ <para><parameter>source</parameter>: three-letter source currency code</para>
+ <para><parameter>target</parameter>: three-letter target currency code</para>
+ <para><parameter>full_precision</parameter>: if true, the result is not rounded; if false the result is rounded to 0 or 2 decimals depending on the target currency; defaults to false.</para>
+ <para><parameter>triangulation_precision</parameter>: number of digits (at least 3) to be rounded to after the source currency has been converted to euro; omitting this argument results in no rounding.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>source</parameter> and <parameter>target</parameter> must be one of the currencies listed for the EURO function.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function is not likely to be useful anymore.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EURO"><function>EURO</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FV">
+ <refmeta>
+ <refentrytitle>
+ <function>FV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FV</function>
+ </refname>
+ <refpurpose>
future value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FV</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FV</function> calculates the future value of <parameter>pv</parameter> moved <parameter>nper</parameter> periods into the future, assuming a periodic payment of <parameter>pmt</parameter> and an interest rate of <parameter>rate</parameter> per period.</para>
- <para><parameter>rate</parameter>: effective interest rate per period</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pmt</parameter>: payment at each period</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FVSCHEDULE">
- <refmeta>
- <refentrytitle>
- <function>FVSCHEDULE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FVSCHEDULE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FV</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>FV</function> calculates the future value of <parameter>pv</parameter> moved <parameter>nper</parameter> periods into the future, assuming a periodic payment of <parameter>pmt</parameter> and an interest rate of <parameter>rate</parameter> per period.</para>
+ <para><parameter>rate</parameter>: effective interest rate per period</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pmt</parameter>: payment at each period</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FVSCHEDULE">
+ <refmeta>
+ <refentrytitle>
+ <function>FVSCHEDULE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FVSCHEDULE</function>
+ </refname>
+ <refpurpose>
future value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FVSCHEDULE</function>(<parameter>principal</parameter>,<parameter>schedule</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FVSCHEDULE</function> calculates the future value of <parameter>principal</parameter> after applying a range of interest rates with compounding.</para>
- <para><parameter>principal</parameter>: initial value</para>
- <para><parameter>schedule</parameter>: range of interest rates</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FV"><function>FV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-G_DURATION">
- <refmeta>
- <refentrytitle>
- <function>G_DURATION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>G_DURATION</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FVSCHEDULE</function>(<parameter>principal</parameter>,<parameter>schedule</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>FVSCHEDULE</function> calculates the future value of <parameter>principal</parameter> after applying a range of interest rates with compounding.</para>
+ <para><parameter>principal</parameter>: initial value</para>
+ <para><parameter>schedule</parameter>: range of interest rates</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FV"><function>FV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-G_DURATION">
+ <refmeta>
+ <refentrytitle>
+ <function>G_DURATION</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>G_DURATION</function>
+ </refname>
+ <refpurpose>
the duration of a investment
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>G_DURATION</function>(<parameter>rate</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>G_DURATION</function> calculates the number of periods needed for an investment to attain a desired value.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FV"><function>FV</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-INTRATE">
- <refmeta>
- <refentrytitle>
- <function>INTRATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INTRATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>G_DURATION</function>(<parameter>rate</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>G_DURATION</function> calculates the number of periods needed for an investment to attain a desired value.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FV"><function>FV</function></link>,
+ <link linkend="gnumeric-PV"><function>PV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INTRATE">
+ <refmeta>
+ <refentrytitle>
+ <function>INTRATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INTRATE</function>
+ </refname>
+ <refpurpose>
interest rate
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INTRATE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>investment</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>INTRATE</function> calculates the interest of a fully vested security.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>investment</parameter>: amount paid on settlement</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RECEIVED"><function>RECEIVED</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IPMT">
- <refmeta>
- <refentrytitle>
- <function>IPMT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IPMT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INTRATE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>investment</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>INTRATE</function> calculates the interest of a fully vested security.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>investment</parameter>: amount paid on settlement</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RECEIVED"><function>RECEIVED</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IPMT">
+ <refmeta>
+ <refentrytitle>
+ <function>IPMT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IPMT</function>
+ </refname>
+ <refpurpose>
interest payment for period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IPMT</function>(<parameter>rate</parameter>,<parameter>per</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IPMT</function> calculates the interest part of an annuity's payment for period number <parameter>per</parameter>.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>per</parameter>: period number</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IRR">
- <refmeta>
- <refentrytitle>
- <function>IRR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IRR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IPMT</function>(<parameter>rate</parameter>,<parameter>per</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IPMT</function> calculates the interest part of an annuity's payment for period number <parameter>per</parameter>.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>per</parameter>: period number</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IRR">
+ <refmeta>
+ <refentrytitle>
+ <function>IRR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IRR</function>
+ </refname>
+ <refpurpose>
internal rate of return
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IRR</function>(<parameter>values</parameter>,<parameter>guess</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IRR</function> calculates the internal rate of return of a cash flow with periodic payments. <parameter>values</parameter> lists the payments (negative values) and receipts (positive values) for each period.</para>
- <para><parameter>values</parameter>: cash flow</para>
- <para><parameter>guess</parameter>: an estimate of what the result should be</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The optional <parameter>guess</parameter> is needed because there can be more than one valid result. It defaults to 10%.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-XIRR"><function>XIRR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ISPMT">
- <refmeta>
- <refentrytitle>
- <function>ISPMT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISPMT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IRR</function>(<parameter>values</parameter>,<parameter>guess</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>IRR</function> calculates the internal rate of return of a cash flow with periodic payments. <parameter>values</parameter> lists the payments (negative values) and receipts (positive values) for each period.</para>
+ <para><parameter>values</parameter>: cash flow</para>
+ <para><parameter>guess</parameter>: an estimate of what the result should be</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The optional <parameter>guess</parameter> is needed because there can be more than one valid result. It defaults to 10%.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-XIRR"><function>XIRR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISPMT">
+ <refmeta>
+ <refentrytitle>
+ <function>ISPMT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISPMT</function>
+ </refname>
+ <refpurpose>
interest payment for period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISPMT</function>(<parameter>rate</parameter>,<parameter>per</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISPMT</function> calculates the interest payment for period number <parameter>per</parameter>.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>per</parameter>: period number</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MDURATION">
- <refmeta>
- <refentrytitle>
- <function>MDURATION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MDURATION</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISPMT</function>(<parameter>rate</parameter>,<parameter>per</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ISPMT</function> calculates the interest payment for period number <parameter>per</parameter>.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>per</parameter>: period number</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MDURATION">
+ <refmeta>
+ <refentrytitle>
+ <function>MDURATION</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MDURATION</function>
+ </refname>
+ <refpurpose>
the Macauley duration of a security
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MDURATION</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>coupon</parameter>,<parameter>yield</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MDURATION</function> calculates the Macauley duration of a security.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>coupon</parameter>: annual coupon rate</para>
- <para><parameter>yield</parameter>: annual yield of security</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MIRR">
- <refmeta>
- <refentrytitle>
- <function>MIRR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MIRR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MDURATION</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>coupon</parameter>,<parameter>yield</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>MDURATION</function> calculates the Macauley duration of a security.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>coupon</parameter>: annual coupon rate</para>
+ <para><parameter>yield</parameter>: annual yield of security</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MIRR">
+ <refmeta>
+ <refentrytitle>
+ <function>MIRR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MIRR</function>
+ </refname>
+ <refpurpose>
modified internal rate of return
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MIRR</function>(<parameter>values</parameter>,<parameter>finance_rate</parameter>,<parameter>reinvest_rate</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MIRR</function> calculates the modified internal rate of return of a periodic cash flow.</para>
- <para><parameter>values</parameter>: cash flow</para>
- <para><parameter>finance_rate</parameter>: interest rate for financing cost</para>
- <para><parameter>reinvest_rate</parameter>: interest rate for reinvestments</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IRR"><function>IRR</function></link>,
- <link linkend="gnumeric-XIRR"><function>XIRR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NOMINAL">
- <refmeta>
- <refentrytitle>
- <function>NOMINAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NOMINAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MIRR</function>(<parameter>values</parameter>,<parameter>finance_rate</parameter>,<parameter>reinvest_rate</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>MIRR</function> calculates the modified internal rate of return of a periodic cash flow.</para>
+ <para><parameter>values</parameter>: cash flow</para>
+ <para><parameter>finance_rate</parameter>: interest rate for financing cost</para>
+ <para><parameter>reinvest_rate</parameter>: interest rate for reinvestments</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IRR"><function>IRR</function></link>,
+ <link linkend="gnumeric-XIRR"><function>XIRR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NOMINAL">
+ <refmeta>
+ <refentrytitle>
+ <function>NOMINAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NOMINAL</function>
+ </refname>
+ <refpurpose>
nominal interest rate
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NOMINAL</function>(<parameter>rate</parameter>,<parameter>nper</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NOMINAL</function> calculates the nominal interest rate from the effective rate.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>nper</parameter>: number of periods used for compounding</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EFFECT"><function>EFFECT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NPER">
- <refmeta>
- <refentrytitle>
- <function>NPER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NPER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NOMINAL</function>(<parameter>rate</parameter>,<parameter>nper</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NOMINAL</function> calculates the nominal interest rate from the effective rate.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>nper</parameter>: number of periods used for compounding</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EFFECT"><function>EFFECT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NPER">
+ <refmeta>
+ <refentrytitle>
+ <function>NPER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NPER</function>
+ </refname>
+ <refpurpose>
number of periods
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NPER</function>(<parameter>rate</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NPER</function> calculates the number of periods of an investment based on periodic constant payments and a constant interest rate.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>pmt</parameter>: payment at each period</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NPV">
- <refmeta>
- <refentrytitle>
- <function>NPV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NPV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NPER</function>(<parameter>rate</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NPER</function> calculates the number of periods of an investment based on periodic constant payments and a constant interest rate.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>pmt</parameter>: payment at each period</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>,
+ <link linkend="gnumeric-FV"><function>FV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NPV">
+ <refmeta>
+ <refentrytitle>
+ <function>NPV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NPV</function>
+ </refname>
+ <refpurpose>
net present value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NPV</function>(<parameter>rate</parameter>,<parameter>value1</parameter>,<parameter>value2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NPV</function> calculates the net present value of a cash flow.</para>
- <para><parameter>rate</parameter>: effective interest rate per period</para>
- <para><parameter>value1</parameter>: cash flow for period 1</para>
- <para><parameter>value2</parameter>: cash flow for period 2</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ODDFPRICE">
- <refmeta>
- <refentrytitle>
- <function>ODDFPRICE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ODDFPRICE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NPV</function>(<parameter>rate</parameter>,<parameter>value1</parameter>,<parameter>value2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NPV</function> calculates the net present value of a cash flow.</para>
+ <para><parameter>rate</parameter>: effective interest rate per period</para>
+ <para><parameter>value1</parameter>: cash flow for period 1</para>
+ <para><parameter>value2</parameter>: cash flow for period 2</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ODDFPRICE">
+ <refmeta>
+ <refentrytitle>
+ <function>ODDFPRICE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ODDFPRICE</function>
+ </refname>
+ <refpurpose>
price of a security that has an odd first period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ODDFPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>first_interest</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ODDFPRICE</function> calculates the price per $100 face value of a security that pays periodic interest, but has an odd first period.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>issue</parameter>: date of issue</para>
- <para><parameter>first_interest</parameter>: first interest date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>yield</parameter>: annual yield of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ODDLPRICE"><function>ODDLPRICE</function></link>,
- <link linkend="gnumeric-ODDFYIELD"><function>ODDFYIELD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ODDFYIELD">
- <refmeta>
- <refentrytitle>
- <function>ODDFYIELD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ODDFYIELD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ODDFPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>first_interest</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ODDFPRICE</function> calculates the price per $100 face value of a security that pays periodic interest, but has an odd first period.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>issue</parameter>: date of issue</para>
+ <para><parameter>first_interest</parameter>: first interest date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>yield</parameter>: annual yield of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ODDLPRICE"><function>ODDLPRICE</function></link>,
+ <link linkend="gnumeric-ODDFYIELD"><function>ODDFYIELD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ODDFYIELD">
+ <refmeta>
+ <refentrytitle>
+ <function>ODDFYIELD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ODDFYIELD</function>
+ </refname>
+ <refpurpose>
yield of a security that has an odd first period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ODDFYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>first_interest</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ODDFYIELD</function> calculates the yield of a security that pays periodic interest, but has an odd first period.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>issue</parameter>: date of issue</para>
- <para><parameter>first_interest</parameter>: first interest date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>price</parameter>: price of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ODDFPRICE"><function>ODDFPRICE</function></link>,
- <link linkend="gnumeric-ODDLYIELD"><function>ODDLYIELD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ODDLPRICE">
- <refmeta>
- <refentrytitle>
- <function>ODDLPRICE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ODDLPRICE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ODDFYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>first_interest</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ODDFYIELD</function> calculates the yield of a security that pays periodic interest, but has an odd first period.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>issue</parameter>: date of issue</para>
+ <para><parameter>first_interest</parameter>: first interest date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>price</parameter>: price of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ODDFPRICE"><function>ODDFPRICE</function></link>,
+ <link linkend="gnumeric-ODDLYIELD"><function>ODDLYIELD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ODDLPRICE">
+ <refmeta>
+ <refentrytitle>
+ <function>ODDLPRICE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ODDLPRICE</function>
+ </refname>
+ <refpurpose>
price of a security that has an odd last period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ODDLPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>last_interest</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ODDLPRICE</function> calculates the price per $100 face value of a security that pays periodic interest, but has an odd last period.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>last_interest</parameter>: last interest date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>yield</parameter>: annual yield of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
- <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ODDLYIELD">
- <refmeta>
- <refentrytitle>
- <function>ODDLYIELD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ODDLYIELD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ODDLPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>last_interest</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ODDLPRICE</function> calculates the price per $100 face value of a security that pays periodic interest, but has an odd last period.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>last_interest</parameter>: last interest date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>yield</parameter>: annual yield of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ODDLYIELD">
+ <refmeta>
+ <refentrytitle>
+ <function>ODDLYIELD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ODDLYIELD</function>
+ </refname>
+ <refpurpose>
yield of a security that has an odd last period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ODDLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>last_interest</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ODDLYIELD</function> calculates the yield of a security that pays periodic interest, but has an odd last period.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>last_interest</parameter>: last interest date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>price</parameter>: price of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
- <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_2_ASSET_CORRELATION">
- <refmeta>
- <refentrytitle>
- <function>OPT_2_ASSET_CORRELATION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_2_ASSET_CORRELATION</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ODDLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>last_interest</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ODDLYIELD</function> calculates the yield of a security that pays periodic interest, but has an odd last period.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>last_interest</parameter>: last interest date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>price</parameter>: price of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_2_ASSET_CORRELATION">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_2_ASSET_CORRELATION</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_2_ASSET_CORRELATION</function>
+ </refname>
+ <refpurpose>
theoretical price of options on 2 assets with correlation <parameter>rho</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_2_ASSET_CORRELATION</function>(<parameter>call_put_flag</parameter>,<parameter>spot1</parameter>,<parameter>spot2</parameter>,<parameter>strike1</parameter>,<parameter>strike1</parameter>,<parameter>time</parameter>,<parameter>cost_of_carry1</parameter>,<parameter>cost_of_carry2</parameter>,<parameter>rate</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_2_ASSET_CORRELATION</function> models the theoretical price of options on 2 assets with correlation <parameter>rho</parameter>. The payoff for a call is max(<parameter>spot2</parameter> - <parameter>strike2</parameter>,0) if <parameter>spot1</parameter> > <parameter>strike1</parameter> or 0 otherwise. The payoff for a put is max (<parameter>strike2</parameter> - <parameter>spot2</parameter>, 0) if <parameter>spot1</parameter> < <parameter>strike1</parameter> or 0 otherwise.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot1</parameter>: spot price of the underlying asset of the first option</para>
- <para><parameter>spot2</parameter>: spot price of the underlying asset of the second option</para>
- <para><parameter>strike1</parameter>: strike prices of the first option</para>
- <para><parameter>strike1</parameter>: strike prices of the second option</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>cost_of_carry1</parameter>: net cost of holding the underlying asset of the first option (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>cost_of_carry2</parameter>: net cost of holding the underlying asset of the second option (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>volatility1</parameter>: annualized volatility in price of the underlying asset of the first option</para>
- <para><parameter>volatility2</parameter>: annualized volatility in price of the underlying asset of the second option</para>
- <para><parameter>rho</parameter>: correlation between the two underlying assets</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_AMER_EXCHANGE">
- <refmeta>
- <refentrytitle>
- <function>OPT_AMER_EXCHANGE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_AMER_EXCHANGE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_2_ASSET_CORRELATION</function>(<parameter>call_put_flag</parameter>,<parameter>spot1</parameter>,<parameter>spot2</parameter>,<parameter>strike1</parameter>,<parameter>strike1</parameter>,<parameter>time</parameter>,<parameter>cost_of_carry1</parameter>,<parameter>cost_of_carry2</parameter>,<parameter>rate</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_2_ASSET_CORRELATION</function> models the theoretical price of options on 2 assets with correlation <parameter>rho</parameter>. The payoff for a call is max(<parameter>spot2</parameter> - <parameter>strike2</parameter>,0) if <parameter>spot1</parameter> > <parameter>strike1</parameter> or 0 otherwise. The payoff for a put is max (<parameter>strike2</parameter> - <parameter>spot2</parameter>, 0) if <parameter>spot1</parameter> < <parameter>strike1</parameter> or 0 otherwise.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot1</parameter>: spot price of the underlying asset of the first option</para>
+ <para><parameter>spot2</parameter>: spot price of the underlying asset of the second option</para>
+ <para><parameter>strike1</parameter>: strike prices of the first option</para>
+ <para><parameter>strike1</parameter>: strike prices of the second option</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>cost_of_carry1</parameter>: net cost of holding the underlying asset of the first option (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>cost_of_carry2</parameter>: net cost of holding the underlying asset of the second option (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>volatility1</parameter>: annualized volatility in price of the underlying asset of the first option</para>
+ <para><parameter>volatility2</parameter>: annualized volatility in price of the underlying asset of the second option</para>
+ <para><parameter>rho</parameter>: correlation between the two underlying assets</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_AMER_EXCHANGE">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_AMER_EXCHANGE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_AMER_EXCHANGE</function>
+ </refname>
+ <refpurpose>
theoretical price of an American option to exchange assets
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_AMER_EXCHANGE</function>(<parameter>spot1</parameter>,<parameter>spot2</parameter>,<parameter>qty1</parameter>,<parameter>qty2</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry1</parameter>,<parameter>cost_of_carry2</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_AMER_EXCHANGE</function> models the theoretical price of an American option to exchange one asset with quantity <parameter>qty2</parameter> and spot price <parameter>spot2</parameter> for another with quantity <parameter>qty1</parameter> and spot price <parameter>spot1</parameter>.</para>
- <para><parameter>spot1</parameter>: spot price of asset 1</para>
- <para><parameter>spot2</parameter>: spot price of asset 1</para>
- <para><parameter>qty1</parameter>: quantity of asset 1</para>
- <para><parameter>qty2</parameter>: quantity of asset 2</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry1</parameter>: net cost of holding asset 1 (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>cost_of_carry2</parameter>: net cost of holding asset 2 (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>volatility1</parameter>: annualized volatility in price of asset 1</para>
- <para><parameter>volatility2</parameter>: annualized volatility in price of asset 2</para>
- <para><parameter>rho</parameter>: correlation between the prices of the two assets</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_EURO_EXCHANGE"><function>OPT_EURO_EXCHANGE</function></link>,
- <link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BAW_AMER">
- <refmeta>
- <refentrytitle>
- <function>OPT_BAW_AMER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BAW_AMER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_AMER_EXCHANGE</function>(<parameter>spot1</parameter>,<parameter>spot2</parameter>,<parameter>qty1</parameter>,<parameter>qty2</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry1</parameter>,<parameter>cost_of_carry2</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_AMER_EXCHANGE</function> models the theoretical price of an American option to exchange one asset with quantity <parameter>qty2</parameter> and spot price <parameter>spot2</parameter> for another with quantity <parameter>qty1</parameter> and spot price <parameter>spot1</parameter>.</para>
+ <para><parameter>spot1</parameter>: spot price of asset 1</para>
+ <para><parameter>spot2</parameter>: spot price of asset 1</para>
+ <para><parameter>qty1</parameter>: quantity of asset 1</para>
+ <para><parameter>qty2</parameter>: quantity of asset 2</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry1</parameter>: net cost of holding asset 1 (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>cost_of_carry2</parameter>: net cost of holding asset 2 (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>volatility1</parameter>: annualized volatility in price of asset 1</para>
+ <para><parameter>volatility2</parameter>: annualized volatility in price of asset 2</para>
+ <para><parameter>rho</parameter>: correlation between the prices of the two assets</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_EURO_EXCHANGE"><function>OPT_EURO_EXCHANGE</function></link>,
+ <link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BAW_AMER">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BAW_AMER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BAW_AMER</function>
+ </refname>
+ <refpurpose>
theoretical price of an option according to the Barone Adesie & Whaley approximation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_BAW_AMER</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in days</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_BINOMIAL">
- <refmeta>
- <refentrytitle>
- <function>OPT_BINOMIAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BINOMIAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BAW_AMER</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in days</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BINOMIAL">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BINOMIAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BINOMIAL</function>
+ </refname>
+ <refpurpose>
theoretical price of either an American or European style option using a binomial tree
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BINOMIAL</function>(<parameter>amer_euro_flag</parameter>,<parameter>call_put_flag</parameter>,<parameter>num_time_steps</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>amer_euro_flag</parameter>: 'a' for an American style option or 'e' for a European style option</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>num_time_steps</parameter>: number of time steps used in the valuation</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>A larger <parameter>num_time_steps</parameter> yields greater accuracy but <function>OPT_BINOMIAL</function> is slower to calculate.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BJER_STENS">
- <refmeta>
- <refentrytitle>
- <function>OPT_BJER_STENS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BJER_STENS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BINOMIAL</function>(<parameter>amer_euro_flag</parameter>,<parameter>call_put_flag</parameter>,<parameter>num_time_steps</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>amer_euro_flag</parameter>: 'a' for an American style option or 'e' for a European style option</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>num_time_steps</parameter>: number of time steps used in the valuation</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>A larger <parameter>num_time_steps</parameter> yields greater accuracy but <function>OPT_BINOMIAL</function> is slower to calculate.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BJER_STENS">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BJER_STENS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BJER_STENS</function>
+ </refname>
+ <refpurpose>
theoretical price of American options according to the Bjerksund & Stensland approximation technique
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_BJER_STENS</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in days</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_BS">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BJER_STENS</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in days</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS</function>
+ </refname>
+ <refpurpose>
price of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_BS</function> uses the Black-Scholes model to calculate the price of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The returned value will be expressed in the same units as <parameter>strike</parameter> and <parameter>spot</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BS_CARRYCOST">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS_CARRYCOST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS_CARRYCOST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_BS</function> uses the Black-Scholes model to calculate the price of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The returned value will be expressed in the same units as <parameter>strike</parameter> and <parameter>spot</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS_CARRYCOST">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS_CARRYCOST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS_CARRYCOST</function>
+ </refname>
+ <refpurpose>
elasticity of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS_CARRYCOST</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_BS_CARRYCOST</function> uses the Black-Scholes model to calculate the 'elasticity' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The elasticity of an option is the rate of change of its price with respect to its <parameter>cost_of_carry</parameter>.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Elasticity is expressed as the rate of change of the option value, per 100% volatility.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BS_DELTA">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS_DELTA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS_DELTA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS_CARRYCOST</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_BS_CARRYCOST</function> uses the Black-Scholes model to calculate the 'elasticity' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The elasticity of an option is the rate of change of its price with respect to its <parameter>cost_of_carry</parameter>.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Elasticity is expressed as the rate of change of the option value, per 100% volatility.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS_DELTA">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS_DELTA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS_DELTA</function>
+ </refname>
+ <refpurpose>
delta of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS_DELTA</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_BS_DELTA</function> uses the Black-Scholes model to calculate the 'delta' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The returned value will be expressed in the same units as <parameter>strike</parameter> and <parameter>spot</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BS_GAMMA">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS_GAMMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS_GAMMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS_DELTA</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_BS_DELTA</function> uses the Black-Scholes model to calculate the 'delta' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The returned value will be expressed in the same units as <parameter>strike</parameter> and <parameter>spot</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS_GAMMA">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS_GAMMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS_GAMMA</function>
+ </refname>
+ <refpurpose>
gamma of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS_GAMMA</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'gamma' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The gamma of an option is the second derivative of its price with respect to the price of the underlying asset.</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Gamma is expressed as the rate of change of delta per unit change in <parameter>spot</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Gamma is the same for calls and puts.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BS_RHO">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS_RHO</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS_RHO</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS_GAMMA</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'gamma' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The gamma of an option is the second derivative of its price with respect to the price of the underlying asset.</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Gamma is expressed as the rate of change of delta per unit change in <parameter>spot</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Gamma is the same for calls and puts.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS_RHO">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS_RHO</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS_RHO</function>
+ </refname>
+ <refpurpose>
rho of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS_RHO</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'rho' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The rho of an option is the rate of change of its price with respect to the risk free interest rate.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Rho is expressed as the rate of change of the option value, per 100% change in <parameter>rate</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BS_THETA">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS_THETA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS_THETA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS_RHO</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'rho' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The rho of an option is the rate of change of its price with respect to the risk free interest rate.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Rho is expressed as the rate of change of the option value, per 100% change in <parameter>rate</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS_THETA">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS_THETA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS_THETA</function>
+ </refname>
+ <refpurpose>
theta of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS_THETA</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'theta' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The theta of an option is the rate of change of its price with respect to time to expiry.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Theta is expressed as the negative of the rate of change of the option value, per 365.25 days.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_BS_VEGA">
- <refmeta>
- <refentrytitle>
- <function>OPT_BS_VEGA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_BS_VEGA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS_THETA</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'theta' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The theta of an option is the rate of change of its price with respect to time to expiry.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Theta is expressed as the negative of the rate of change of the option value, per 365.25 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_VEGA"><function>OPT_BS_VEGA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_BS_VEGA">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_BS_VEGA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_BS_VEGA</function>
+ </refname>
+ <refpurpose>
vega of a European option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_BS_VEGA</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'vega' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The vega of an option is the rate of change of its price with respect to volatility.</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Vega is the same for calls and puts.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Vega is expressed as the rate of change of option value, per 100% volatility.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_COMPLEX_CHOOSER">
- <refmeta>
- <refentrytitle>
- <function>OPT_COMPLEX_CHOOSER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_COMPLEX_CHOOSER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_BS_VEGA</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>OPT_BS_DELTA uses the Black-Scholes model to calculate the 'vega' of a European option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>. The vega of an option is the rate of change of its price with respect to volatility.</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Vega is the same for calls and puts.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Vega is expressed as the rate of change of option value, per 100% volatility.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_COMPLEX_CHOOSER">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_COMPLEX_CHOOSER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_COMPLEX_CHOOSER</function>
+ </refname>
+ <refpurpose>
theoretical price of a complex chooser option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_COMPLEX_CHOOSER</function>(<parameter>spot</parameter>,<parameter>strike_call</parameter>,<parameter>strike_put</parameter>,<parameter>time</parameter>,<parameter>time_call</parameter>,<parameter>time_put</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike_call</parameter>: strike price, if exercised as a call option.</para>
- <para><parameter>strike_put</parameter>: strike price, if exercised as a put option</para>
- <para><parameter>time</parameter>: time in years until the holder chooses a put or a call option</para>
- <para><parameter>time_call</parameter>: time in years to maturity of the call option if chosen</para>
- <para><parameter>time_put</parameter>: time in years to maturity of the put option if chosen</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_EURO_EXCHANGE">
- <refmeta>
- <refentrytitle>
- <function>OPT_EURO_EXCHANGE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_EURO_EXCHANGE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_COMPLEX_CHOOSER</function>(<parameter>spot</parameter>,<parameter>strike_call</parameter>,<parameter>strike_put</parameter>,<parameter>time</parameter>,<parameter>time_call</parameter>,<parameter>time_put</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike_call</parameter>: strike price, if exercised as a call option.</para>
+ <para><parameter>strike_put</parameter>: strike price, if exercised as a put option</para>
+ <para><parameter>time</parameter>: time in years until the holder chooses a put or a call option</para>
+ <para><parameter>time_call</parameter>: time in years to maturity of the call option if chosen</para>
+ <para><parameter>time_put</parameter>: time in years to maturity of the put option if chosen</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_EURO_EXCHANGE">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_EURO_EXCHANGE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_EURO_EXCHANGE</function>
+ </refname>
+ <refpurpose>
theoretical price of a European option to exchange assets
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_EURO_EXCHANGE</function>(<parameter>spot1</parameter>,<parameter>spot2</parameter>,<parameter>qty1</parameter>,<parameter>qty2</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry1</parameter>,<parameter>cost_of_carry2</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_EURO_EXCHANGE</function> models the theoretical price of a European option to exchange one asset with quantity <parameter>qty2</parameter> and spot price <parameter>spot2</parameter> for another with quantity <parameter>qty1</parameter> and spot price <parameter>spot1</parameter>.</para>
- <para><parameter>spot1</parameter>: spot price of asset 1</para>
- <para><parameter>spot2</parameter>: spot price of asset 1</para>
- <para><parameter>qty1</parameter>: quantity of asset 1</para>
- <para><parameter>qty2</parameter>: quantity of asset 2</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry1</parameter>: net cost of holding asset 1 (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>cost_of_carry2</parameter>: net cost of holding asset 2 (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>volatility1</parameter>: annualized volatility in price of asset 1</para>
- <para><parameter>volatility2</parameter>: annualized volatility in price of asset 2</para>
- <para><parameter>rho</parameter>: correlation between the prices of the two assets</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_AMER_EXCHANGE"><function>OPT_AMER_EXCHANGE</function></link>,
- <link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_EXEC">
- <refmeta>
- <refentrytitle>
- <function>OPT_EXEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_EXEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_EURO_EXCHANGE</function>(<parameter>spot1</parameter>,<parameter>spot2</parameter>,<parameter>qty1</parameter>,<parameter>qty2</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry1</parameter>,<parameter>cost_of_carry2</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_EURO_EXCHANGE</function> models the theoretical price of a European option to exchange one asset with quantity <parameter>qty2</parameter> and spot price <parameter>spot2</parameter> for another with quantity <parameter>qty1</parameter> and spot price <parameter>spot1</parameter>.</para>
+ <para><parameter>spot1</parameter>: spot price of asset 1</para>
+ <para><parameter>spot2</parameter>: spot price of asset 1</para>
+ <para><parameter>qty1</parameter>: quantity of asset 1</para>
+ <para><parameter>qty2</parameter>: quantity of asset 2</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry1</parameter>: net cost of holding asset 1 (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>cost_of_carry2</parameter>: net cost of holding asset 2 (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>volatility1</parameter>: annualized volatility in price of asset 1</para>
+ <para><parameter>volatility2</parameter>: annualized volatility in price of asset 2</para>
+ <para><parameter>rho</parameter>: correlation between the prices of the two assets</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_AMER_EXCHANGE"><function>OPT_AMER_EXCHANGE</function></link>,
+ <link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_EXEC">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_EXEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_EXEC</function>
+ </refname>
+ <refpurpose>
theoretical price of executive stock options
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_EXEC</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>,<parameter>lambda</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in days</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>lambda</parameter>: jump rate for executives</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The model assumes executives forfeit their options if they leave the company.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_EXTENDIBLE_WRITER">
- <refmeta>
- <refentrytitle>
- <function>OPT_EXTENDIBLE_WRITER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_EXTENDIBLE_WRITER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_EXEC</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>,<parameter>lambda</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in days</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>lambda</parameter>: jump rate for executives</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The model assumes executives forfeit their options if they leave the company.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_EXTENDIBLE_WRITER">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_EXTENDIBLE_WRITER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_EXTENDIBLE_WRITER</function>
+ </refname>
+ <refpurpose>
theoretical price of extendible writer options
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_EXTENDIBLE_WRITER</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike1</parameter>,<parameter>strike2</parameter>,<parameter>time1</parameter>,<parameter>time2</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_EXTENDIBLE_WRITER</function> models the theoretical price of extendible writer options. These are options that have their maturity extended to <parameter>time2</parameter> if the option is out of the money at <parameter>time1</parameter>.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike1</parameter>: strike price at which the option is struck</para>
- <para><parameter>strike2</parameter>: strike price at which the option is re-struck if out of the money at <parameter>time1</parameter></para>
- <para><parameter>time1</parameter>: initial maturity of the option in years</para>
- <para><parameter>time2</parameter>: extended maturity in years if chosen</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_FIXED_STRK_LKBK">
- <refmeta>
- <refentrytitle>
- <function>OPT_FIXED_STRK_LKBK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_FIXED_STRK_LKBK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_EXTENDIBLE_WRITER</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike1</parameter>,<parameter>strike2</parameter>,<parameter>time1</parameter>,<parameter>time2</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_EXTENDIBLE_WRITER</function> models the theoretical price of extendible writer options. These are options that have their maturity extended to <parameter>time2</parameter> if the option is out of the money at <parameter>time1</parameter>.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike1</parameter>: strike price at which the option is struck</para>
+ <para><parameter>strike2</parameter>: strike price at which the option is re-struck if out of the money at <parameter>time1</parameter></para>
+ <para><parameter>time1</parameter>: initial maturity of the option in years</para>
+ <para><parameter>time2</parameter>: extended maturity in years if chosen</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_FIXED_STRK_LKBK">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_FIXED_STRK_LKBK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_FIXED_STRK_LKBK</function>
+ </refname>
+ <refpurpose>
theoretical price of a fixed-strike lookback option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_FIXED_STRK_LKBK</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>spot_min</parameter>,<parameter>spot_max</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_FIXED_STRK_LKBK</function> determines the theoretical price of a fixed-strike lookback option where the holder of the option may exercise on expiry at the most favourable price observed during the options life of the underlying asset.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>spot_min</parameter>: minimum spot price of the underlying asset so far observed</para>
- <para><parameter>spot_max</parameter>: maximum spot price of the underlying asset so far observed</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_FLOAT_STRK_LKBK">
- <refmeta>
- <refentrytitle>
- <function>OPT_FLOAT_STRK_LKBK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_FLOAT_STRK_LKBK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_FIXED_STRK_LKBK</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>spot_min</parameter>,<parameter>spot_max</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_FIXED_STRK_LKBK</function> determines the theoretical price of a fixed-strike lookback option where the holder of the option may exercise on expiry at the most favourable price observed during the options life of the underlying asset.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>spot_min</parameter>: minimum spot price of the underlying asset so far observed</para>
+ <para><parameter>spot_max</parameter>: maximum spot price of the underlying asset so far observed</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_FLOAT_STRK_LKBK">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_FLOAT_STRK_LKBK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_FLOAT_STRK_LKBK</function>
+ </refname>
+ <refpurpose>
theoretical price of floating-strike lookback option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_FLOAT_STRK_LKBK</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>spot_min</parameter>,<parameter>spot_max</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_FLOAT_STRK_LKBK</function> determines the theoretical price of a floating-strike lookback option where the holder of the option may exercise on expiry at the most favourable price observed during the options life of the underlying asset.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>spot_min</parameter>: minimum spot price of the underlying asset so far observed</para>
- <para><parameter>spot_max</parameter>: maximum spot price of the underlying asset so far observed</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_FORWARD_START">
- <refmeta>
- <refentrytitle>
- <function>OPT_FORWARD_START</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_FORWARD_START</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_FLOAT_STRK_LKBK</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>spot_min</parameter>,<parameter>spot_max</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_FLOAT_STRK_LKBK</function> determines the theoretical price of a floating-strike lookback option where the holder of the option may exercise on expiry at the most favourable price observed during the options life of the underlying asset.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>spot_min</parameter>: minimum spot price of the underlying asset so far observed</para>
+ <para><parameter>spot_max</parameter>: maximum spot price of the underlying asset so far observed</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_FORWARD_START">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_FORWARD_START</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_FORWARD_START</function>
+ </refname>
+ <refpurpose>
theoretical price of forward start options
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_FORWARD_START</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>alpha</parameter>,<parameter>time_start</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>alpha</parameter>: fraction setting the strike price at the future date <parameter>time_start</parameter></para>
- <para><parameter>time_start</parameter>: time until the option starts in days</para>
- <para><parameter>time</parameter>: time to maturity in days</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_FRENCH">
- <refmeta>
- <refentrytitle>
- <function>OPT_FRENCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_FRENCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_FORWARD_START</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>alpha</parameter>,<parameter>time_start</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>alpha</parameter>: fraction setting the strike price at the future date <parameter>time_start</parameter></para>
+ <para><parameter>time_start</parameter>: time until the option starts in days</para>
+ <para><parameter>time</parameter>: time to maturity in days</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_FRENCH">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_FRENCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_FRENCH</function>
+ </refname>
+ <refpurpose>
theoretical price of a European option adjusted for trading day volatility
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_FRENCH</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>ttime</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_FRENCH</function> values the theoretical price of a European option adjusted for trading day volatility, struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: ratio of the number of calendar days to exercise and the number of calendar days in the year</para>
- <para><parameter>ttime</parameter>: ratio of the number of trading days to exercise and the number of trading days in the year</para>
- <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_GARMAN_KOHLHAGEN">
- <refmeta>
- <refentrytitle>
- <function>OPT_GARMAN_KOHLHAGEN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_GARMAN_KOHLHAGEN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_FRENCH</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>ttime</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_FRENCH</function> values the theoretical price of a European option adjusted for trading day volatility, struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: ratio of the number of calendar days to exercise and the number of calendar days in the year</para>
+ <para><parameter>ttime</parameter>: ratio of the number of trading days to exercise and the number of trading days in the year</para>
+ <para><parameter>rate</parameter>: risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_GARMAN_KOHLHAGEN">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_GARMAN_KOHLHAGEN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_GARMAN_KOHLHAGEN</function>
+ </refname>
+ <refpurpose>
theoretical price of a European currency option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_GARMAN_KOHLHAGEN</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>domestic_rate</parameter>,<parameter>foreign_rate</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_GARMAN_KOHLHAGEN</function> values the theoretical price of a European currency option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: number of days to exercise</para>
- <para><parameter>domestic_rate</parameter>: domestic risk-free interest rate to the exercise date in percent</para>
- <para><parameter>foreign_rate</parameter>: foreign risk-free interest rate to the exercise date in percent</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_JUMP_DIFF">
- <refmeta>
- <refentrytitle>
- <function>OPT_JUMP_DIFF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_JUMP_DIFF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_GARMAN_KOHLHAGEN</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>domestic_rate</parameter>,<parameter>foreign_rate</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_GARMAN_KOHLHAGEN</function> values the theoretical price of a European currency option struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: number of days to exercise</para>
+ <para><parameter>domestic_rate</parameter>: domestic risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>foreign_rate</parameter>: foreign risk-free interest rate to the exercise date in percent</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_JUMP_DIFF">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_JUMP_DIFF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_JUMP_DIFF</function>
+ </refname>
+ <refpurpose>
theoretical price of an option according to the Jump Diffusion process
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_JUMP_DIFF</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>lambda</parameter>,<parameter>gamma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_JUMP_DIFF</function> models the theoretical price of an option according to the Jump Diffusion process (Merton).</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: the annualized rate of interest</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- <para><parameter>lambda</parameter>: expected number of 'jumps' per year</para>
- <para><parameter>gamma</parameter>: proportion of volatility explained by the 'jumps'</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_MILTERSEN_SCHWARTZ">
- <refmeta>
- <refentrytitle>
- <function>OPT_MILTERSEN_SCHWARTZ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_MILTERSEN_SCHWARTZ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_JUMP_DIFF</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>lambda</parameter>,<parameter>gamma</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_JUMP_DIFF</function> models the theoretical price of an option according to the Jump Diffusion process (Merton).</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: the annualized rate of interest</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ <para><parameter>lambda</parameter>: expected number of 'jumps' per year</para>
+ <para><parameter>gamma</parameter>: proportion of volatility explained by the 'jumps'</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_MILTERSEN_SCHWARTZ">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_MILTERSEN_SCHWARTZ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_MILTERSEN_SCHWARTZ</function>
+ </refname>
+ <refpurpose>
theoretical price of options on commodities futures according to Miltersen & Schwartz
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_MILTERSEN_SCHWARTZ</function>(<parameter>call_put_flag</parameter>,<parameter>p_t</parameter>,<parameter>f_t</parameter>,<parameter>strike</parameter>,<parameter>t1</parameter>,<parameter>t2</parameter>,<parameter>v_s</parameter>,<parameter>v_e</parameter>,<parameter>v_f</parameter>,<parameter>rho_se</parameter>,<parameter>rho_sf</parameter>,<parameter>rho_ef</parameter>,<parameter>kappa_e</parameter>,<parameter>kappa_f</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>p_t</parameter>: zero coupon bond with expiry at option maturity</para>
- <para><parameter>f_t</parameter>: futures price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>t1</parameter>: time to maturity of the option</para>
- <para><parameter>t2</parameter>: time to maturity of the underlying commodity futures contract</para>
- <para><parameter>v_s</parameter>: volatility of the spot commodity price</para>
- <para><parameter>v_e</parameter>: volatility of the future convenience yield</para>
- <para><parameter>v_f</parameter>: volatility of the forward rate of interest</para>
- <para><parameter>rho_se</parameter>: correlation between the spot commodity price and the convenience yield</para>
- <para><parameter>rho_sf</parameter>: correlation between the spot commodity price and the forward interest rate</para>
- <para><parameter>rho_ef</parameter>: correlation between the forward interest rate and the convenience yield</para>
- <para><parameter>kappa_e</parameter>: speed of mean reversion of the convenience yield</para>
- <para><parameter>kappa_f</parameter>: speed of mean reversion of the forward interest rate</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_ON_OPTIONS">
- <refmeta>
- <refentrytitle>
- <function>OPT_ON_OPTIONS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_ON_OPTIONS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_MILTERSEN_SCHWARTZ</function>(<parameter>call_put_flag</parameter>,<parameter>p_t</parameter>,<parameter>f_t</parameter>,<parameter>strike</parameter>,<parameter>t1</parameter>,<parameter>t2</parameter>,<parameter>v_s</parameter>,<parameter>v_e</parameter>,<parameter>v_f</parameter>,<parameter>rho_se</parameter>,<parameter>rho_sf</parameter>,<parameter>rho_ef</parameter>,<parameter>kappa_e</parameter>,<parameter>kappa_f</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>p_t</parameter>: zero coupon bond with expiry at option maturity</para>
+ <para><parameter>f_t</parameter>: futures price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>t1</parameter>: time to maturity of the option</para>
+ <para><parameter>t2</parameter>: time to maturity of the underlying commodity futures contract</para>
+ <para><parameter>v_s</parameter>: volatility of the spot commodity price</para>
+ <para><parameter>v_e</parameter>: volatility of the future convenience yield</para>
+ <para><parameter>v_f</parameter>: volatility of the forward rate of interest</para>
+ <para><parameter>rho_se</parameter>: correlation between the spot commodity price and the convenience yield</para>
+ <para><parameter>rho_sf</parameter>: correlation between the spot commodity price and the forward interest rate</para>
+ <para><parameter>rho_ef</parameter>: correlation between the forward interest rate and the convenience yield</para>
+ <para><parameter>kappa_e</parameter>: speed of mean reversion of the convenience yield</para>
+ <para><parameter>kappa_f</parameter>: speed of mean reversion of the forward interest rate</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_ON_OPTIONS">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_ON_OPTIONS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_ON_OPTIONS</function>
+ </refname>
+ <refpurpose>
theoretical price of options on options
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_ON_OPTIONS</function>(<parameter>type_flag</parameter>,<parameter>spot</parameter>,<parameter>strike1</parameter>,<parameter>strike2</parameter>,<parameter>time1</parameter>,<parameter>time2</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>type_flag</parameter>: 'cc' for calls on calls, 'cp' for calls on puts, and so on for 'pc', and 'pp'.</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike1</parameter>: strike price at which the option being valued is struck</para>
- <para><parameter>strike2</parameter>: strike price at which the underlying option is struck</para>
- <para><parameter>time1</parameter>: time in years to maturity of the option</para>
- <para><parameter>time2</parameter>: time in years to the maturity of the underlying option</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset of the underlying option (for common stocks, the risk free rate less the dividend yield)</para>
- <para><parameter>volatility</parameter>: annualized volatility in price of the underlying asset of the underlying option</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>time2</parameter> â?¥ <parameter>time1</parameter></para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OPT_RGW">
- <refmeta>
- <refentrytitle>
- <function>OPT_RGW</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_RGW</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_ON_OPTIONS</function>(<parameter>type_flag</parameter>,<parameter>spot</parameter>,<parameter>strike1</parameter>,<parameter>strike2</parameter>,<parameter>time1</parameter>,<parameter>time2</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>type_flag</parameter>: 'cc' for calls on calls, 'cp' for calls on puts, and so on for 'pc', and 'pp'.</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike1</parameter>: strike price at which the option being valued is struck</para>
+ <para><parameter>strike2</parameter>: strike price at which the underlying option is struck</para>
+ <para><parameter>time1</parameter>: time in years to maturity of the option</para>
+ <para><parameter>time2</parameter>: time in years to the maturity of the underlying option</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset of the underlying option (for common stocks, the risk free rate less the dividend yield)</para>
+ <para><parameter>volatility</parameter>: annualized volatility in price of the underlying asset of the underlying option</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>time2</parameter> â?¥ <parameter>time1</parameter></para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_RGW">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_RGW</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_RGW</function>
+ </refname>
+ <refpurpose>
theoretical price of an American option according to the Roll-Geske-Whaley approximation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_RGW</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time_payout</parameter>,<parameter>time_exp</parameter>,<parameter>rate</parameter>,<parameter>d</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time_payout</parameter>: time to dividend payout</para>
- <para><parameter>time_exp</parameter>: time to expiration</para>
- <para><parameter>rate</parameter>: annualized interest rate</para>
- <para><parameter>d</parameter>: amount of the dividend to be paid expressed in currency</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_SIMPLE_CHOOSER">
- <refmeta>
- <refentrytitle>
- <function>OPT_SIMPLE_CHOOSER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_SIMPLE_CHOOSER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_RGW</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time_payout</parameter>,<parameter>time_exp</parameter>,<parameter>rate</parameter>,<parameter>d</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time_payout</parameter>: time to dividend payout</para>
+ <para><parameter>time_exp</parameter>: time to expiration</para>
+ <para><parameter>rate</parameter>: annualized interest rate</para>
+ <para><parameter>d</parameter>: amount of the dividend to be paid expressed in currency</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset in percent for the period through to the exercise date</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_SIMPLE_CHOOSER">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_SIMPLE_CHOOSER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_SIMPLE_CHOOSER</function>
+ </refname>
+ <refpurpose>
theoretical price of a simple chooser option
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_SIMPLE_CHOOSER</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time1</parameter>,<parameter>time2</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time1</parameter>: time in years until the holder chooses a put or a call option</para>
- <para><parameter>time2</parameter>: time in years until the chosen option expires</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_SPREAD_APPROX">
- <refmeta>
- <refentrytitle>
- <function>OPT_SPREAD_APPROX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_SPREAD_APPROX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_SIMPLE_CHOOSER</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time1</parameter>,<parameter>time2</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time1</parameter>: time in years until the holder chooses a put or a call option</para>
+ <para><parameter>time2</parameter>: time in years until the chosen option expires</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_SPREAD_APPROX">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_SPREAD_APPROX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_SPREAD_APPROX</function>
+ </refname>
+ <refpurpose>
theoretical price of a European option on the spread between two futures contracts
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>OPT_SPREAD_APPROX</function>(<parameter>call_put_flag</parameter>,<parameter>fut_price1</parameter>,<parameter>fut_price2</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>fut_price1</parameter>: price of the first futures contract</para>
- <para><parameter>fut_price2</parameter>: price of the second futures contract</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>volatility1</parameter>: annualized volatility in price of the first underlying futures contract</para>
- <para><parameter>volatility2</parameter>: annualized volatility in price of the second underlying futures contract</para>
- <para><parameter>rho</parameter>: correlation between the two futures contracts</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-OPT_TIME_SWITCH">
- <refmeta>
- <refentrytitle>
- <function>OPT_TIME_SWITCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OPT_TIME_SWITCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_SPREAD_APPROX</function>(<parameter>call_put_flag</parameter>,<parameter>fut_price1</parameter>,<parameter>fut_price2</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>fut_price1</parameter>: price of the first futures contract</para>
+ <para><parameter>fut_price2</parameter>: price of the second futures contract</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>volatility1</parameter>: annualized volatility in price of the first underlying futures contract</para>
+ <para><parameter>volatility2</parameter>: annualized volatility in price of the second underlying futures contract</para>
+ <para><parameter>rho</parameter>: correlation between the two futures contracts</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OPT_TIME_SWITCH">
+ <refmeta>
+ <refentrytitle>
+ <function>OPT_TIME_SWITCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OPT_TIME_SWITCH</function>
+ </refname>
+ <refpurpose>
theoretical price of time switch options
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OPT_TIME_SWITCH</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>a</parameter>,<parameter>time</parameter>,<parameter>m</parameter>,<parameter>dt</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_TIME_SWITCH</function> models the theoretical price of time switch options. (Pechtl 1995). The holder receives <parameter>a</parameter> * <parameter>dt</parameter> for each period that the asset price was greater than <parameter>strike</parameter> (for a call) or below it (for a put).</para>
- <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
- <para><parameter>spot</parameter>: spot price</para>
- <para><parameter>strike</parameter>: strike price</para>
- <para><parameter>a</parameter>: amount received for each time period</para>
- <para><parameter>time</parameter>: time to maturity in years</para>
- <para><parameter>m</parameter>: number of time units the option has already met the condition</para>
- <para><parameter>dt</parameter>: agreed upon discrete time period expressed as a fraction of a year</para>
- <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
- <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
- <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
- <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
- <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
- <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
- <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PMT">
- <refmeta>
- <refentrytitle>
- <function>PMT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PMT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OPT_TIME_SWITCH</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>a</parameter>,<parameter>time</parameter>,<parameter>m</parameter>,<parameter>dt</parameter>,<parameter>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OPT_TIME_SWITCH</function> models the theoretical price of time switch options. (Pechtl 1995). The holder receives <parameter>a</parameter> * <parameter>dt</parameter> for each period that the asset price was greater than <parameter>strike</parameter> (for a call) or below it (for a put).</para>
+ <para><parameter>call_put_flag</parameter>: 'c' for a call and 'p' for a put</para>
+ <para><parameter>spot</parameter>: spot price</para>
+ <para><parameter>strike</parameter>: strike price</para>
+ <para><parameter>a</parameter>: amount received for each time period</para>
+ <para><parameter>time</parameter>: time to maturity in years</para>
+ <para><parameter>m</parameter>: number of time units the option has already met the condition</para>
+ <para><parameter>dt</parameter>: agreed upon discrete time period expressed as a fraction of a year</para>
+ <para><parameter>rate</parameter>: annualized risk-free interest rate</para>
+ <para><parameter>cost_of_carry</parameter>: net cost of holding the underlying asset</para>
+ <para><parameter>volatility</parameter>: annualized volatility of the asset</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
+ <link linkend="gnumeric-OPT_BS_DELTA"><function>OPT_BS_DELTA</function></link>,
+ <link linkend="gnumeric-OPT_BS_RHO"><function>OPT_BS_RHO</function></link>,
+ <link linkend="gnumeric-OPT_BS_THETA"><function>OPT_BS_THETA</function></link>,
+ <link linkend="gnumeric-OPT_BS_GAMMA"><function>OPT_BS_GAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PMT">
+ <refmeta>
+ <refentrytitle>
+ <function>PMT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PMT</function>
+ </refname>
+ <refpurpose>
payment for annuity
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PMT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PMT</function> calculates the payment amount for an annuity.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>,
- <link linkend="gnumeric-RATE"><function>RATE</function></link>,
- <link linkend="gnumeric-ISPMT"><function>ISPMT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PPMT">
- <refmeta>
- <refentrytitle>
- <function>PPMT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PPMT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PMT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PMT</function> calculates the payment amount for an annuity.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>,
+ <link linkend="gnumeric-FV"><function>FV</function></link>,
+ <link linkend="gnumeric-RATE"><function>RATE</function></link>,
+ <link linkend="gnumeric-ISPMT"><function>ISPMT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PPMT">
+ <refmeta>
+ <refentrytitle>
+ <function>PPMT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PPMT</function>
+ </refname>
+ <refpurpose>
interest payment for period
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PPMT</function>(<parameter>rate</parameter>,<parameter>per</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PPMT</function> calculates the principal part of an annuity's payment for period number <parameter>per</parameter>.</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>per</parameter>: period number</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PRICE">
- <refmeta>
- <refentrytitle>
- <function>PRICE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PRICE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PPMT</function>(<parameter>rate</parameter>,<parameter>per</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PPMT</function> calculates the principal part of an annuity's payment for period number <parameter>per</parameter>.</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>per</parameter>: period number</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PRICE">
+ <refmeta>
+ <refentrytitle>
+ <function>PRICE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PRICE</function>
+ </refname>
+ <refpurpose>
price of a security
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PRICE</function> calculates the price per $100 face value of a security that pays periodic interest.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>yield</parameter>: annual yield of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
- <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PRICEDISC">
- <refmeta>
- <refentrytitle>
- <function>PRICEDISC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PRICEDISC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PRICE</function> calculates the price per $100 face value of a security that pays periodic interest.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>yield</parameter>: annual yield of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PRICEDISC">
+ <refmeta>
+ <refentrytitle>
+ <function>PRICEDISC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PRICEDISC</function>
+ </refname>
+ <refpurpose>
discounted price
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PRICEDISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PRICEDISC</function> calculates the price per $100 face value of a bond that does not pay interest at maturity.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>discount</parameter>: annual rate at which to discount</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PRICEMAT"><function>PRICEMAT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PRICEMAT">
- <refmeta>
- <refentrytitle>
- <function>PRICEMAT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PRICEMAT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PRICEDISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PRICEDISC</function> calculates the price per $100 face value of a bond that does not pay interest at maturity.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>discount</parameter>: annual rate at which to discount</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PRICEMAT"><function>PRICEMAT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PRICEMAT">
+ <refmeta>
+ <refentrytitle>
+ <function>PRICEMAT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PRICEMAT</function>
+ </refname>
+ <refpurpose>
price at maturity
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PRICEMAT</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>discount</parameter>,<parameter>yield</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PRICEMAT</function> calculates the price per $100 face value of a bond that pays interest at maturity.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>issue</parameter>: date of issue</para>
- <para><parameter>discount</parameter>: annual rate at which to discount</para>
- <para><parameter>yield</parameter>: annual yield of security</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PRICEDISC"><function>PRICEDISC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PV">
- <refmeta>
- <refentrytitle>
- <function>PV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PRICEMAT</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>discount</parameter>,<parameter>yield</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PRICEMAT</function> calculates the price per $100 face value of a bond that pays interest at maturity.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>issue</parameter>: date of issue</para>
+ <para><parameter>discount</parameter>: annual rate at which to discount</para>
+ <para><parameter>yield</parameter>: annual yield of security</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PRICEDISC"><function>PRICEDISC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PV">
+ <refmeta>
+ <refentrytitle>
+ <function>PV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PV</function>
+ </refname>
+ <refpurpose>
present value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PV</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pmt</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PV</function> calculates the present value of <parameter>fv</parameter> which is <parameter>nper</parameter> periods into the future, assuming a periodic payment of <parameter>pmt</parameter> and an interest rate of <parameter>rate</parameter> per period.</para>
- <para><parameter>rate</parameter>: effective interest rate per period</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pmt</parameter>: payment at each period</para>
- <para><parameter>fv</parameter>: future value</para>
- <para><parameter>type</parameter>: payment type</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FV"><function>FV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RATE">
- <refmeta>
- <refentrytitle>
- <function>RATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PV</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pmt</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PV</function> calculates the present value of <parameter>fv</parameter> which is <parameter>nper</parameter> periods into the future, assuming a periodic payment of <parameter>pmt</parameter> and an interest rate of <parameter>rate</parameter> per period.</para>
+ <para><parameter>rate</parameter>: effective interest rate per period</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pmt</parameter>: payment at each period</para>
+ <para><parameter>fv</parameter>: future value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FV"><function>FV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RATE">
+ <refmeta>
+ <refentrytitle>
+ <function>RATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RATE</function>
+ </refname>
+ <refpurpose>
rate of investment
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RATE</function>(<parameter>nper</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>,<parameter>guess</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RATE</function> calculates the rate of return.</para>
- <para><parameter>nper</parameter>: number of periods</para>
- <para><parameter>pmt</parameter>: payment at each period</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- <para><parameter>type</parameter>: payment type</para>
- <para><parameter>guess</parameter>: an estimate of what the result should be</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The optional <parameter>guess</parameter> is needed because there can be more than one valid result. It defaults to 10%.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RECEIVED">
- <refmeta>
- <refentrytitle>
- <function>RECEIVED</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RECEIVED</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RATE</function>(<parameter>nper</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>,<parameter>type</parameter>,<parameter>guess</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>RATE</function> calculates the rate of return.</para>
+ <para><parameter>nper</parameter>: number of periods</para>
+ <para><parameter>pmt</parameter>: payment at each period</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ <para><parameter>type</parameter>: payment type</para>
+ <para><parameter>guess</parameter>: an estimate of what the result should be</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The optional <parameter>guess</parameter> is needed because there can be more than one valid result. It defaults to 10%.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>,
+ <link linkend="gnumeric-FV"><function>FV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RECEIVED">
+ <refmeta>
+ <refentrytitle>
+ <function>RECEIVED</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RECEIVED</function>
+ </refname>
+ <refpurpose>
amount to be received at maturity
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RECEIVED</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>investment</parameter>,<parameter>rate</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RECEIVED</function> calculates the amount to be received when a security matures.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>investment</parameter>: amount paid on settlement</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INTRATE"><function>INTRATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RRI">
- <refmeta>
- <refentrytitle>
- <function>RRI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RRI</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RECEIVED</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>investment</parameter>,<parameter>rate</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>RECEIVED</function> calculates the amount to be received when a security matures.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>investment</parameter>: amount paid on settlement</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-INTRATE"><function>INTRATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RRI">
+ <refmeta>
+ <refentrytitle>
+ <function>RRI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RRI</function>
+ </refname>
+ <refpurpose>
equivalent interest rate for an investment increasing in value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RRI</function>(<parameter>p</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RRI</function> determines an equivalent interest rate for an investment that increases in value. The interest is compounded after each complete period.</para>
- <para><parameter>p</parameter>: number of periods</para>
- <para><parameter>pv</parameter>: present value</para>
- <para><parameter>fv</parameter>: future value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Note that <parameter>p</parameter> need not be an integer but for fractional value the calculated rate is only approximate.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>,
- <link linkend="gnumeric-RATE"><function>RATE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SLN">
- <refmeta>
- <refentrytitle>
- <function>SLN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SLN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RRI</function>(<parameter>p</parameter>,<parameter>pv</parameter>,<parameter>fv</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>RRI</function> determines an equivalent interest rate for an investment that increases in value. The interest is compounded after each complete period.</para>
+ <para><parameter>p</parameter>: number of periods</para>
+ <para><parameter>pv</parameter>: present value</para>
+ <para><parameter>fv</parameter>: future value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Note that <parameter>p</parameter> need not be an integer but for fractional value the calculated rate is only approximate.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>,
+ <link linkend="gnumeric-FV"><function>FV</function></link>,
+ <link linkend="gnumeric-RATE"><function>RATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SLN">
+ <refmeta>
+ <refentrytitle>
+ <function>SLN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SLN</function>
+ </refname>
+ <refpurpose>
depreciation of an asset
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SLN</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SLN</function> calculates the depreciation of an asset using the straight-line method.</para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>life</parameter>: number of periods</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DB"><function>DB</function></link>,
- <link linkend="gnumeric-DDB"><function>DDB</function></link>,
- <link linkend="gnumeric-SYD"><function>SYD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SYD">
- <refmeta>
- <refentrytitle>
- <function>SYD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SYD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SLN</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SLN</function> calculates the depreciation of an asset using the straight-line method.</para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>life</parameter>: number of periods</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DB"><function>DB</function></link>,
+ <link linkend="gnumeric-DDB"><function>DDB</function></link>,
+ <link linkend="gnumeric-SYD"><function>SYD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SYD">
+ <refmeta>
+ <refentrytitle>
+ <function>SYD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SYD</function>
+ </refname>
+ <refpurpose>
sum-of-years depreciation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SYD</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SYD</function> calculates the depreciation of an asset using the sum-of-years method.</para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>life</parameter>: number of periods</para>
- <para><parameter>period</parameter>: subject period</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DB"><function>DB</function></link>,
- <link linkend="gnumeric-DDB"><function>DDB</function></link>,
- <link linkend="gnumeric-SLN"><function>SLN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TBILLEQ">
- <refmeta>
- <refentrytitle>
- <function>TBILLEQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TBILLEQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SYD</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SYD</function> calculates the depreciation of an asset using the sum-of-years method.</para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>life</parameter>: number of periods</para>
+ <para><parameter>period</parameter>: subject period</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DB"><function>DB</function></link>,
+ <link linkend="gnumeric-DDB"><function>DDB</function></link>,
+ <link linkend="gnumeric-SLN"><function>SLN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TBILLEQ">
+ <refmeta>
+ <refentrytitle>
+ <function>TBILLEQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TBILLEQ</function>
+ </refname>
+ <refpurpose>
bond-equivalent yield for a treasury bill
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TBILLEQ</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TBILLEQ</function> calculates the bond-equivalent yield for a treasury bill.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>discount</parameter>: annual rate at which to discount</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TBILLPRICE"><function>TBILLPRICE</function></link>,
- <link linkend="gnumeric-TBILLYIELD"><function>TBILLYIELD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TBILLPRICE">
- <refmeta>
- <refentrytitle>
- <function>TBILLPRICE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TBILLPRICE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TBILLEQ</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>TBILLEQ</function> calculates the bond-equivalent yield for a treasury bill.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>discount</parameter>: annual rate at which to discount</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TBILLPRICE"><function>TBILLPRICE</function></link>,
+ <link linkend="gnumeric-TBILLYIELD"><function>TBILLYIELD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TBILLPRICE">
+ <refmeta>
+ <refentrytitle>
+ <function>TBILLPRICE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TBILLPRICE</function>
+ </refname>
+ <refpurpose>
price of a treasury bill
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TBILLPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TBILLPRICE</function> calculates the price per $100 face value for a treasury bill.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>discount</parameter>: annual rate at which to discount</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TBILLEQ"><function>TBILLEQ</function></link>,
- <link linkend="gnumeric-TBILLYIELD"><function>TBILLYIELD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TBILLYIELD">
- <refmeta>
- <refentrytitle>
- <function>TBILLYIELD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TBILLYIELD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TBILLPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>TBILLPRICE</function> calculates the price per $100 face value for a treasury bill.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>discount</parameter>: annual rate at which to discount</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TBILLEQ"><function>TBILLEQ</function></link>,
+ <link linkend="gnumeric-TBILLYIELD"><function>TBILLYIELD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TBILLYIELD">
+ <refmeta>
+ <refentrytitle>
+ <function>TBILLYIELD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TBILLYIELD</function>
+ </refname>
+ <refpurpose>
yield of a treasury bill
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TBILLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>price</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TBILLYIELD</function> calculates the yield of a treasury bill.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>price</parameter>: price</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TBILLEQ"><function>TBILLEQ</function></link>,
- <link linkend="gnumeric-TBILLPRICE"><function>TBILLPRICE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-VDB">
- <refmeta>
- <refentrytitle>
- <function>VDB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VDB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TBILLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>price</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>TBILLYIELD</function> calculates the yield of a treasury bill.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>price</parameter>: price</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TBILLEQ"><function>TBILLEQ</function></link>,
+ <link linkend="gnumeric-TBILLPRICE"><function>TBILLPRICE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VDB">
+ <refmeta>
+ <refentrytitle>
+ <function>VDB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VDB</function>
+ </refname>
+ <refpurpose>
depreciation of an asset
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>VDB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>start_period</parameter>,<parameter>end_period</parameter>,<parameter>factor</parameter>,<parameter>no_switch</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VDB</function> calculates the depreciation of an asset for a given period range using the double-declining balance method.</para>
- <para><parameter>cost</parameter>: initial cost of asset</para>
- <para><parameter>salvage</parameter>: value after depreciation</para>
- <para><parameter>life</parameter>: number of periods</para>
- <para><parameter>start_period</parameter>: first period to accumulate for</para>
- <para><parameter>end_period</parameter>: last period to accumulate for</para>
- <para><parameter>factor</parameter>: factor at which the balance declines</para>
- <para><parameter>no_switch</parameter>: do not switch to straight-line depreciation</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>no_switch</parameter> is FALSE, the calculation switches to straight-line depreciation when depreciation is greater than the declining balance calculation.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DB"><function>DB</function></link>,
- <link linkend="gnumeric-DDB"><function>DDB</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-XIRR">
- <refmeta>
- <refentrytitle>
- <function>XIRR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>XIRR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>VDB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>start_period</parameter>,<parameter>end_period</parameter>,<parameter>factor</parameter>,<parameter>no_switch</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>VDB</function> calculates the depreciation of an asset for a given period range using the double-declining balance method.</para>
+ <para><parameter>cost</parameter>: initial cost of asset</para>
+ <para><parameter>salvage</parameter>: value after depreciation</para>
+ <para><parameter>life</parameter>: number of periods</para>
+ <para><parameter>start_period</parameter>: first period to accumulate for</para>
+ <para><parameter>end_period</parameter>: last period to accumulate for</para>
+ <para><parameter>factor</parameter>: factor at which the balance declines</para>
+ <para><parameter>no_switch</parameter>: do not switch to straight-line depreciation</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>no_switch</parameter> is FALSE, the calculation switches to straight-line depreciation when depreciation is greater than the declining balance calculation.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DB"><function>DB</function></link>,
+ <link linkend="gnumeric-DDB"><function>DDB</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-XIRR">
+ <refmeta>
+ <refentrytitle>
+ <function>XIRR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>XIRR</function>
+ </refname>
+ <refpurpose>
internal rate of return
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>XIRR</function>(<parameter>values</parameter>,<parameter>dates</parameter>,<parameter>guess</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>XIRR</function> calculates the annualized internal rate of return of a cash flow at arbitrary points in time. <parameter>values</parameter> lists the payments (negative values) and receipts (positive values) with one value for each entry in <parameter>dates</parameter>.</para>
- <para><parameter>values</parameter>: cash flow</para>
- <para><parameter>dates</parameter>: dates of cash flow</para>
- <para><parameter>guess</parameter>: an estimate of what the result should be</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The optional <parameter>guess</parameter> is needed because there can be more than one valid result. It defaults to 10%.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IRR"><function>IRR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-XNPV">
- <refmeta>
- <refentrytitle>
- <function>XNPV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>XNPV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>XIRR</function>(<parameter>values</parameter>,<parameter>dates</parameter>,<parameter>guess</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>XIRR</function> calculates the annualized internal rate of return of a cash flow at arbitrary points in time. <parameter>values</parameter> lists the payments (negative values) and receipts (positive values) with one value for each entry in <parameter>dates</parameter>.</para>
+ <para><parameter>values</parameter>: cash flow</para>
+ <para><parameter>dates</parameter>: dates of cash flow</para>
+ <para><parameter>guess</parameter>: an estimate of what the result should be</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The optional <parameter>guess</parameter> is needed because there can be more than one valid result. It defaults to 10%.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IRR"><function>IRR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-XNPV">
+ <refmeta>
+ <refentrytitle>
+ <function>XNPV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>XNPV</function>
+ </refname>
+ <refpurpose>
net present value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>XNPV</function>(<parameter>rate</parameter>,<parameter>values</parameter>,<parameter>dates</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>XNPV</function> calculates the net present value of a cash flow at irregular times</para>
- <para><parameter>rate</parameter>: effective annual interest rate</para>
- <para><parameter>values</parameter>: cash flow</para>
- <para><parameter>dates</parameter>: dates of cash flow</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NPV"><function>NPV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-YIELD">
- <refmeta>
- <refentrytitle>
- <function>YIELD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>YIELD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>XNPV</function>(<parameter>rate</parameter>,<parameter>values</parameter>,<parameter>dates</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>XNPV</function> calculates the net present value of a cash flow at irregular times</para>
+ <para><parameter>rate</parameter>: effective annual interest rate</para>
+ <para><parameter>values</parameter>: cash flow</para>
+ <para><parameter>dates</parameter>: dates of cash flow</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is 0, the default, payment is at the end of each period. If <parameter>type</parameter> is 1, payment is at the beginning of each period.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NPV"><function>NPV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-YIELD">
+ <refmeta>
+ <refentrytitle>
+ <function>YIELD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>YIELD</function>
+ </refname>
+ <refpurpose>
yield of a security
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>YIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>YIELD</function> calculates the yield of a security that pays periodic interest.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>price</parameter>: price of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>frequency</parameter>: number of interest payments per year</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PRICE"><function>PRICE</function></link>,
- <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-YIELDDISC">
- <refmeta>
- <refentrytitle>
- <function>YIELDDISC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>YIELDDISC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>YIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>YIELD</function> calculates the yield of a security that pays periodic interest.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>price</parameter>: price of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>frequency</parameter>: number of interest payments per year</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>frequency</parameter> may be 1 (annual), 2 (semi-annual), or 4 (quarterly).</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PRICE"><function>PRICE</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-YIELDDISC">
+ <refmeta>
+ <refentrytitle>
+ <function>YIELDDISC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>YIELDDISC</function>
+ </refname>
+ <refpurpose>
yield of a discounted security
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>YIELDDISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>YIELDDISC</function> calculates the yield of a discounted security.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>price</parameter>: price of security</para>
- <para><parameter>redemption</parameter>: amount received at maturity</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PRICE"><function>PRICE</function></link>,
- <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-YIELDMAT">
- <refmeta>
- <refentrytitle>
- <function>YIELDMAT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>YIELDMAT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>YIELDDISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>price</parameter>,<parameter>redemption</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>YIELDDISC</function> calculates the yield of a discounted security.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>price</parameter>: price of security</para>
+ <para><parameter>redemption</parameter>: amount received at maturity</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PRICE"><function>PRICE</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-YIELDMAT">
+ <refmeta>
+ <refentrytitle>
+ <function>YIELDMAT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>YIELDMAT</function>
+ </refname>
+ <refpurpose>
yield of a security
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>YIELDMAT</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>basis</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>YIELDMAT</function> calculates the yield of a security for which the interest is paid at maturity date.</para>
- <para><parameter>settlement</parameter>: settlement date</para>
- <para><parameter>maturity</parameter>: maturity date</para>
- <para><parameter>issue</parameter>: date of issue</para>
- <para><parameter>rate</parameter>: nominal annual interest rate</para>
- <para><parameter>price</parameter>: price of security</para>
- <para><parameter>basis</parameter>: calendar basis</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-YIELDDISC"><function>YIELDDISC</function></link>,
- <link linkend="gnumeric-YIELD"><function>YIELD</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>YIELDMAT</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>basis</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>YIELDMAT</function> calculates the yield of a security for which the interest is paid at maturity date.</para>
+ <para><parameter>settlement</parameter>: settlement date</para>
+ <para><parameter>maturity</parameter>: maturity date</para>
+ <para><parameter>issue</parameter>: date of issue</para>
+ <para><parameter>rate</parameter>: nominal annual interest rate</para>
+ <para><parameter>price</parameter>: price of security</para>
+ <para><parameter>basis</parameter>: calendar basis</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 0, then the US 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 1, then actual number of days is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 2, then actual number of days is used within a month, but years are considered only 360 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 3, then actual number of days is used within a month, but years are always considered 365 days.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>basis</parameter> is 4, then the European 30/360 method is used.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-YIELDDISC"><function>YIELDDISC</function></link>,
+ <link linkend="gnumeric-YIELD"><function>YIELD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Gnumeric">
<title>Gnumeric</title>
<refentry id="gnumeric-GNUMERIC_VERSION">
@@ -7884,23 +7884,23 @@
<function>GNUMERIC_VERSION</function>
</refname>
<refpurpose>
- the current version of GNumeric
- </refpurpose>
+ the current version of GNumeric
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GNUMERIC_VERSION</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>GNUMERIC_VERSION</function> returns the version of gnumeric as a string.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ </para>
+ </refsect1>
</refentry>
</sect1>
- <refsynopsisdiv>
- <synopsis><function>GNUMERIC_VERSION</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GNUMERIC_VERSION</function> returns the version of gnumeric as a string.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
<sect1 id="CATEGORY_Information">
<title>Information</title>
<refentry id="gnumeric-CELL">
@@ -7914,683 +7914,683 @@
<function>CELL</function>
</refname>
<refpurpose>
- information of <parameter>type</parameter> about <parameter>cell</parameter>
- </refpurpose>
+ information of <parameter>type</parameter> about <parameter>cell</parameter>
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CELL</function>(<parameter>type</parameter>,<parameter>cell</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>type</parameter> specifies the type of information you want to obtain:</para>
+ <para> address Returns the given cell reference as text.</para>
+ <para> col Returns the number of the column in <parameter>cell</parameter>.</para>
+ <para> color Returns 0.</para>
+ <para> contents Returns the contents of the cell in <parameter>cell</parameter>.</para>
+ <para> column Returns the number of the column in <parameter>cell</parameter>.</para>
+ <para> columnwidth Returns the column width.</para>
+ <para> coord Returns the absolute address of <parameter>cell</parameter>.</para>
+ <para> datatype same as type</para>
+ <para> filename Returns the name of the file of <parameter>cell</parameter>.</para>
+ <para> format Returns the code of the format of the cell.</para>
+ <para> formulatype same as type</para>
+ <para> locked Returns 1 if <parameter>cell</parameter> is locked.</para>
+ <para> parentheses Returns 1 if <parameter>cell</parameter> contains a negative value</para>
+ <para> and its format displays it with parentheses.</para>
+ <para> prefix Returns a character indicating the horizontal</para>
+ <para> alignment of <parameter>cell</parameter>.</para>
+ <para> prefixcharacter same as prefix</para>
+ <para> protect Returns 1 if <parameter>cell</parameter> is locked.</para>
+ <para> row Returns the number of the row in <parameter>cell</parameter>.</para>
+ <para> sheetname Returns the name of the sheet of <parameter>cell</parameter>.</para>
+ <para> type Returns "l" if <parameter>cell</parameter> contains a string, </para>
+ <para> "v" if it contains some other value, and </para>
+ <para> "b" if <parameter>cell</parameter> is blank.</para>
+ <para> value Returns the contents of the cell in <parameter>cell</parameter>.</para>
+ <para> width Returns the column width.</para>
+ <para><parameter>type</parameter>: string specifying the type of information requested</para>
+ <para><parameter>cell</parameter>: cell reference</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-INDIRECT"><function>INDIRECT</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>CELL</function>(<parameter>type</parameter>,<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>type</parameter> specifies the type of information you want to obtain:</para>
- <para> address Returns the given cell reference as text.</para>
- <para> col Returns the number of the column in <parameter>cell</parameter>.</para>
- <para> color Returns 0.</para>
- <para> contents Returns the contents of the cell in <parameter>cell</parameter>.</para>
- <para> column Returns the number of the column in <parameter>cell</parameter>.</para>
- <para> columnwidth Returns the column width.</para>
- <para> coord Returns the absolute address of <parameter>cell</parameter>.</para>
- <para> datatype same as type</para>
- <para> filename Returns the name of the file of <parameter>cell</parameter>.</para>
- <para> format Returns the code of the format of the cell.</para>
- <para> formulatype same as type</para>
- <para> locked Returns 1 if <parameter>cell</parameter> is locked.</para>
- <para> parentheses Returns 1 if <parameter>cell</parameter> contains a negative value</para>
- <para> and its format displays it with parentheses.</para>
- <para> prefix Returns a character indicating the horizontal</para>
- <para> alignment of <parameter>cell</parameter>.</para>
- <para> prefixcharacter same as prefix</para>
- <para> protect Returns 1 if <parameter>cell</parameter> is locked.</para>
- <para> row Returns the number of the row in <parameter>cell</parameter>.</para>
- <para> sheetname Returns the name of the sheet of <parameter>cell</parameter>.</para>
- <para> type Returns "l" if <parameter>cell</parameter> contains a string, </para>
- <para> "v" if it contains some other value, and </para>
- <para> "b" if <parameter>cell</parameter> is blank.</para>
- <para> value Returns the contents of the cell in <parameter>cell</parameter>.</para>
- <para> width Returns the column width.</para>
- <para><parameter>type</parameter>: string specifying the type of information requested</para>
- <para><parameter>cell</parameter>: cell reference</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INDIRECT"><function>INDIRECT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUNTBLANK">
- <refmeta>
- <refentrytitle>
- <function>COUNTBLANK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUNTBLANK</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-COUNTBLANK">
+ <refmeta>
+ <refentrytitle>
+ <function>COUNTBLANK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUNTBLANK</function>
+ </refname>
+ <refpurpose>
the number of blank cells in <parameter>range</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COUNTBLANK</function>(<parameter>range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>range</parameter>: a cell range</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ERROR">
- <refmeta>
- <refentrytitle>
- <function>ERROR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ERROR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COUNTBLANK</function>(<parameter>range</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>range</parameter>: a cell range</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ERROR">
+ <refmeta>
+ <refentrytitle>
+ <function>ERROR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ERROR</function>
+ </refname>
+ <refpurpose>
the error with name <parameter>text</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ERROR</function>(<parameter>name</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>name</parameter>: string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ERROR.TYPE">
- <refmeta>
- <refentrytitle>
- <function>ERROR.TYPE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ERROR.TYPE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ERROR</function>(<parameter>name</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>name</parameter>: string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ERROR.TYPE">
+ <refmeta>
+ <refentrytitle>
+ <function>ERROR.TYPE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ERROR.TYPE</function>
+ </refname>
+ <refpurpose>
the type of <parameter>error</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ERROR.TYPE</function>(<parameter>error</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ERROR.TYPE</function> returns an error number corresponding to the given error value. The error numbers for error values are:</para>
- <para/>
- <para> #DIV/0! 2</para>
- <para> #VALUE! 3</para>
- <para> #REF! 4</para>
- <para> #NAME? 5</para>
- <para> #NUM! 6</para>
- <para> #N/A 7</para>
- <para><parameter>error</parameter>: an error</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EXPRESSION">
- <refmeta>
- <refentrytitle>
- <function>EXPRESSION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EXPRESSION</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ERROR.TYPE</function>(<parameter>error</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ERROR.TYPE</function> returns an error number corresponding to the given error value. The error numbers for error values are:</para>
+ <para/>
+ <para> #DIV/0! 2</para>
+ <para> #VALUE! 3</para>
+ <para> #REF! 4</para>
+ <para> #NAME? 5</para>
+ <para> #NUM! 6</para>
+ <para> #N/A 7</para>
+ <para><parameter>error</parameter>: an error</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EXPRESSION">
+ <refmeta>
+ <refentrytitle>
+ <function>EXPRESSION</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EXPRESSION</function>
+ </refname>
+ <refpurpose>
expression in <parameter>cell</parameter> as a string
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EXPRESSION</function>(<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>cell</parameter>: a cell reference</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>cell</parameter> contains no expression, <function>EXPRESSION</function> returns empty.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TEXT"><function>TEXT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GET.FORMULA">
- <refmeta>
- <refentrytitle>
- <function>GET.FORMULA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GET.FORMULA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EXPRESSION</function>(<parameter>cell</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>cell</parameter>: a cell reference</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>cell</parameter> contains no expression, <function>EXPRESSION</function> returns empty.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TEXT"><function>TEXT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GET.FORMULA">
+ <refmeta>
+ <refentrytitle>
+ <function>GET.FORMULA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GET.FORMULA</function>
+ </refname>
+ <refpurpose>
The formula in <parameter>cell</parameter> as a string.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXPRESSION"><function>EXPRESSION</function></link>,
- <link linkend="gnumeric-ISFORMULA"><function>ISFORMULA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>GET.FORMULA</function>(<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>cell</parameter>: the referenced cell</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-GET.LINK">
- <refmeta>
- <refentrytitle>
- <function>GET.LINK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GET.LINK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXPRESSION"><function>EXPRESSION</function></link>,
+ <link linkend="gnumeric-ISFORMULA"><function>ISFORMULA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>GET.FORMULA</function>(<parameter>cell</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>cell</parameter>: the referenced cell</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GET.LINK">
+ <refmeta>
+ <refentrytitle>
+ <function>GET.LINK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GET.LINK</function>
+ </refname>
+ <refpurpose>
The target of the hyperlink attached to <parameter>cell</parameter> as a string.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GET.LINK</function>(<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>cell</parameter>: the referenced cell</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The value return is not updated automatically when the link attached to <parameter>cell</parameter> changes but requires a recalculation.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HYPERLINK"><function>HYPERLINK</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GETENV">
- <refmeta>
- <refentrytitle>
- <function>GETENV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GETENV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GET.LINK</function>(<parameter>cell</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>cell</parameter>: the referenced cell</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The value return is not updated automatically when the link attached to <parameter>cell</parameter> changes but requires a recalculation.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HYPERLINK"><function>HYPERLINK</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GETENV">
+ <refmeta>
+ <refentrytitle>
+ <function>GETENV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GETENV</function>
+ </refname>
+ <refpurpose>
the value of execution environment varaible <parameter>name</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GETENV</function>(<parameter>name</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>name</parameter>: the name of the environment variable</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If a variable called <parameter>name</parameter> does not exist, #N/A! will be returned.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Variable names are case sensitive.</para>
- </refsect1>
- <refentry id="gnumeric-INFO">
- <refmeta>
- <refentrytitle>
- <function>INFO</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INFO</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GETENV</function>(<parameter>name</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>name</parameter>: the name of the environment variable</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If a variable called <parameter>name</parameter> does not exist, #N/A! will be returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Variable names are case sensitive.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INFO">
+ <refmeta>
+ <refentrytitle>
+ <function>INFO</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INFO</function>
+ </refname>
+ <refpurpose>
information about the current operating environment according to <parameter>type</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INFO</function>(<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>INFO</function> returns information about the current operating environment according to <parameter>type</parameter>:</para>
- <para> memavail Returns the amount of memory available, bytes.</para>
- <para> memused Returns the amount of memory used (bytes).</para>
- <para> numfile Returns the number of active worksheets.</para>
- <para> osversion Returns the operating system version.</para>
- <para> recalc Returns the recalculation mode (automatic).</para>
- <para> release Returns the version of Gnumeric as text.</para>
- <para> system Returns the name of the environment.</para>
- <para> totmem Returns the amount of total memory available.</para>
- <para><parameter>type</parameter>: string giving the type of information requested</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CELL"><function>CELL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ISBLANK">
- <refmeta>
- <refentrytitle>
- <function>ISBLANK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISBLANK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INFO</function>(<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>INFO</function> returns information about the current operating environment according to <parameter>type</parameter>:</para>
+ <para> memavail Returns the amount of memory available, bytes.</para>
+ <para> memused Returns the amount of memory used (bytes).</para>
+ <para> numfile Returns the number of active worksheets.</para>
+ <para> osversion Returns the operating system version.</para>
+ <para> recalc Returns the recalculation mode (automatic).</para>
+ <para> release Returns the version of Gnumeric as text.</para>
+ <para> system Returns the name of the environment.</para>
+ <para> totmem Returns the amount of total memory available.</para>
+ <para><parameter>type</parameter>: string giving the type of information requested</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CELL"><function>CELL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISBLANK">
+ <refmeta>
+ <refentrytitle>
+ <function>ISBLANK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISBLANK</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is blank.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISBLANK</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function checks if a value is blank. Empty cells are blank, but empty strings are not.</para>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- <refentry id="gnumeric-ISERR">
- <refmeta>
- <refentrytitle>
- <function>ISERR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISERR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISBLANK</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function checks if a value is blank. Empty cells are blank, but empty strings are not.</para>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISERR">
+ <refmeta>
+ <refentrytitle>
+ <function>ISERR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISERR</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is any error value except #N/A
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISERR</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISERROR">
- <refmeta>
- <refentrytitle>
- <function>ISERROR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISERROR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISERR</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISERROR">
+ <refmeta>
+ <refentrytitle>
+ <function>ISERROR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISERROR</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is any error value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISERR"><function>ISERR</function></link>,
- <link linkend="gnumeric-ISNA"><function>ISNA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISERROR</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISEVEN">
- <refmeta>
- <refentrytitle>
- <function>ISEVEN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISEVEN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISERR"><function>ISERR</function></link>,
+ <link linkend="gnumeric-ISNA"><function>ISNA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISERROR</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISEVEN">
+ <refmeta>
+ <refentrytitle>
+ <function>ISEVEN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISEVEN</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>n</parameter> is even.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISODD"><function>ISODD</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISEVEN</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISFORMULA">
- <refmeta>
- <refentrytitle>
- <function>ISFORMULA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISFORMULA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISODD"><function>ISODD</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISEVEN</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISFORMULA">
+ <refmeta>
+ <refentrytitle>
+ <function>ISFORMULA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISFORMULA</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>cell</parameter> contains a formula.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GET.FORMULA"><function>GET.FORMULA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISFORMULA</function>(<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>cell</parameter>: the referenced cell</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISLOGICAL">
- <refmeta>
- <refentrytitle>
- <function>ISLOGICAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISLOGICAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GET.FORMULA"><function>GET.FORMULA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISFORMULA</function>(<parameter>cell</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>cell</parameter>: the referenced cell</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISLOGICAL">
+ <refmeta>
+ <refentrytitle>
+ <function>ISLOGICAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISLOGICAL</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is a logical value.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISLOGICAL</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function checks if a value is either TRUE or FALSE.</para>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- <refentry id="gnumeric-ISNA">
- <refmeta>
- <refentrytitle>
- <function>ISNA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISNA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISLOGICAL</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function checks if a value is either TRUE or FALSE.</para>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISNA">
+ <refmeta>
+ <refentrytitle>
+ <function>ISNA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISNA</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is the #N/A error value.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NA"><function>NA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISNA</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISNONTEXT">
- <refmeta>
- <refentrytitle>
- <function>ISNONTEXT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISNONTEXT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NA"><function>NA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISNA</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISNONTEXT">
+ <refmeta>
+ <refentrytitle>
+ <function>ISNONTEXT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISNONTEXT</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is not text.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISTEXT"><function>ISTEXT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISNONTEXT</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISNUMBER">
- <refmeta>
- <refentrytitle>
- <function>ISNUMBER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISNUMBER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISTEXT"><function>ISTEXT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISNONTEXT</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISNUMBER">
+ <refmeta>
+ <refentrytitle>
+ <function>ISNUMBER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISNUMBER</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is a number.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISNUMBER</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function checks if a value is a number. Neither TRUE nor FALSE are numbers for this purpose.</para>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- <refentry id="gnumeric-ISODD">
- <refmeta>
- <refentrytitle>
- <function>ISODD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISODD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISNUMBER</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function checks if a value is a number. Neither TRUE nor FALSE are numbers for this purpose.</para>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISODD">
+ <refmeta>
+ <refentrytitle>
+ <function>ISODD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISODD</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>n</parameter> is odd.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISEVEN"><function>ISEVEN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISODD</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ISREF">
- <refmeta>
- <refentrytitle>
- <function>ISREF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISREF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISEVEN"><function>ISEVEN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISODD</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISREF">
+ <refmeta>
+ <refentrytitle>
+ <function>ISREF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISREF</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is a reference.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ISREF</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function checks if a value is a cell reference.</para>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- <refentry id="gnumeric-ISTEXT">
- <refmeta>
- <refentrytitle>
- <function>ISTEXT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ISTEXT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISREF</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function checks if a value is a cell reference.</para>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ISTEXT">
+ <refmeta>
+ <refentrytitle>
+ <function>ISTEXT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISTEXT</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>value</parameter> is text.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISNONTEXT"><function>ISNONTEXT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ISTEXT</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-N">
- <refmeta>
- <refentrytitle>
- <function>N</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>N</function>
- </refname>
- <refpurpose><parameter>text</parameter> converted to a number
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>N</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>text</parameter> contains non-numerical text, 0 is returned.</para>
- </refsect1>
- <refentry id="gnumeric-NA">
- <refmeta>
- <refentrytitle>
- <function>NA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISNONTEXT"><function>ISNONTEXT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ISTEXT</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-N">
+ <refmeta>
+ <refentrytitle>
+ <function>N</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>N</function>
+ </refname>
+ <refpurpose><parameter>text</parameter> converted to a number
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>N</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>text</parameter> contains non-numerical text, 0 is returned.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NA">
+ <refmeta>
+ <refentrytitle>
+ <function>NA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NA</function>
+ </refname>
+ <refpurpose>
the error value #N/A
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ISNA"><function>ISNA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>NA</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-TYPE">
- <refmeta>
- <refentrytitle>
- <function>TYPE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TYPE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ISNA"><function>ISNA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>NA</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TYPE">
+ <refmeta>
+ <refentrytitle>
+ <function>TYPE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TYPE</function>
+ </refname>
+ <refpurpose>
a number indicating the data type of <parameter>value</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TYPE</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TYPE</function> returns a number indicating the data type of @{ value}:</para>
- <para>1 = number</para>
- <para>2 = text</para>
- <para>4 = boolean</para>
- <para>16 = error</para>
- <para>64 = array</para>
- <para><parameter>value</parameter>: a value</para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TYPE</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>TYPE</function> returns a number indicating the data type of @{ value}:</para>
+ <para>1 = number</para>
+ <para>2 = text</para>
+ <para>4 = boolean</para>
+ <para>16 = error</para>
+ <para>64 = array</para>
+ <para><parameter>value</parameter>: a value</para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Logic">
<title>Logic</title>
<refentry id="gnumeric-AND">
@@ -8604,327 +8604,327 @@
<function>AND</function>
</refname>
<refpurpose>
- logical conjunction
- </refpurpose>
+ logical conjunction
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>AND</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>AND</function> calculates the logical conjunction of its arguments <parameter>b0</parameter>,<parameter>b1</parameter>,...</para>
+ <para><parameter>b0</parameter>: logical value</para>
+ <para><parameter>b1</parameter>: logical value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If an argument is numerical, zero is considered FALSE and anything else TRUE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Strings and empty values are ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If no logical values are provided, then the error #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function is strict: if any argument is an error, the result will be the first such error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OR"><function>OR</function></link>,
+ <link linkend="gnumeric-NOT"><function>NOT</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>AND</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>AND</function> calculates the logical conjunction of its arguments <parameter>b0</parameter>,<parameter>b1</parameter>,...</para>
- <para><parameter>b0</parameter>: logical value</para>
- <para><parameter>b1</parameter>: logical value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If an argument is numerical, zero is considered FALSE and anything else TRUE.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Strings and empty values are ignored.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If no logical values are provided, then the error #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function is strict: if any argument is an error, the result will be the first such error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OR"><function>OR</function></link>,
- <link linkend="gnumeric-NOT"><function>NOT</function></link>,
- <link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FALSE">
- <refmeta>
- <refentrytitle>
- <function>FALSE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FALSE</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-FALSE">
+ <refmeta>
+ <refentrytitle>
+ <function>FALSE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FALSE</function>
+ </refname>
+ <refpurpose>
the value <function>FALSE</function>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FALSE</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FALSE</function> returns the value <function>FALSE</function>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TRUE"><function>TRUE</function></link>,
- <link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IF">
- <refmeta>
- <refentrytitle>
- <function>IF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FALSE</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>FALSE</function> returns the value <function>FALSE</function>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TRUE"><function>TRUE</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IF">
+ <refmeta>
+ <refentrytitle>
+ <function>IF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IF</function>
+ </refname>
+ <refpurpose>
conditional expression.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IF</function>(<parameter>cond</parameter>,<parameter>trueval</parameter>,<parameter>falseval</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function first evaluates the condition. If the result is true, it will then evaluate and return the second argument. Otherwise, it will evaluate and return the last argument.</para>
- <para><parameter>cond</parameter>: condition.</para>
- <para><parameter>trueval</parameter>: value to use if condition is true.</para>
- <para><parameter>falseval</parameter>: value to use if condition is false.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AND"><function>AND</function></link>,
- <link linkend="gnumeric-OR"><function>OR</function></link>,
- <link linkend="gnumeric-XOR"><function>XOR</function></link>,
- <link linkend="gnumeric-NOT"><function>NOT</function></link>,
- <link linkend="gnumeric-IFERROR"><function>IFERROR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IFERROR">
- <refmeta>
- <refentrytitle>
- <function>IFERROR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IFERROR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IF</function>(<parameter>cond</parameter>,<parameter>trueval</parameter>,<parameter>falseval</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function first evaluates the condition. If the result is true, it will then evaluate and return the second argument. Otherwise, it will evaluate and return the last argument.</para>
+ <para><parameter>cond</parameter>: condition.</para>
+ <para><parameter>trueval</parameter>: value to use if condition is true.</para>
+ <para><parameter>falseval</parameter>: value to use if condition is false.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AND"><function>AND</function></link>,
+ <link linkend="gnumeric-OR"><function>OR</function></link>,
+ <link linkend="gnumeric-XOR"><function>XOR</function></link>,
+ <link linkend="gnumeric-NOT"><function>NOT</function></link>,
+ <link linkend="gnumeric-IFERROR"><function>IFERROR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IFERROR">
+ <refmeta>
+ <refentrytitle>
+ <function>IFERROR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IFERROR</function>
+ </refname>
+ <refpurpose>
Test for error.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IFERROR</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the first value, unless that is an error, in which case it returns the second.</para>
- <para><parameter>x</parameter>: value to test for error.</para>
- <para><parameter>y</parameter>: alternate value.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IF"><function>IF</function></link>,
- <link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-IFNA">
- <refmeta>
- <refentrytitle>
- <function>IFNA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>IFNA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IFERROR</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the first value, unless that is an error, in which case it returns the second.</para>
+ <para><parameter>x</parameter>: value to test for error.</para>
+ <para><parameter>y</parameter>: alternate value.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IF"><function>IF</function></link>,
+ <link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-IFNA">
+ <refmeta>
+ <refentrytitle>
+ <function>IFNA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IFNA</function>
+ </refname>
+ <refpurpose>
Test for #NA! error.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>IFNA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the first value, unless that is #NA!, in which case it returns the second.</para>
- <para><parameter>x</parameter>: value to test for #NA! error.</para>
- <para><parameter>y</parameter>: alternate value.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IF"><function>IF</function></link>,
- <link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NOT">
- <refmeta>
- <refentrytitle>
- <function>NOT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NOT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IFNA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the first value, unless that is #NA!, in which case it returns the second.</para>
+ <para><parameter>x</parameter>: value to test for #NA! error.</para>
+ <para><parameter>y</parameter>: alternate value.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IF"><function>IF</function></link>,
+ <link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NOT">
+ <refmeta>
+ <refentrytitle>
+ <function>NOT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NOT</function>
+ </refname>
+ <refpurpose>
logical negation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NOT</function>(<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NOT</function> calculates the logical negation of its argument.</para>
- <para><parameter>b</parameter>: logical value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the argument is numerical, zero is considered FALSE and anything else TRUE.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Strings and empty values are ignored.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AND"><function>AND</function></link>,
- <link linkend="gnumeric-OR"><function>OR</function></link>,
- <link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OR">
- <refmeta>
- <refentrytitle>
- <function>OR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NOT</function>(<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NOT</function> calculates the logical negation of its argument.</para>
+ <para><parameter>b</parameter>: logical value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the argument is numerical, zero is considered FALSE and anything else TRUE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Strings and empty values are ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AND"><function>AND</function></link>,
+ <link linkend="gnumeric-OR"><function>OR</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OR">
+ <refmeta>
+ <refentrytitle>
+ <function>OR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OR</function>
+ </refname>
+ <refpurpose>
logical disjunction
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OR</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OR</function> calculates the logical disjunction of its arguments <parameter>b0</parameter>,<parameter>b1</parameter>,...</para>
- <para><parameter>b0</parameter>: logical value</para>
- <para><parameter>b1</parameter>: logical value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If an argument is numerical, zero is considered FALSE and anything else TRUE.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Strings and empty values are ignored.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If no logical values are provided, then the error #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function is strict: if any argument is an error, the result will be the first such error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AND"><function>AND</function></link>,
- <link linkend="gnumeric-XOR"><function>XOR</function></link>,
- <link linkend="gnumeric-NOT"><function>NOT</function></link>,
- <link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TRUE">
- <refmeta>
- <refentrytitle>
- <function>TRUE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TRUE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OR</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OR</function> calculates the logical disjunction of its arguments <parameter>b0</parameter>,<parameter>b1</parameter>,...</para>
+ <para><parameter>b0</parameter>: logical value</para>
+ <para><parameter>b1</parameter>: logical value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If an argument is numerical, zero is considered FALSE and anything else TRUE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Strings and empty values are ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If no logical values are provided, then the error #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function is strict: if any argument is an error, the result will be the first such error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AND"><function>AND</function></link>,
+ <link linkend="gnumeric-XOR"><function>XOR</function></link>,
+ <link linkend="gnumeric-NOT"><function>NOT</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TRUE">
+ <refmeta>
+ <refentrytitle>
+ <function>TRUE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TRUE</function>
+ </refname>
+ <refpurpose>
the value <function>TRUE</function>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TRUE</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TRUE</function> returns the value <function>TRUE</function>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FALSE"><function>FALSE</function></link>,
- <link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-XOR">
- <refmeta>
- <refentrytitle>
- <function>XOR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>XOR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TRUE</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>TRUE</function> returns the value <function>TRUE</function>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FALSE"><function>FALSE</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-XOR">
+ <refmeta>
+ <refentrytitle>
+ <function>XOR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>XOR</function>
+ </refname>
+ <refpurpose>
logical exclusive disjunction
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>XOR</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>XOR</function> calculates the logical exclusive disjunction of its arguments <parameter>b0</parameter>,<parameter>b1</parameter>,...</para>
- <para><parameter>b0</parameter>: logical value</para>
- <para><parameter>b1</parameter>: logical value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If an argument is numerical, zero is considered FALSE and anything else TRUE.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Strings and empty values are ignored.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If no logical values are provided, then the error #VALUE! is returned.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function is strict: if any argument is an error, the result will be the first such error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-OR"><function>OR</function></link>,
- <link linkend="gnumeric-AND"><function>AND</function></link>,
- <link linkend="gnumeric-NOT"><function>NOT</function></link>,
- <link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>XOR</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>XOR</function> calculates the logical exclusive disjunction of its arguments <parameter>b0</parameter>,<parameter>b1</parameter>,...</para>
+ <para><parameter>b0</parameter>: logical value</para>
+ <para><parameter>b1</parameter>: logical value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If an argument is numerical, zero is considered FALSE and anything else TRUE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Strings and empty values are ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If no logical values are provided, then the error #VALUE! is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function is strict: if any argument is an error, the result will be the first such error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-OR"><function>OR</function></link>,
+ <link linkend="gnumeric-AND"><function>AND</function></link>,
+ <link linkend="gnumeric-NOT"><function>NOT</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Lookup">
<title>Lookup</title>
<refentry id="gnumeric-ADDRESS">
@@ -8938,654 +8938,654 @@
<function>ADDRESS</function>
</refname>
<refpurpose>
- cell address as text
- </refpurpose>
+ cell address as text
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ADDRESS</function>(<parameter>row_num</parameter>,<parameter>col_num</parameter>,<parameter>abs_num</parameter>,<parameter>a1</parameter>,<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>row_num</parameter>: row number</para>
+ <para><parameter>col_num</parameter>: column number</para>
+ <para><parameter>abs_num</parameter>: 1 for an absolute, 2 for a row absolute and column relative, 3 for a row relative and column absolute, and 4 for a relative reference; defaults to 1</para>
+ <para><parameter>a1</parameter>: if TRUE, an A1-style reference is provided, otherwise an R1C1-style reference; defaults to TRUE</para>
+ <para><parameter>text</parameter>: name of the worksheet, defaults to no sheet</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>row_num</parameter> or <parameter>col_num</parameter> is less than one, <function>ADDRESS</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>abs_num</parameter> is greater than 4 <function>ADDRESS</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMNNUMBER"><function>COLUMNNUMBER</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ADDRESS</function>(<parameter>row_num</parameter>,<parameter>col_num</parameter>,<parameter>abs_num</parameter>,<parameter>a1</parameter>,<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>row_num</parameter>: row number</para>
- <para><parameter>col_num</parameter>: column number</para>
- <para><parameter>abs_num</parameter>: 1 for an absolute, 2 for a row absolute and column relative, 3 for a row relative and column absolute, and 4 for a relative reference; defaults to 1</para>
- <para><parameter>a1</parameter>: if TRUE, an A1-style reference is provided, otherwise an R1C1-style reference; defaults to TRUE</para>
- <para><parameter>text</parameter>: name of the worksheet, defaults to no sheet</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>row_num</parameter> or <parameter>col_num</parameter> is less than one, <function>ADDRESS</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>abs_num</parameter> is greater than 4 <function>ADDRESS</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMNNUMBER"><function>COLUMNNUMBER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-AREAS">
- <refmeta>
- <refentrytitle>
- <function>AREAS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AREAS</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-AREAS">
+ <refmeta>
+ <refentrytitle>
+ <function>AREAS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AREAS</function>
+ </refname>
+ <refpurpose>
number of areas in <parameter>reference</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>,
- <link linkend="gnumeric-INDEX"><function>INDEX</function></link>,
- <link linkend="gnumeric-INDIRECT"><function>INDIRECT</function></link>,
- <link linkend="gnumeric-OFFSET"><function>OFFSET</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>AREAS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>reference</parameter>: range</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-CHOOSE">
- <refmeta>
- <refentrytitle>
- <function>CHOOSE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CHOOSE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>,
+ <link linkend="gnumeric-INDEX"><function>INDEX</function></link>,
+ <link linkend="gnumeric-INDIRECT"><function>INDIRECT</function></link>,
+ <link linkend="gnumeric-OFFSET"><function>OFFSET</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>AREAS</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>reference</parameter>: range</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CHOOSE">
+ <refmeta>
+ <refentrytitle>
+ <function>CHOOSE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CHOOSE</function>
+ </refname>
+ <refpurpose>
the (<parameter>index</parameter>+1)th argument
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CHOOSE</function>(<parameter>index</parameter>,<parameter>value1</parameter>,<parameter>value2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CHOOSE</function> returns its (<parameter>index</parameter>+1)th argument.</para>
- <para><parameter>index</parameter>: positive number</para>
- <para><parameter>value1</parameter>: first value</para>
- <para><parameter>value2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>index</parameter> is truncated to an integer. If <parameter>index</parameter> < 1 or the truncated <parameter>index</parameter> > number of values, <function>CHOOSE</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-IF"><function>IF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COLUMN">
- <refmeta>
- <refentrytitle>
- <function>COLUMN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COLUMN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CHOOSE</function>(<parameter>index</parameter>,<parameter>value1</parameter>,<parameter>value2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CHOOSE</function> returns its (<parameter>index</parameter>+1)th argument.</para>
+ <para><parameter>index</parameter>: positive number</para>
+ <para><parameter>value1</parameter>: first value</para>
+ <para><parameter>value2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>index</parameter> is truncated to an integer. If <parameter>index</parameter> < 1 or the truncated <parameter>index</parameter> > number of values, <function>CHOOSE</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IF"><function>IF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COLUMN">
+ <refmeta>
+ <refentrytitle>
+ <function>COLUMN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COLUMN</function>
+ </refname>
+ <refpurpose>
vector of column numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COLUMN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COLUMN</function> function returns a Nx1 array containing the sequence of integers from the first column to the last column of <parameter>reference</parameter>.</para>
- <para><parameter>x</parameter>: reference, defaults to the position of the current expression</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
- <link linkend="gnumeric-ROW"><function>ROW</function></link>,
- <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COLUMNNUMBER">
- <refmeta>
- <refentrytitle>
- <function>COLUMNNUMBER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COLUMNNUMBER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COLUMN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COLUMN</function> function returns a Nx1 array containing the sequence of integers from the first column to the last column of <parameter>reference</parameter>.</para>
+ <para><parameter>x</parameter>: reference, defaults to the position of the current expression</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
+ <link linkend="gnumeric-ROW"><function>ROW</function></link>,
+ <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COLUMNNUMBER">
+ <refmeta>
+ <refentrytitle>
+ <function>COLUMNNUMBER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COLUMNNUMBER</function>
+ </refname>
+ <refpurpose>
column number for the given column called <parameter>name</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COLUMNNUMBER</function>(<parameter>name</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>name</parameter>: column name such as "IV"</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>name</parameter> is invalid, <function>COLUMNNUMBER</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COLUMNS">
- <refmeta>
- <refentrytitle>
- <function>COLUMNS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COLUMNS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COLUMNNUMBER</function>(<parameter>name</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>name</parameter>: column name such as "IV"</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>name</parameter> is invalid, <function>COLUMNNUMBER</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COLUMNS">
+ <refmeta>
+ <refentrytitle>
+ <function>COLUMNS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COLUMNS</function>
+ </refname>
+ <refpurpose>
number of columns in <parameter>reference</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COLUMNS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>reference</parameter>: array or area</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>COLUMNS</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
- <link linkend="gnumeric-ROW"><function>ROW</function></link>,
- <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HLOOKUP">
- <refmeta>
- <refentrytitle>
- <function>HLOOKUP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HLOOKUP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COLUMNS</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>reference</parameter>: array or area</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>COLUMNS</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
+ <link linkend="gnumeric-ROW"><function>ROW</function></link>,
+ <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HLOOKUP">
+ <refmeta>
+ <refentrytitle>
+ <function>HLOOKUP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HLOOKUP</function>
+ </refname>
+ <refpurpose>
search the first row of <parameter>range</parameter> for <parameter>value</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HLOOKUP</function>(<parameter>value</parameter>,<parameter>range</parameter>,<parameter>row</parameter>,<parameter>approximate</parameter>,<parameter>as_index</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>HLOOKUP</function> function finds the row in <parameter>range</parameter> that has a first cell similar to <parameter>value</parameter>. If <parameter>approximate</parameter> is not true it finds the row with an exact equality. If <parameter>approximate</parameter> is true, it finds the last row with first value less than or equal to <parameter>value</parameter>. If <parameter>as_index</parameter> is true the 0-based row offset is returned.</para>
- <para><parameter>value</parameter>: search value</para>
- <para><parameter>range</parameter>: range to search</para>
- <para><parameter>row</parameter>: 1-based column offset indicating the return values </para>
- <para><parameter>approximate</parameter>: if false, an exact match of <parameter>value</parameter> must be found; defaults to TRUE</para>
- <para><parameter>as_index</parameter>: if true, the 0-based row offset is returned; defaults to FALSE</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>approximate</parameter> is true, then the values must be sorted in order of ascending value.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><function>HLOOKUP</function> returns #REF! if <parameter>row</parameter> falls outside <parameter>range</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VLOOKUP"><function>VLOOKUP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HYPERLINK">
- <refmeta>
- <refentrytitle>
- <function>HYPERLINK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HYPERLINK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HLOOKUP</function>(<parameter>value</parameter>,<parameter>range</parameter>,<parameter>row</parameter>,<parameter>approximate</parameter>,<parameter>as_index</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>HLOOKUP</function> function finds the row in <parameter>range</parameter> that has a first cell similar to <parameter>value</parameter>. If <parameter>approximate</parameter> is not true it finds the row with an exact equality. If <parameter>approximate</parameter> is true, it finds the last row with first value less than or equal to <parameter>value</parameter>. If <parameter>as_index</parameter> is true the 0-based row offset is returned.</para>
+ <para><parameter>value</parameter>: search value</para>
+ <para><parameter>range</parameter>: range to search</para>
+ <para><parameter>row</parameter>: 1-based column offset indicating the return values </para>
+ <para><parameter>approximate</parameter>: if false, an exact match of <parameter>value</parameter> must be found; defaults to TRUE</para>
+ <para><parameter>as_index</parameter>: if true, the 0-based row offset is returned; defaults to FALSE</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>approximate</parameter> is true, then the values must be sorted in order of ascending value.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><function>HLOOKUP</function> returns #REF! if <parameter>row</parameter> falls outside <parameter>range</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VLOOKUP"><function>VLOOKUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HYPERLINK">
+ <refmeta>
+ <refentrytitle>
+ <function>HYPERLINK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HYPERLINK</function>
+ </refname>
+ <refpurpose>
second or first arguments
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HYPERLINK</function>(<parameter>link_location</parameter>,<parameter>label</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>HYPERLINK</function> function currently returns its 2nd argument, or if that is omitted the 1st argument.</para>
- <para><parameter>link_location</parameter>: string</para>
- <para><parameter>label</parameter>: string, optional</para>
- </refsect1>
- <refentry id="gnumeric-INDEX">
- <refmeta>
- <refentrytitle>
- <function>INDEX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INDEX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HYPERLINK</function>(<parameter>link_location</parameter>,<parameter>label</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>HYPERLINK</function> function currently returns its 2nd argument, or if that is omitted the 1st argument.</para>
+ <para><parameter>link_location</parameter>: string</para>
+ <para><parameter>label</parameter>: string, optional</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INDEX">
+ <refmeta>
+ <refentrytitle>
+ <function>INDEX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INDEX</function>
+ </refname>
+ <refpurpose>
reference to a cell in the given <parameter>array</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INDEX</function>(<parameter>array</parameter>,<parameter>row</parameter>,<parameter>col</parameter>,<parameter>area</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>INDEX</function> gives a reference to a cell in the given <parameter>array</parameter>. The cell is selected by <parameter>row</parameter> and <parameter>col</parameter>, which count the rows and columns in the array.</para>
- <para><parameter>array</parameter>: </para>
- <para><parameter>row</parameter>: desired row, defaults to 1</para>
- <para><parameter>col</parameter>: desired column, defaults to 1</para>
- <para><parameter>area</parameter>: from which area to select a cell, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the reference falls outside the range of <parameter>array</parameter>, <function>INDEX</function> returns #REF!</para>
- </refsect1>
- <refentry id="gnumeric-INDIRECT">
- <refmeta>
- <refentrytitle>
- <function>INDIRECT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INDIRECT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INDEX</function>(<parameter>array</parameter>,<parameter>row</parameter>,<parameter>col</parameter>,<parameter>area</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>INDEX</function> gives a reference to a cell in the given <parameter>array</parameter>. The cell is selected by <parameter>row</parameter> and <parameter>col</parameter>, which count the rows and columns in the array.</para>
+ <para><parameter>array</parameter>: </para>
+ <para><parameter>row</parameter>: desired row, defaults to 1</para>
+ <para><parameter>col</parameter>: desired column, defaults to 1</para>
+ <para><parameter>area</parameter>: from which area to select a cell, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the reference falls outside the range of <parameter>array</parameter>, <function>INDEX</function> returns #REF!</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INDIRECT">
+ <refmeta>
+ <refentrytitle>
+ <function>INDIRECT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INDIRECT</function>
+ </refname>
+ <refpurpose>
contents of the cell pointed to by the <parameter>ref_text</parameter> string
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INDIRECT</function>(<parameter>ref_text</parameter>,<parameter>format</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>ref_text</parameter>: </para>
- <para><parameter>format</parameter>: if true, <parameter>ref_text</parameter> is given in A1-style, otherwise it is given in R1C1 style; defaults to true</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>ref_text</parameter> is not a valid reference in the style determined by <parameter>format</parameter>, <function>INDIRECT</function> returns #REF!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AREAS"><function>AREAS</function></link>,
- <link linkend="gnumeric-INDEX"><function>INDEX</function></link>,
- <link linkend="gnumeric-CELL"><function>CELL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOOKUP">
- <refmeta>
- <refentrytitle>
- <function>LOOKUP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOOKUP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INDIRECT</function>(<parameter>ref_text</parameter>,<parameter>format</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>ref_text</parameter>: </para>
+ <para><parameter>format</parameter>: if true, <parameter>ref_text</parameter> is given in A1-style, otherwise it is given in R1C1 style; defaults to true</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>ref_text</parameter> is not a valid reference in the style determined by <parameter>format</parameter>, <function>INDIRECT</function> returns #REF!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AREAS"><function>AREAS</function></link>,
+ <link linkend="gnumeric-INDEX"><function>INDEX</function></link>,
+ <link linkend="gnumeric-CELL"><function>CELL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOOKUP">
+ <refmeta>
+ <refentrytitle>
+ <function>LOOKUP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOOKUP</function>
+ </refname>
+ <refpurpose>
contents of <parameter>vector2</parameter> at the corresponding location to <parameter>value</parameter> in <parameter>vector1</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOOKUP</function>(<parameter>value</parameter>,<parameter>vector1</parameter>,<parameter>vector2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>vector1</parameter> has more rows than columns, <function>LOOKUP</function> searches the first row of <parameter>vector1</parameter>, otherwise the first column. If <parameter>vector2</parameter> is omitted the return value is taken from the last row or column of <parameter>vector1</parameter>.</para>
- <para><parameter>value</parameter>: value to look up</para>
- <para><parameter>vector1</parameter>: range to search:</para>
- <para><parameter>vector2</parameter>: range of return values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <function>LOOKUP</function> can't find <parameter>value</parameter> it uses the largest value less than <parameter>value</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The data must be sorted.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>value</parameter> is smaller than the first value it returns #N/A.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the corresponding location does not exist in <parameter>vector2</parameter>, it returns #N/A.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VLOOKUP"><function>VLOOKUP</function></link>,
- <link linkend="gnumeric-HLOOKUP"><function>HLOOKUP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MATCH">
- <refmeta>
- <refentrytitle>
- <function>MATCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MATCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOOKUP</function>(<parameter>value</parameter>,<parameter>vector1</parameter>,<parameter>vector2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>vector1</parameter> has more rows than columns, <function>LOOKUP</function> searches the first row of <parameter>vector1</parameter>, otherwise the first column. If <parameter>vector2</parameter> is omitted the return value is taken from the last row or column of <parameter>vector1</parameter>.</para>
+ <para><parameter>value</parameter>: value to look up</para>
+ <para><parameter>vector1</parameter>: range to search:</para>
+ <para><parameter>vector2</parameter>: range of return values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <function>LOOKUP</function> can't find <parameter>value</parameter> it uses the largest value less than <parameter>value</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The data must be sorted.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>value</parameter> is smaller than the first value it returns #N/A.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the corresponding location does not exist in <parameter>vector2</parameter>, it returns #N/A.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VLOOKUP"><function>VLOOKUP</function></link>,
+ <link linkend="gnumeric-HLOOKUP"><function>HLOOKUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MATCH">
+ <refmeta>
+ <refentrytitle>
+ <function>MATCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MATCH</function>
+ </refname>
+ <refpurpose>
the index of <parameter>seek</parameter> in <parameter>vector</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MATCH</function>(<parameter>seek</parameter>,<parameter>vector</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MATCH</function> searches <parameter>vector</parameter> for <parameter>seek</parameter> and returns the 1-based index.</para>
- <para><parameter>seek</parameter>: value to find</para>
- <para><parameter>vector</parameter>: n by 1 or 1 by n range to be searched</para>
- <para><parameter>type</parameter>: +1 to find the largest value â?¤ <parameter>seek</parameter>, 0 to find the first value = <parameter>seek</parameter>, or-1 to find the smallest value â?¥ <parameter>seek</parameter></para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para> For <parameter>type</parameter> = -1 the data must be sorted in descending order; for <parameter>type</parameter> = +1 the data must be sorted in ascending order.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>seek</parameter> could not be found, #N/A is returned.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>vector</parameter> is neither n by 1 nor 1 by n, #N/A is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOOKUP"><function>LOOKUP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-OFFSET">
- <refmeta>
- <refentrytitle>
- <function>OFFSET</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>OFFSET</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MATCH</function>(<parameter>seek</parameter>,<parameter>vector</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>MATCH</function> searches <parameter>vector</parameter> for <parameter>seek</parameter> and returns the 1-based index.</para>
+ <para><parameter>seek</parameter>: value to find</para>
+ <para><parameter>vector</parameter>: n by 1 or 1 by n range to be searched</para>
+ <para><parameter>type</parameter>: +1 to find the largest value â?¤ <parameter>seek</parameter>, 0 to find the first value = <parameter>seek</parameter>, or-1 to find the smallest value â?¥ <parameter>seek</parameter></para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para> For <parameter>type</parameter> = -1 the data must be sorted in descending order; for <parameter>type</parameter> = +1 the data must be sorted in ascending order.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>seek</parameter> could not be found, #N/A is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>vector</parameter> is neither n by 1 nor 1 by n, #N/A is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOOKUP"><function>LOOKUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-OFFSET">
+ <refmeta>
+ <refentrytitle>
+ <function>OFFSET</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>OFFSET</function>
+ </refname>
+ <refpurpose>
an offset cell range
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>OFFSET</function>(<parameter>range</parameter>,<parameter>row</parameter>,<parameter>col</parameter>,<parameter>height</parameter>,<parameter>width</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OFFSET</function> returns the cell range starting at offset (<parameter>row</parameter>,<parameter>col</parameter>) from <parameter>range</parameter> of height <parameter>height</parameter> and width <parameter>width</parameter>.</para>
- <para><parameter>range</parameter>: reference or range</para>
- <para><parameter>row</parameter>: number of rows to offset <parameter>range</parameter></para>
- <para><parameter>col</parameter>: number of columns to offset <parameter>range</parameter></para>
- <para><parameter>height</parameter>: height of the offset range, defaults to height of <parameter>range</parameter></para>
- <para><parameter>width</parameter>: width of the offset range, defaults to width of <parameter>range</parameter></para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>range</parameter> is neither a reference nor a range, <function>OFFSET</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
- <link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
- <link linkend="gnumeric-ROWS"><function>ROWS</function></link>,
- <link linkend="gnumeric-INDEX"><function>INDEX</function></link>,
- <link linkend="gnumeric-INDIRECT"><function>INDIRECT</function></link>,
- <link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ROW">
- <refmeta>
- <refentrytitle>
- <function>ROW</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ROW</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>OFFSET</function>(<parameter>range</parameter>,<parameter>row</parameter>,<parameter>col</parameter>,<parameter>height</parameter>,<parameter>width</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>OFFSET</function> returns the cell range starting at offset (<parameter>row</parameter>,<parameter>col</parameter>) from <parameter>range</parameter> of height <parameter>height</parameter> and width <parameter>width</parameter>.</para>
+ <para><parameter>range</parameter>: reference or range</para>
+ <para><parameter>row</parameter>: number of rows to offset <parameter>range</parameter></para>
+ <para><parameter>col</parameter>: number of columns to offset <parameter>range</parameter></para>
+ <para><parameter>height</parameter>: height of the offset range, defaults to height of <parameter>range</parameter></para>
+ <para><parameter>width</parameter>: width of the offset range, defaults to width of <parameter>range</parameter></para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>range</parameter> is neither a reference nor a range, <function>OFFSET</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
+ <link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
+ <link linkend="gnumeric-ROWS"><function>ROWS</function></link>,
+ <link linkend="gnumeric-INDEX"><function>INDEX</function></link>,
+ <link linkend="gnumeric-INDIRECT"><function>INDIRECT</function></link>,
+ <link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ROW">
+ <refmeta>
+ <refentrytitle>
+ <function>ROW</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ROW</function>
+ </refname>
+ <refpurpose>
vector of row numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ROW</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ROW</function> function returns a 1xN array containing the sequence of integers from the first row to the last row of <parameter>reference</parameter>.</para>
- <para><parameter>x</parameter>: reference, defaults to the position of the current expression</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
- <link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
- <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ROWS">
- <refmeta>
- <refentrytitle>
- <function>ROWS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ROWS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ROW</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ROW</function> function returns a 1xN array containing the sequence of integers from the first row to the last row of <parameter>reference</parameter>.</para>
+ <para><parameter>x</parameter>: reference, defaults to the position of the current expression</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
+ <link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
+ <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ROWS">
+ <refmeta>
+ <refentrytitle>
+ <function>ROWS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ROWS</function>
+ </refname>
+ <refpurpose>
number of rows in <parameter>reference</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ROWS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>reference</parameter>: array, reference, or range</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>ROWS</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
- <link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
- <link linkend="gnumeric-ROW"><function>ROW</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SHEET">
- <refmeta>
- <refentrytitle>
- <function>SHEET</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SHEET</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ROWS</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>reference</parameter>: array, reference, or range</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>ROWS</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
+ <link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
+ <link linkend="gnumeric-ROW"><function>ROW</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SHEET">
+ <refmeta>
+ <refentrytitle>
+ <function>SHEET</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SHEET</function>
+ </refname>
+ <refpurpose>
sheet number of <parameter>reference</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SHEET</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>reference</parameter>: reference or literal sheet name, defaults to the current sheet</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>reference</parameter> is neither a reference nor a literal sheet name, SHEETS returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SHEETS"><function>SHEETS</function></link>,
- <link linkend="gnumeric-ROW"><function>ROW</function></link>,
- <link linkend="gnumeric-COLUMNNUMBER"><function>COLUMNNUMBER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SHEETS">
- <refmeta>
- <refentrytitle>
- <function>SHEETS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SHEETS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SHEET</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>reference</parameter>: reference or literal sheet name, defaults to the current sheet</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither a reference nor a literal sheet name, SHEETS returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SHEETS"><function>SHEETS</function></link>,
+ <link linkend="gnumeric-ROW"><function>ROW</function></link>,
+ <link linkend="gnumeric-COLUMNNUMBER"><function>COLUMNNUMBER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SHEETS">
+ <refmeta>
+ <refentrytitle>
+ <function>SHEETS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SHEETS</function>
+ </refname>
+ <refpurpose>
number of sheets in <parameter>reference</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SHEETS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>reference</parameter>: array, reference, or range, defaults to the maximum range</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>SHEETS</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
- <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TRANSPOSE">
- <refmeta>
- <refentrytitle>
- <function>TRANSPOSE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TRANSPOSE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SHEETS</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>reference</parameter>: array, reference, or range, defaults to the maximum range</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>SHEETS</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
+ <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TRANSPOSE">
+ <refmeta>
+ <refentrytitle>
+ <function>TRANSPOSE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TRANSPOSE</function>
+ </refname>
+ <refpurpose>
the transpose of <parameter>matrix</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>TRANSPOSE</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>matrix</parameter>: range</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-VLOOKUP">
- <refmeta>
- <refentrytitle>
- <function>VLOOKUP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VLOOKUP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>TRANSPOSE</function>(<parameter>matrix</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>matrix</parameter>: range</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VLOOKUP">
+ <refmeta>
+ <refentrytitle>
+ <function>VLOOKUP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VLOOKUP</function>
+ </refname>
+ <refpurpose>
search the first column of <parameter>range</parameter> for <parameter>value</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>VLOOKUP</function>(<parameter>value</parameter>,<parameter>range</parameter>,<parameter>column</parameter>,<parameter>approximate</parameter>,<parameter>as_index</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VLOOKUP</function> function finds the row in <parameter>range</parameter> that has a first cell similar to <parameter>value</parameter>. If <parameter>approximate</parameter> is not true it finds the row with an exact equality. If <parameter>approximate</parameter> is true, it finds the last row with first value less than or equal to <parameter>value</parameter>. If <parameter>as_index</parameter> is true the 0-based row offset is returned.</para>
- <para><parameter>value</parameter>: search value</para>
- <para><parameter>range</parameter>: range to search</para>
- <para><parameter>column</parameter>: 1-based column offset indicating the return values</para>
- <para><parameter>approximate</parameter>: if false, an exact match of <parameter>value</parameter> must be found; defaults to TRUE</para>
- <para><parameter>as_index</parameter>: if true, the 0-based row offset is returned; defaults to FALSE</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>approximate</parameter> is true, then the values must be sorted in order of ascending value.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><function>VLOOKUP</function> returns #REF! if <parameter>row</parameter> falls outside <parameter>range</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-HLOOKUP"><function>HLOOKUP</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>VLOOKUP</function>(<parameter>value</parameter>,<parameter>range</parameter>,<parameter>column</parameter>,<parameter>approximate</parameter>,<parameter>as_index</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>VLOOKUP</function> function finds the row in <parameter>range</parameter> that has a first cell similar to <parameter>value</parameter>. If <parameter>approximate</parameter> is not true it finds the row with an exact equality. If <parameter>approximate</parameter> is true, it finds the last row with first value less than or equal to <parameter>value</parameter>. If <parameter>as_index</parameter> is true the 0-based row offset is returned.</para>
+ <para><parameter>value</parameter>: search value</para>
+ <para><parameter>range</parameter>: range to search</para>
+ <para><parameter>column</parameter>: 1-based column offset indicating the return values</para>
+ <para><parameter>approximate</parameter>: if false, an exact match of <parameter>value</parameter> must be found; defaults to TRUE</para>
+ <para><parameter>as_index</parameter>: if true, the 0-based row offset is returned; defaults to FALSE</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>approximate</parameter> is true, then the values must be sorted in order of ascending value.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><function>VLOOKUP</function> returns #REF! if <parameter>row</parameter> falls outside <parameter>range</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HLOOKUP"><function>HLOOKUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Mathematics">
<title>Mathematics</title>
<refentry id="gnumeric-ABS">
@@ -9599,2647 +9599,2647 @@
<function>ABS</function>
</refname>
<refpurpose>
- absolute value
- </refpurpose>
+ absolute value
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ABS</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ABS</function> gives the absolute value of <parameter>x</parameter>, i.e. the non-negative number of the same magnitude as <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
+ <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
+ <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>,
+ <link linkend="gnumeric-MOD"><function>MOD</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ABS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ABS</function> gives the absolute value of <parameter>x</parameter>, i.e. the non-negative number of the same magnitude as <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
- <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
- <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
- <link linkend="gnumeric-INT"><function>INT</function></link>,
- <link linkend="gnumeric-MOD"><function>MOD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ACOS">
- <refmeta>
- <refentrytitle>
- <function>ACOS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ACOS</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-ACOS">
+ <refmeta>
+ <refentrytitle>
+ <function>ACOS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ACOS</function>
+ </refname>
+ <refpurpose>
the arc cosine of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ACOS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ACOSH">
- <refmeta>
- <refentrytitle>
- <function>ACOSH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ACOSH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ACOS</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ACOSH">
+ <refmeta>
+ <refentrytitle>
+ <function>ACOSH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ACOSH</function>
+ </refname>
+ <refpurpose>
the hyperbolic arc cosine of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
- <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ACOSH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ACOT">
- <refmeta>
- <refentrytitle>
- <function>ACOT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ACOT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
+ <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ACOSH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ACOT">
+ <refmeta>
+ <refentrytitle>
+ <function>ACOT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ACOT</function>
+ </refname>
+ <refpurpose>
inverse cotangent of a value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COT"><function>COT</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ACOT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ACOTH">
- <refmeta>
- <refentrytitle>
- <function>ACOTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ACOTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COT"><function>COT</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ACOT</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ACOTH">
+ <refmeta>
+ <refentrytitle>
+ <function>ACOTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ACOTH</function>
+ </refname>
+ <refpurpose>
inverse hyperbolic cotangent of a value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COTH"><function>COTH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ACOTH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-Arabic">
- <refmeta>
- <refentrytitle>
- <function>Arabic</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>Arabic</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COTH"><function>COTH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ACOTH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-Arabic">
+ <refmeta>
+ <refentrytitle>
+ <function>Arabic</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>Arabic</function>
+ </refname>
+ <refpurpose>
The Roman numeral <parameter>roman</parameter> as number
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>Arabic</function>(<parameter>roman</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Any Roman symbol to the left of a larger symbol (directly or indirectly) reduces the final value by the symbol amount, otherwise, it increases the final amount by the symbol's amount.</para>
- <para><parameter>roman</parameter>: Roman numeral</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ROMAN"><function>ROMAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ASIN">
- <refmeta>
- <refentrytitle>
- <function>ASIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ASIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>Arabic</function>(<parameter>roman</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Any Roman symbol to the left of a larger symbol (directly or indirectly) reduces the final value by the symbol amount, otherwise, it increases the final amount by the symbol's amount.</para>
+ <para><parameter>roman</parameter>: Roman numeral</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ROMAN"><function>ROMAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ASIN">
+ <refmeta>
+ <refentrytitle>
+ <function>ASIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ASIN</function>
+ </refname>
+ <refpurpose>
the arc sine of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ASIN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ASIN</function> calculates the arc sine of <parameter>x</parameter>; that is the value whose sine is <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> falls outside the range -1 to 1, <function>ASIN</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ASINH">
- <refmeta>
- <refentrytitle>
- <function>ASINH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ASINH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASIN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ASIN</function> calculates the arc sine of <parameter>x</parameter>; that is the value whose sine is <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> falls outside the range -1 to 1, <function>ASIN</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ASINH">
+ <refmeta>
+ <refentrytitle>
+ <function>ASINH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ASINH</function>
+ </refname>
+ <refpurpose>
the inverse hyperbolic sine of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ASINH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ASINH</function> calculates the inverse hyperbolic sine of <parameter>x</parameter>; that is the value whose hyperbolic sine is <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ASIN"><function>ASIN</function></link>,
- <link linkend="gnumeric-ACOSH"><function>ACOSH</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ATAN">
- <refmeta>
- <refentrytitle>
- <function>ATAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ATAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASINH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ASINH</function> calculates the inverse hyperbolic sine of <parameter>x</parameter>; that is the value whose hyperbolic sine is <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ASIN"><function>ASIN</function></link>,
+ <link linkend="gnumeric-ACOSH"><function>ACOSH</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ATAN">
+ <refmeta>
+ <refentrytitle>
+ <function>ATAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ATAN</function>
+ </refname>
+ <refpurpose>
the arc tangent of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ATAN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ATAN</function> calculates the arc tangent of <parameter>x</parameter>; that is the value whose tangent is <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ATAN2">
- <refmeta>
- <refentrytitle>
- <function>ATAN2</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ATAN2</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ATAN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ATAN</function> calculates the arc tangent of <parameter>x</parameter>; that is the value whose tangent is <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ATAN2">
+ <refmeta>
+ <refentrytitle>
+ <function>ATAN2</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ATAN2</function>
+ </refname>
+ <refpurpose>
arc tangent of the ratio of <parameter>b1</parameter> and <parameter>b2</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ATAN2</function>(<parameter>b1</parameter>,<parameter>b2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ATAN2</function> calculates the arc tangent of the ratio <parameter>b1</parameter>/<parameter>b2</parameter> with the sign according to the quadrant containing (<parameter>b1</parameter>,<parameter>b2</parameter>).</para>
- <para><parameter>b1</parameter>: angle in radians</para>
- <para><parameter>b2</parameter>: angle in radians</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
- <link linkend="gnumeric-ATANH"><function>ATANH</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ATANH">
- <refmeta>
- <refentrytitle>
- <function>ATANH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ATANH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ATAN2</function>(<parameter>b1</parameter>,<parameter>b2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ATAN2</function> calculates the arc tangent of the ratio <parameter>b1</parameter>/<parameter>b2</parameter> with the sign according to the quadrant containing (<parameter>b1</parameter>,<parameter>b2</parameter>).</para>
+ <para><parameter>b1</parameter>: angle in radians</para>
+ <para><parameter>b2</parameter>: angle in radians</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
+ <link linkend="gnumeric-ATANH"><function>ATANH</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ATANH">
+ <refmeta>
+ <refentrytitle>
+ <function>ATANH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ATANH</function>
+ </refname>
+ <refpurpose>
the inverse hyperbolic tangent of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ATANH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ATANH</function> calculates the inverse hyperbolic tangent of <parameter>x</parameter>; that is the value whose hyperbolic tangent is <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the absolute value of <parameter>x</parameter> is greater than 1.0, <function>ATANH</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-AVERAGEIF">
- <refmeta>
- <refentrytitle>
- <function>AVERAGEIF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AVERAGEIF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ATANH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ATANH</function> calculates the inverse hyperbolic tangent of <parameter>x</parameter>; that is the value whose hyperbolic tangent is <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the absolute value of <parameter>x</parameter> is greater than 1.0, <function>ATANH</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-AVERAGEIF">
+ <refmeta>
+ <refentrytitle>
+ <function>AVERAGEIF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AVERAGEIF</function>
+ </refname>
+ <refpurpose>
average of the cells in @{actual range} for which the corresponding cells in the range meet the given <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>,
- <link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>AVERAGEIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>,<parameter>actual_range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>range</parameter>: cell area</para>
- <para><parameter>criteria</parameter>: condition for a cell to be included</para>
- <para><parameter>actual_range</parameter>: cell area, defaults to <parameter>range</parameter></para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-BETA">
- <refmeta>
- <refentrytitle>
- <function>BETA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BETA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>,
+ <link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>AVERAGEIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>,<parameter>actual_range</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>range</parameter>: cell area</para>
+ <para><parameter>criteria</parameter>: condition for a cell to be included</para>
+ <para><parameter>actual_range</parameter>: cell area, defaults to <parameter>range</parameter></para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BETA">
+ <refmeta>
+ <refentrytitle>
+ <function>BETA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BETA</function>
+ </refname>
+ <refpurpose>
Euler beta function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BETA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BETA</function> function returns the value of the Euler beta function extended to all real numbers except 0 and negative integers.</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>y</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter>, <parameter>y</parameter>, or (<parameter>x</parameter> + <parameter>y</parameter>) are non-positive integers, <function>BETA</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BETALN"><function>BETALN</function></link>,
- <link linkend="gnumeric-GAMMALN"><function>GAMMALN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BETALN">
- <refmeta>
- <refentrytitle>
- <function>BETALN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BETALN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BETA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BETA</function> function returns the value of the Euler beta function extended to all real numbers except 0 and negative integers.</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>y</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter>, <parameter>y</parameter>, or (<parameter>x</parameter> + <parameter>y</parameter>) are non-positive integers, <function>BETA</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BETALN"><function>BETALN</function></link>,
+ <link linkend="gnumeric-GAMMALN"><function>GAMMALN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BETALN">
+ <refmeta>
+ <refentrytitle>
+ <function>BETALN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BETALN</function>
+ </refname>
+ <refpurpose>
Natural logarithm of the absolute value of the Euler beta function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BETALN</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BETALN</function> function returns the natural logarithm of the absolute value of the Euler beta function extended to all real numbers except 0 and negative integers.</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>y</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter>, <parameter>y</parameter>, or (<parameter>x</parameter> + <parameter>y</parameter>) are non-positive integers, <function>BETALN</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BETA"><function>BETA</function></link>,
- <link linkend="gnumeric-GAMMALN"><function>GAMMALN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CEIL">
- <refmeta>
- <refentrytitle>
- <function>CEIL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CEIL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BETALN</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>BETALN</function> function returns the natural logarithm of the absolute value of the Euler beta function extended to all real numbers except 0 and negative integers.</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>y</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter>, <parameter>y</parameter>, or (<parameter>x</parameter> + <parameter>y</parameter>) are non-positive integers, <function>BETALN</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BETA"><function>BETA</function></link>,
+ <link linkend="gnumeric-GAMMALN"><function>GAMMALN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CEIL">
+ <refmeta>
+ <refentrytitle>
+ <function>CEIL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CEIL</function>
+ </refname>
+ <refpurpose>
smallest integer larger than or equal to <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CEIL</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CEIL</function>(<parameter>x</parameter>) is the smallest integer that is at least as large as <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
- <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>,
- <link linkend="gnumeric-INT"><function>INT</function></link>,
- <link linkend="gnumeric-MOD"><function>MOD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CEILING">
- <refmeta>
- <refentrytitle>
- <function>CEILING</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CEILING</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CEIL</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CEIL</function>(<parameter>x</parameter>) is the smallest integer that is at least as large as <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
+ <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>,
+ <link linkend="gnumeric-MOD"><function>MOD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CEILING">
+ <refmeta>
+ <refentrytitle>
+ <function>CEILING</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CEILING</function>
+ </refname>
+ <refpurpose>
nearest multiple of <parameter>significance</parameter> whose absolute value is at least ABS(<parameter>x</parameter>)
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CEILING</function>(<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CEILING</function>(<parameter>x</parameter>,<parameter>significance</parameter>) is the nearest multiple of <parameter>significance</parameter> whose absolute value is at least ABS(<parameter>x</parameter>).</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>significance</parameter>: base multiple (defaults to 1 for <parameter>x</parameter> > 0 and -1 for <parameter>x</parameter> <0)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> or <parameter>significance</parameter> is non-numeric, <function>CEILING</function> returns a #VALUE! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> and <parameter>significance</parameter> have different signs, <function>CEILING</function> returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
- <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>,
- <link linkend="gnumeric-INT"><function>INT</function></link>,
- <link linkend="gnumeric-MOD"><function>MOD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CHOLESKY">
- <refmeta>
- <refentrytitle>
- <function>CHOLESKY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CHOLESKY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CEILING</function>(<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CEILING</function>(<parameter>x</parameter>,<parameter>significance</parameter>) is the nearest multiple of <parameter>significance</parameter> whose absolute value is at least ABS(<parameter>x</parameter>).</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>significance</parameter>: base multiple (defaults to 1 for <parameter>x</parameter> > 0 and -1 for <parameter>x</parameter> <0)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> or <parameter>significance</parameter> is non-numeric, <function>CEILING</function> returns a #VALUE! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> and <parameter>significance</parameter> have different signs, <function>CEILING</function> returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
+ <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>,
+ <link linkend="gnumeric-MOD"><function>MOD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CHOLESKY">
+ <refmeta>
+ <refentrytitle>
+ <function>CHOLESKY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CHOLESKY</function>
+ </refname>
+ <refpurpose>
the Cholesky decomposition of the symmetric positiv-definite <parameter>matrix</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CHOLESKY</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>matrix</parameter>: a symmetric positive definite matrix</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the Cholesky-Banachiewicz algorithm applied to <parameter>matrix</parameter> fails, Cholesky returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>matrix</parameter> does not contain an equal number of columns and rows, <function>CHOLESKY</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>,
- <link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
- <link linkend="gnumeric-MDETERM"><function>MDETERM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COMBIN">
- <refmeta>
- <refentrytitle>
- <function>COMBIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COMBIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CHOLESKY</function>(<parameter>matrix</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>matrix</parameter>: a symmetric positive definite matrix</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the Cholesky-Banachiewicz algorithm applied to <parameter>matrix</parameter> fails, Cholesky returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>matrix</parameter> does not contain an equal number of columns and rows, <function>CHOLESKY</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>,
+ <link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
+ <link linkend="gnumeric-MDETERM"><function>MDETERM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COMBIN">
+ <refmeta>
+ <refentrytitle>
+ <function>COMBIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COMBIN</function>
+ </refname>
+ <refpurpose>
Binomial coefficient
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COMBIN</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COMBIN</function> returns the binomial coefficient "<parameter>n</parameter> choose <parameter>k</parameter>", the number of <parameter>k</parameter>-combinations of an <parameter>n</parameter>-element set without repetition.</para>
- <para><parameter>n</parameter>: non-negative integer</para>
- <para><parameter>k</parameter>: non-negative integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> is less than <parameter>k</parameter> <function>COMBIN</function> returns #NUM!</para>
- </refsect1>
- <refentry id="gnumeric-COMBINA">
- <refmeta>
- <refentrytitle>
- <function>COMBINA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COMBINA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COMBIN</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>COMBIN</function> returns the binomial coefficient "<parameter>n</parameter> choose <parameter>k</parameter>", the number of <parameter>k</parameter>-combinations of an <parameter>n</parameter>-element set without repetition.</para>
+ <para><parameter>n</parameter>: non-negative integer</para>
+ <para><parameter>k</parameter>: non-negative integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> is less than <parameter>k</parameter> <function>COMBIN</function> returns #NUM!</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COMBINA">
+ <refmeta>
+ <refentrytitle>
+ <function>COMBINA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COMBINA</function>
+ </refname>
+ <refpurpose>
the number of <parameter>k</parameter>-combinations of an <parameter>n</parameter>-element set with repetition
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COMBINA</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: non-negative integer</para>
- <para><parameter>k</parameter>: non-negative integer</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-COS">
- <refmeta>
- <refentrytitle>
- <function>COS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COMBINA</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: non-negative integer</para>
+ <para><parameter>k</parameter>: non-negative integer</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COS">
+ <refmeta>
+ <refentrytitle>
+ <function>COS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COS</function>
+ </refname>
+ <refpurpose>
Cosine function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function is Excel compatible.</para>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COSH">
- <refmeta>
- <refentrytitle>
- <function>COSH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COSH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COS</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function is Excel compatible.</para>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COSH">
+ <refmeta>
+ <refentrytitle>
+ <function>COSH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COSH</function>
+ </refname>
+ <refpurpose>
Hyperbolic cosine function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COSH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-COT">
- <refmeta>
- <refentrytitle>
- <function>COT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COSH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COT">
+ <refmeta>
+ <refentrytitle>
+ <function>COT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COT</function>
+ </refname>
+ <refpurpose>
cotangent of a value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-ACOT"><function>ACOT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-COTH">
- <refmeta>
- <refentrytitle>
- <function>COTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-ACOT"><function>ACOT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COT</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COTH">
+ <refmeta>
+ <refentrytitle>
+ <function>COTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COTH</function>
+ </refname>
+ <refpurpose>
hyperbolic cotangent of a value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-ACOTH"><function>ACOTH</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COTH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-COUNTIF">
- <refmeta>
- <refentrytitle>
- <function>COUNTIF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUNTIF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-ACOTH"><function>ACOTH</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COTH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUNTIF">
+ <refmeta>
+ <refentrytitle>
+ <function>COUNTIF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUNTIF</function>
+ </refname>
+ <refpurpose>
count of the cells meeting the given <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COUNTIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>range</parameter>: cell area</para>
- <para><parameter>criteria</parameter>: condition for a cell to be counted</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-CSC">
- <refmeta>
- <refentrytitle>
- <function>CSC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CSC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COUNTIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>range</parameter>: cell area</para>
+ <para><parameter>criteria</parameter>: condition for a cell to be counted</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CSC">
+ <refmeta>
+ <refentrytitle>
+ <function>CSC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CSC</function>
+ </refname>
+ <refpurpose>
Cosecant
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-SEC"><function>SEC</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>CSC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-CSCH">
- <refmeta>
- <refentrytitle>
- <function>CSCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CSCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-SEC"><function>SEC</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>CSC</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CSCH">
+ <refmeta>
+ <refentrytitle>
+ <function>CSCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CSCH</function>
+ </refname>
+ <refpurpose>
Hyperbolic cosecant
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-CSC"><function>CSC</function></link>,
- <link linkend="gnumeric-SEC"><function>SEC</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>CSCH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-DEGREES">
- <refmeta>
- <refentrytitle>
- <function>DEGREES</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DEGREES</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-CSC"><function>CSC</function></link>,
+ <link linkend="gnumeric-SEC"><function>SEC</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>CSCH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DEGREES">
+ <refmeta>
+ <refentrytitle>
+ <function>DEGREES</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DEGREES</function>
+ </refname>
+ <refpurpose>
Equivalent degrees to <parameter>x</parameter> radians.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-PI"><function>PI</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>DEGREES</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-EIGEN">
- <refmeta>
- <refentrytitle>
- <function>EIGEN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EIGEN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-PI"><function>PI</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>DEGREES</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EIGEN">
+ <refmeta>
+ <refentrytitle>
+ <function>EIGEN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EIGEN</function>
+ </refname>
+ <refpurpose>
eigenvalues and eigenvectors of the symmetric <parameter>matrix</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EIGEN</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>matrix</parameter>: a symmetric matrix</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>matrix</parameter> is not symmetric, <function>EIGEN</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>matrix</parameter> does not contain an equal number of columns and rows, <function>EIGEN</function> returns #VALUE!</para>
- </refsect1>
- <refentry id="gnumeric-EVEN">
- <refmeta>
- <refentrytitle>
- <function>EVEN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EVEN</function>
- </refname>
- <refpurpose><parameter>x</parameter> rounded away from 0 to the next even integer
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ODD"><function>ODD</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>EVEN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-EXP">
- <refmeta>
- <refentrytitle>
- <function>EXP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EXP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EIGEN</function>(<parameter>matrix</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>matrix</parameter>: a symmetric matrix</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>matrix</parameter> is not symmetric, <function>EIGEN</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>matrix</parameter> does not contain an equal number of columns and rows, <function>EIGEN</function> returns #VALUE!</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EVEN">
+ <refmeta>
+ <refentrytitle>
+ <function>EVEN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EVEN</function>
+ </refname>
+ <refpurpose><parameter>x</parameter> rounded away from 0 to the next even integer
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ODD"><function>ODD</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>EVEN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EXP">
+ <refmeta>
+ <refentrytitle>
+ <function>EXP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EXP</function>
+ </refname>
+ <refpurpose>
e raised to the power of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EXP</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>e is the base of the natural logarithm.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOG"><function>LOG</function></link>,
- <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
- <link linkend="gnumeric-LOG10"><function>LOG10</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EXPM1">
- <refmeta>
- <refentrytitle>
- <function>EXPM1</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EXPM1</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EXP</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>e is the base of the natural logarithm.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOG"><function>LOG</function></link>,
+ <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
+ <link linkend="gnumeric-LOG10"><function>LOG10</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EXPM1">
+ <refmeta>
+ <refentrytitle>
+ <function>EXPM1</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EXPM1</function>
+ </refname>
+ <refpurpose>
EXP(<parameter>x</parameter>)-1
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EXPM1</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function has a higher resulting precision than evaluating EXP(<parameter>x</parameter>)-1.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
- <link linkend="gnumeric-LN1P"><function>LN1P</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FACT">
- <refmeta>
- <refentrytitle>
- <function>FACT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FACT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EXPM1</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function has a higher resulting precision than evaluating EXP(<parameter>x</parameter>)-1.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
+ <link linkend="gnumeric-LN1P"><function>LN1P</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FACT">
+ <refmeta>
+ <refentrytitle>
+ <function>FACT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FACT</function>
+ </refname>
+ <refpurpose>
the factorial of <parameter>x</parameter>, i.e. <parameter>x</parameter>!
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FACT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The domain of this function has been extended using the GAMMA function.</para>
- </refsect1>
- <refentry id="gnumeric-FACTDOUBLE">
- <refmeta>
- <refentrytitle>
- <function>FACTDOUBLE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FACTDOUBLE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FACT</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The domain of this function has been extended using the GAMMA function.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FACTDOUBLE">
+ <refmeta>
+ <refentrytitle>
+ <function>FACTDOUBLE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FACTDOUBLE</function>
+ </refname>
+ <refpurpose>
double factorial
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FACTDOUBLE</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FACTDOUBLE</function> function returns the double factorial <parameter>x</parameter>!!</para>
- <para><parameter>x</parameter>: non-negative integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> is not an integer, it is truncated. If <parameter>x</parameter> is negative, <function>FACTDOUBLE</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FACT"><function>FACT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FIB">
- <refmeta>
- <refentrytitle>
- <function>FIB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FIB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FACTDOUBLE</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>FACTDOUBLE</function> function returns the double factorial <parameter>x</parameter>!!</para>
+ <para><parameter>x</parameter>: non-negative integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> is not an integer, it is truncated. If <parameter>x</parameter> is negative, <function>FACTDOUBLE</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FACT"><function>FACT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FIB">
+ <refmeta>
+ <refentrytitle>
+ <function>FIB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FIB</function>
+ </refname>
+ <refpurpose>
Fibonacci numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FIB</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FIB</function>(<parameter>n</parameter>) is the <parameter>n</parameter>th Fibonacci number.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> is not an integer, it is truncated. If it is negative or zero <function>FIB</function> returns #NUM!</para>
- </refsect1>
- <refentry id="gnumeric-FLOOR">
- <refmeta>
- <refentrytitle>
- <function>FLOOR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FLOOR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FIB</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>FIB</function>(<parameter>n</parameter>) is the <parameter>n</parameter>th Fibonacci number.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> is not an integer, it is truncated. If it is negative or zero <function>FIB</function> returns #NUM!</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FLOOR">
+ <refmeta>
+ <refentrytitle>
+ <function>FLOOR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FLOOR</function>
+ </refname>
+ <refpurpose>
nearest multiple of <parameter>significance</parameter> whose absolute value is at most ABS(<parameter>x</parameter>).
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FLOOR</function>(<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FLOOR</function>(<parameter>x</parameter>,<parameter>significance</parameter>) is the nearest multiple of <parameter>significance</parameter> whose absolute value is at most ABS(<parameter>x</parameter>)</para>
- <para><parameter>x</parameter>: number.</para>
- <para><parameter>significance</parameter>: base multiple (defaults to 1 for <parameter>x</parameter> > 0 and -1 for <parameter>x</parameter> <0)</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
- <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>,
- <link linkend="gnumeric-INT"><function>INT</function></link>,
- <link linkend="gnumeric-MOD"><function>MOD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-G_PRODUCT">
- <refmeta>
- <refentrytitle>
- <function>G_PRODUCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>G_PRODUCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FLOOR</function>(<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>FLOOR</function>(<parameter>x</parameter>,<parameter>significance</parameter>) is the nearest multiple of <parameter>significance</parameter> whose absolute value is at most ABS(<parameter>x</parameter>)</para>
+ <para><parameter>x</parameter>: number.</para>
+ <para><parameter>significance</parameter>: base multiple (defaults to 1 for <parameter>x</parameter> > 0 and -1 for <parameter>x</parameter> <0)</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
+ <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>,
+ <link linkend="gnumeric-MOD"><function>MOD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-G_PRODUCT">
+ <refmeta>
+ <refentrytitle>
+ <function>G_PRODUCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>G_PRODUCT</function>
+ </refname>
+ <refpurpose>
product of all the values and cells referenced
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>G_PRODUCT</function>(<parameter>x1</parameter>,<parameter>x2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x1</parameter>: number</para>
- <para><parameter>x2</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Empty cells are ignored and the empty product is 1.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GAMMA">
- <refmeta>
- <refentrytitle>
- <function>GAMMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GAMMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>G_PRODUCT</function>(<parameter>x1</parameter>,<parameter>x2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x1</parameter>: number</para>
+ <para><parameter>x2</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Empty cells are ignored and the empty product is 1.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GAMMA">
+ <refmeta>
+ <refentrytitle>
+ <function>GAMMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GAMMA</function>
+ </refname>
+ <refpurpose>
the Gamma function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GAMMALN"><function>GAMMALN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>GAMMA</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-GAMMALN">
- <refmeta>
- <refentrytitle>
- <function>GAMMALN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GAMMALN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GAMMALN"><function>GAMMALN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>GAMMA</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GAMMALN">
+ <refmeta>
+ <refentrytitle>
+ <function>GAMMALN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GAMMALN</function>
+ </refname>
+ <refpurpose>
natural logarithm of the Gamma function.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GAMMA"><function>GAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>GAMMALN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-GCD">
- <refmeta>
- <refentrytitle>
- <function>GCD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GCD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GAMMA"><function>GAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>GAMMALN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GCD">
+ <refmeta>
+ <refentrytitle>
+ <function>GCD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GCD</function>
+ </refname>
+ <refpurpose>
the greatest common divisor
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GCD</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GCD</function> calculates the greatest common divisor of the given numbers <parameter>n0</parameter>,<parameter>n1</parameter>,..., the greatest integer that is a divisor of each argument.</para>
- <para><parameter>n0</parameter>: positive integer</para>
- <para><parameter>n1</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If any of the arguments is not an integer, it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LCM"><function>LCM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GD">
- <refmeta>
- <refentrytitle>
- <function>GD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GCD</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>GCD</function> calculates the greatest common divisor of the given numbers <parameter>n0</parameter>,<parameter>n1</parameter>,..., the greatest integer that is a divisor of each argument.</para>
+ <para><parameter>n0</parameter>: positive integer</para>
+ <para><parameter>n1</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If any of the arguments is not an integer, it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LCM"><function>LCM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GD">
+ <refmeta>
+ <refentrytitle>
+ <function>GD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GD</function>
+ </refname>
+ <refpurpose>
Gudermannian function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>GD</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-HYPOT">
- <refmeta>
- <refentrytitle>
- <function>HYPOT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HYPOT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>GD</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HYPOT">
+ <refmeta>
+ <refentrytitle>
+ <function>HYPOT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HYPOT</function>
+ </refname>
+ <refpurpose>
the square root of the sum of the squares of the arguments.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
- <link linkend="gnumeric-MAX"><function>MAX</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>HYPOT</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n0</parameter>: number</para>
- <para><parameter>n1</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-INT">
- <refmeta>
- <refentrytitle>
- <function>INT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
+ <link linkend="gnumeric-MAX"><function>MAX</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>HYPOT</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n0</parameter>: number</para>
+ <para><parameter>n1</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INT">
+ <refmeta>
+ <refentrytitle>
+ <function>INT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INT</function>
+ </refname>
+ <refpurpose>
largest integer not larger than <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
- <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
- <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>,
- <link linkend="gnumeric-MOD"><function>MOD</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>INT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-LCM">
- <refmeta>
- <refentrytitle>
- <function>LCM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LCM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
+ <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
+ <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>,
+ <link linkend="gnumeric-MOD"><function>MOD</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>INT</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LCM">
+ <refmeta>
+ <refentrytitle>
+ <function>LCM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LCM</function>
+ </refname>
+ <refpurpose>
the least common multiple
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LCM</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LCM</function> calculates the least common multiple of the given numbers <parameter>n0</parameter>,<parameter>n1</parameter>,..., the smallest integer that is a multiple of each argument.</para>
- <para><parameter>n0</parameter>: positive integer</para>
- <para><parameter>n1</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If any of the arguments is not an integer, it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GCD"><function>GCD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LN">
- <refmeta>
- <refentrytitle>
- <function>LN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LCM</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LCM</function> calculates the least common multiple of the given numbers <parameter>n0</parameter>,<parameter>n1</parameter>,..., the smallest integer that is a multiple of each argument.</para>
+ <para><parameter>n0</parameter>: positive integer</para>
+ <para><parameter>n1</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If any of the arguments is not an integer, it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GCD"><function>GCD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LN">
+ <refmeta>
+ <refentrytitle>
+ <function>LN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LN</function>
+ </refname>
+ <refpurpose>
the natural logarithm of <parameter>x</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: positive number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> â?¤ 0, <function>LN</function> returns #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
- <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
- <link linkend="gnumeric-LOG10"><function>LOG10</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LN1P">
- <refmeta>
- <refentrytitle>
- <function>LN1P</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LN1P</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: positive number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> â?¤ 0, <function>LN</function> returns #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
+ <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
+ <link linkend="gnumeric-LOG10"><function>LOG10</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LN1P">
+ <refmeta>
+ <refentrytitle>
+ <function>LN1P</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LN1P</function>
+ </refname>
+ <refpurpose>
LN(1+<parameter>x</parameter>)
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LN1P</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LN1P</function> calculates LN(1+<parameter>x</parameter>) but yielding a higher precision than evaluating LN(1+<parameter>x</parameter>).</para>
- <para><parameter>x</parameter>: positive number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> â?¤ -1, LN returns #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
- <link linkend="gnumeric-LN"><function>LN</function></link>,
- <link linkend="gnumeric-EXPM1"><function>EXPM1</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOG">
- <refmeta>
- <refentrytitle>
- <function>LOG</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOG</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LN1P</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LN1P</function> calculates LN(1+<parameter>x</parameter>) but yielding a higher precision than evaluating LN(1+<parameter>x</parameter>).</para>
+ <para><parameter>x</parameter>: positive number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> â?¤ -1, LN returns #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
+ <link linkend="gnumeric-LN"><function>LN</function></link>,
+ <link linkend="gnumeric-EXPM1"><function>EXPM1</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOG">
+ <refmeta>
+ <refentrytitle>
+ <function>LOG</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOG</function>
+ </refname>
+ <refpurpose>
Logarithm
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOG</function>(<parameter>x</parameter>,<parameter>base</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: positive number</para>
- <para><parameter>base</parameter>: base of the logarithm, defaults to 10</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>base</parameter> must be positive and not equal to 1.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> â?¤ 0, <function>LOG</function> returns #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LN"><function>LN</function></link>,
- <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
- <link linkend="gnumeric-LOG10"><function>LOG10</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOG10">
- <refmeta>
- <refentrytitle>
- <function>LOG10</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOG10</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOG</function>(<parameter>x</parameter>,<parameter>base</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: positive number</para>
+ <para><parameter>base</parameter>: base of the logarithm, defaults to 10</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>base</parameter> must be positive and not equal to 1.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> â?¤ 0, <function>LOG</function> returns #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LN"><function>LN</function></link>,
+ <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
+ <link linkend="gnumeric-LOG10"><function>LOG10</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOG10">
+ <refmeta>
+ <refentrytitle>
+ <function>LOG10</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOG10</function>
+ </refname>
+ <refpurpose>
the base-10 logarithm of <parameter>x</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOG10</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: positive number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> â?¤ 0, <function>LOG10</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
- <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
- <link linkend="gnumeric-LOG"><function>LOG</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOG2">
- <refmeta>
- <refentrytitle>
- <function>LOG2</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOG2</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOG10</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: positive number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> â?¤ 0, <function>LOG10</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
+ <link linkend="gnumeric-LOG2"><function>LOG2</function></link>,
+ <link linkend="gnumeric-LOG"><function>LOG</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOG2">
+ <refmeta>
+ <refentrytitle>
+ <function>LOG2</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOG2</function>
+ </refname>
+ <refpurpose>
the base-2 logarithm of <parameter>x</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOG2</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: positive number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> â?¤ 0, <function>LOG2</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
- <link linkend="gnumeric-LOG10"><function>LOG10</function></link>,
- <link linkend="gnumeric-LOG"><function>LOG</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MDETERM">
- <refmeta>
- <refentrytitle>
- <function>MDETERM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MDETERM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOG2</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: positive number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> â?¤ 0, <function>LOG2</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
+ <link linkend="gnumeric-LOG10"><function>LOG10</function></link>,
+ <link linkend="gnumeric-LOG"><function>LOG</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MDETERM">
+ <refmeta>
+ <refentrytitle>
+ <function>MDETERM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MDETERM</function>
+ </refname>
+ <refpurpose>
the determinant of the matrix <parameter>matrix</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
- <link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MDETERM</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>matrix</parameter>: a square matrix</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MINVERSE">
- <refmeta>
- <refentrytitle>
- <function>MINVERSE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MINVERSE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
+ <link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MDETERM</function>(<parameter>matrix</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>matrix</parameter>: a square matrix</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MINVERSE">
+ <refmeta>
+ <refentrytitle>
+ <function>MINVERSE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MINVERSE</function>
+ </refname>
+ <refpurpose>
the inverse matrix of <parameter>matrix</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MINVERSE</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>matrix</parameter>: a square matrix</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>matrix</parameter> is not invertible, <function>MINVERSE</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>matrix</parameter> does not contain an equal number of columns and rows, <function>MINVERSE</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
- <link linkend="gnumeric-MDETERM"><function>MDETERM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MMULT">
- <refmeta>
- <refentrytitle>
- <function>MMULT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MMULT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MINVERSE</function>(<parameter>matrix</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>matrix</parameter>: a square matrix</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>matrix</parameter> is not invertible, <function>MINVERSE</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>matrix</parameter> does not contain an equal number of columns and rows, <function>MINVERSE</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
+ <link linkend="gnumeric-MDETERM"><function>MDETERM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MMULT">
+ <refmeta>
+ <refentrytitle>
+ <function>MMULT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MMULT</function>
+ </refname>
+ <refpurpose>
the matrix product of <parameter>mat1</parameter> and <parameter>mat2</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TRANSPOSE"><function>TRANSPOSE</function></link>,
- <link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MMULT</function>(<parameter>mat1</parameter>,<parameter>mat2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>mat1</parameter>: a matrix</para>
- <para><parameter>mat2</parameter>: a matrix</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MOD">
- <refmeta>
- <refentrytitle>
- <function>MOD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MOD</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TRANSPOSE"><function>TRANSPOSE</function></link>,
+ <link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MMULT</function>(<parameter>mat1</parameter>,<parameter>mat2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>mat1</parameter>: a matrix</para>
+ <para><parameter>mat2</parameter>: a matrix</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MOD">
+ <refmeta>
+ <refentrytitle>
+ <function>MOD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MOD</function>
+ </refname>
+ <refpurpose>
the remainder of <parameter>x</parameter> under division by <parameter>n</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MOD</function>(<parameter>x</parameter>,<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MOD</function> function returns the remainder when <parameter>x</parameter> is divided by <parameter>n</parameter>.</para>
- <para><parameter>x</parameter>: integer</para>
- <para><parameter>n</parameter>: integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> is 0, <function>MOD</function> returns #DIV/0!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
- <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
- <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>,
- <link linkend="gnumeric-INT"><function>INT</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MROUND">
- <refmeta>
- <refentrytitle>
- <function>MROUND</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MROUND</function>
- </refname>
- <refpurpose><parameter>x</parameter> rounded to a multiple of <parameter>m</parameter>
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MROUND</function>(<parameter>x</parameter>,<parameter>m</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>m</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> and <parameter>m</parameter> have different sign, <function>MROUND</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
- <link linkend="gnumeric-ROUND"><function>ROUND</function></link>,
- <link linkend="gnumeric-ROUNDUP"><function>ROUNDUP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MULTINOMIAL">
- <refmeta>
- <refentrytitle>
- <function>MULTINOMIAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MULTINOMIAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MOD</function>(<parameter>x</parameter>,<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>MOD</function> function returns the remainder when <parameter>x</parameter> is divided by <parameter>n</parameter>.</para>
+ <para><parameter>x</parameter>: integer</para>
+ <para><parameter>n</parameter>: integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> is 0, <function>MOD</function> returns #DIV/0!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
+ <link linkend="gnumeric-CEILING"><function>CEILING</function></link>,
+ <link linkend="gnumeric-FLOOR"><function>FLOOR</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MROUND">
+ <refmeta>
+ <refentrytitle>
+ <function>MROUND</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MROUND</function>
+ </refname>
+ <refpurpose><parameter>x</parameter> rounded to a multiple of <parameter>m</parameter>
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MROUND</function>(<parameter>x</parameter>,<parameter>m</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>m</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> and <parameter>m</parameter> have different sign, <function>MROUND</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
+ <link linkend="gnumeric-ROUND"><function>ROUND</function></link>,
+ <link linkend="gnumeric-ROUNDUP"><function>ROUNDUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MULTINOMIAL">
+ <refmeta>
+ <refentrytitle>
+ <function>MULTINOMIAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MULTINOMIAL</function>
+ </refname>
+ <refpurpose>
Multinomial coefficient (<parameter>x1</parameter>+â?¯+<parameter>xn</parameter>) choose (<parameter>x1</parameter>,...,<parameter>xn</parameter>)
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MULTINOMIAL</function>(<parameter>x1</parameter>,<parameter>x2</parameter>,<parameter>xn</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x1</parameter>: first number</para>
- <para><parameter>x2</parameter>: second number</para>
- <para><parameter>xn</parameter>: nth number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MUNIT">
- <refmeta>
- <refentrytitle>
- <function>MUNIT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MUNIT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MULTINOMIAL</function>(<parameter>x1</parameter>,<parameter>x2</parameter>,<parameter>xn</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x1</parameter>: first number</para>
+ <para><parameter>x2</parameter>: second number</para>
+ <para><parameter>xn</parameter>: nth number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MUNIT">
+ <refmeta>
+ <refentrytitle>
+ <function>MUNIT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MUNIT</function>
+ </refname>
+ <refpurpose>
the <parameter>n</parameter> by <parameter>n</parameter> identity matrix
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
- <link linkend="gnumeric-MDETERM"><function>MDETERM</function></link>,
- <link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MUNIT</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: size of the matrix</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ODD">
- <refmeta>
- <refentrytitle>
- <function>ODD</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ODD</function>
- </refname>
- <refpurpose><parameter>x</parameter> rounded away from 0 to the next odd integer
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EVEN"><function>EVEN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>ODD</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-PI">
- <refmeta>
- <refentrytitle>
- <function>PI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PI</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
+ <link linkend="gnumeric-MDETERM"><function>MDETERM</function></link>,
+ <link linkend="gnumeric-MINVERSE"><function>MINVERSE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MUNIT</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: size of the matrix</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ODD">
+ <refmeta>
+ <refentrytitle>
+ <function>ODD</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ODD</function>
+ </refname>
+ <refpurpose><parameter>x</parameter> rounded away from 0 to the next odd integer
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EVEN"><function>EVEN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>ODD</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PI">
+ <refmeta>
+ <refentrytitle>
+ <function>PI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PI</function>
+ </refname>
+ <refpurpose>
the constant Ï?
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SQRTPI"><function>SQRTPI</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>PI</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-POWER">
- <refmeta>
- <refentrytitle>
- <function>POWER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>POWER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SQRTPI"><function>SQRTPI</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>PI</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-POWER">
+ <refmeta>
+ <refentrytitle>
+ <function>POWER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>POWER</function>
+ </refname>
+ <refpurpose>
the value of <parameter>x</parameter> raised to the power <parameter>y</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>POWER</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>y</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If both <parameter>x</parameter> and <parameter>y</parameter> equal 0, <function>POWER</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> = 0 and <parameter>y</parameter> < 0, <function>POWER</function> returns #DIV/0!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 and <parameter>y</parameter> is not an integer, <function>POWER</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PRODUCT">
- <refmeta>
- <refentrytitle>
- <function>PRODUCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PRODUCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>POWER</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>y</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If both <parameter>x</parameter> and <parameter>y</parameter> equal 0, <function>POWER</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> = 0 and <parameter>y</parameter> < 0, <function>POWER</function> returns #DIV/0!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 and <parameter>y</parameter> is not an integer, <function>POWER</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PRODUCT">
+ <refmeta>
+ <refentrytitle>
+ <function>PRODUCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PRODUCT</function>
+ </refname>
+ <refpurpose>
product of the given values
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PRODUCT</function>(<parameter>values</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Product computes the product of all the values and cells referenced in the argument list.</para>
- <para><parameter>values</parameter>: a list of values to multiply</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If all cells are empty, the result will be 0.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-G_PRODUCT"><function>G_PRODUCT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-QUOTIENT">
- <refmeta>
- <refentrytitle>
- <function>QUOTIENT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>QUOTIENT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PRODUCT</function>(<parameter>values</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Product computes the product of all the values and cells referenced in the argument list.</para>
+ <para><parameter>values</parameter>: a list of values to multiply</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If all cells are empty, the result will be 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-G_PRODUCT"><function>G_PRODUCT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-QUOTIENT">
+ <refmeta>
+ <refentrytitle>
+ <function>QUOTIENT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>QUOTIENT</function>
+ </refname>
+ <refpurpose>
integer portion of a division
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>QUOTIENT</function>(<parameter>numerator</parameter>,<parameter>denominator</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>QUOTIENT</function> yields the integer portion of the division <parameter>numerator</parameter>/<parameter>denominator</parameter>.</para>
- <para><function>QUOTIENT</function> (<parameter>numerator</parameter>,<parameter>denominator</parameter>)�<parameter>denominator</parameter>+MOD(<parameter>numerator</parameter>,<parameter>denominator</parameter>)=<parameter>numerator</parameter></para>
- <para><parameter>numerator</parameter>: integer</para>
- <para><parameter>denominator</parameter>: non-zero integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MOD"><function>MOD</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RADIANS">
- <refmeta>
- <refentrytitle>
- <function>RADIANS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RADIANS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>QUOTIENT</function>(<parameter>numerator</parameter>,<parameter>denominator</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>QUOTIENT</function> yields the integer portion of the division <parameter>numerator</parameter>/<parameter>denominator</parameter>.</para>
+ <para><function>QUOTIENT</function> (<parameter>numerator</parameter>,<parameter>denominator</parameter>)�<parameter>denominator</parameter>+MOD(<parameter>numerator</parameter>,<parameter>denominator</parameter>)=<parameter>numerator</parameter></para>
+ <para><parameter>numerator</parameter>: integer</para>
+ <para><parameter>denominator</parameter>: non-zero integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MOD"><function>MOD</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RADIANS">
+ <refmeta>
+ <refentrytitle>
+ <function>RADIANS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RADIANS</function>
+ </refname>
+ <refpurpose>
the number of radians equivalent to <parameter>x</parameter> degrees.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PI"><function>PI</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RADIANS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in degrees</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-ROMAN">
- <refmeta>
- <refentrytitle>
- <function>ROMAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ROMAN</function>
- </refname>
- <refpurpose><parameter>n</parameter> as a roman numeral text
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ROMAN</function>(<parameter>n</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ROMAN</function> returns the arabic number <parameter>n</parameter> as a roman numeral text.</para>
- <para>If <parameter>type</parameter> is 0 or it is omitted, <function>ROMAN</function> returns classic roman numbers.</para>
- <para>Type 1 is more concise than classic type, type 2 is more concise than type 1, and type 3 is more concise than type 2. Type 4 is a simplified type.</para>
- <para><parameter>n</parameter>: non-negative integer</para>
- <para><parameter>type</parameter>: 0,1,2,3,or 4, defaults to 0</para>
- </refsect1>
- <refentry id="gnumeric-ROUND">
- <refmeta>
- <refentrytitle>
- <function>ROUND</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ROUND</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PI"><function>PI</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RADIANS</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in degrees</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ROMAN">
+ <refmeta>
+ <refentrytitle>
+ <function>ROMAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ROMAN</function>
+ </refname>
+ <refpurpose><parameter>n</parameter> as a roman numeral text
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ROMAN</function>(<parameter>n</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ROMAN</function> returns the arabic number <parameter>n</parameter> as a roman numeral text.</para>
+ <para>If <parameter>type</parameter> is 0 or it is omitted, <function>ROMAN</function> returns classic roman numbers.</para>
+ <para>Type 1 is more concise than classic type, type 2 is more concise than type 1, and type 3 is more concise than type 2. Type 4 is a simplified type.</para>
+ <para><parameter>n</parameter>: non-negative integer</para>
+ <para><parameter>type</parameter>: 0,1,2,3,or 4, defaults to 0</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ROUND">
+ <refmeta>
+ <refentrytitle>
+ <function>ROUND</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ROUND</function>
+ </refname>
+ <refpurpose>
rounded <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ROUND</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>d</parameter> is greater than zero, <parameter>x</parameter> is rounded to the given number of digits.</para>
- <para>If <parameter>d</parameter> is zero, <parameter>x</parameter> is rounded to the next integer.</para>
- <para>If <parameter>d</parameter> is less than zero, <parameter>x</parameter> is rounded to the left of the decimal point</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>d</parameter>: integer, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
- <link linkend="gnumeric-ROUNDUP"><function>ROUNDUP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ROUNDDOWN">
- <refmeta>
- <refentrytitle>
- <function>ROUNDDOWN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ROUNDDOWN</function>
- </refname>
- <refpurpose><parameter>x</parameter> rounded towards 0.
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ROUNDDOWN</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>d</parameter> is greater than zero, <parameter>x</parameter> is rounded toward 0 to the given number of digits.</para>
- <para>If <parameter>d</parameter> is zero, <parameter>x</parameter> is rounded toward 0 to the next integer.</para>
- <para>If <parameter>d</parameter> is less than zero, <parameter>x</parameter> is rounded toward 0 to the left of the decimal point</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>d</parameter>: integer, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ROUND"><function>ROUND</function></link>,
- <link linkend="gnumeric-ROUNDUP"><function>ROUNDUP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ROUNDUP">
- <refmeta>
- <refentrytitle>
- <function>ROUNDUP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ROUNDUP</function>
- </refname>
- <refpurpose><parameter>x</parameter> rounded away from 0.
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ROUNDUP</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>d</parameter> is greater than zero, <parameter>x</parameter> is rounded away from 0 to the given number of digits.</para>
- <para>If <parameter>d</parameter> is zero, <parameter>x</parameter> is rounded away from 0 to the next integer.</para>
- <para>If <parameter>d</parameter> is less than zero, <parameter>x</parameter> is rounded away from 0 to the left of the decimal point</para>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>d</parameter>: integer, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ROUND"><function>ROUND</function></link>,
- <link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
- <link linkend="gnumeric-INT"><function>INT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SEC">
- <refmeta>
- <refentrytitle>
- <function>SEC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SEC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ROUND</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>d</parameter> is greater than zero, <parameter>x</parameter> is rounded to the given number of digits.</para>
+ <para>If <parameter>d</parameter> is zero, <parameter>x</parameter> is rounded to the next integer.</para>
+ <para>If <parameter>d</parameter> is less than zero, <parameter>x</parameter> is rounded to the left of the decimal point</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>d</parameter>: integer, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
+ <link linkend="gnumeric-ROUNDUP"><function>ROUNDUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ROUNDDOWN">
+ <refmeta>
+ <refentrytitle>
+ <function>ROUNDDOWN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ROUNDDOWN</function>
+ </refname>
+ <refpurpose><parameter>x</parameter> rounded towards 0.
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ROUNDDOWN</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>d</parameter> is greater than zero, <parameter>x</parameter> is rounded toward 0 to the given number of digits.</para>
+ <para>If <parameter>d</parameter> is zero, <parameter>x</parameter> is rounded toward 0 to the next integer.</para>
+ <para>If <parameter>d</parameter> is less than zero, <parameter>x</parameter> is rounded toward 0 to the left of the decimal point</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>d</parameter>: integer, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ROUND"><function>ROUND</function></link>,
+ <link linkend="gnumeric-ROUNDUP"><function>ROUNDUP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ROUNDUP">
+ <refmeta>
+ <refentrytitle>
+ <function>ROUNDUP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ROUNDUP</function>
+ </refname>
+ <refpurpose><parameter>x</parameter> rounded away from 0.
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ROUNDUP</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>d</parameter> is greater than zero, <parameter>x</parameter> is rounded away from 0 to the given number of digits.</para>
+ <para>If <parameter>d</parameter> is zero, <parameter>x</parameter> is rounded away from 0 to the next integer.</para>
+ <para>If <parameter>d</parameter> is less than zero, <parameter>x</parameter> is rounded away from 0 to the left of the decimal point</para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>d</parameter>: integer, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ROUND"><function>ROUND</function></link>,
+ <link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SEC">
+ <refmeta>
+ <refentrytitle>
+ <function>SEC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SEC</function>
+ </refname>
+ <refpurpose>
Secant
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-CSC"><function>CSC</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SECH">
- <refmeta>
- <refentrytitle>
- <function>SECH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SECH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-CSC"><function>CSC</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SEC</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SECH">
+ <refmeta>
+ <refentrytitle>
+ <function>SECH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SECH</function>
+ </refname>
+ <refpurpose>
Hyperbolic secant
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-CSC"><function>CSC</function></link>,
- <link linkend="gnumeric-SEC"><function>SEC</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SECH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SERIESSUM">
- <refmeta>
- <refentrytitle>
- <function>SERIESSUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SERIESSUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-CSC"><function>CSC</function></link>,
+ <link linkend="gnumeric-SEC"><function>SEC</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SECH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SERIESSUM">
+ <refmeta>
+ <refentrytitle>
+ <function>SERIESSUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SERIESSUM</function>
+ </refname>
+ <refpurpose>
sum of a power series at <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SERIESSUM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>m</parameter>,<parameter>coeff</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number where to evaluate the power series</para>
- <para><parameter>n</parameter>: non-negative integer, exponent of the lowest term of the series</para>
- <para><parameter>m</parameter>: increment to each exponent</para>
- <para><parameter>coeff</parameter>: coefficients of the power series</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SIGN">
- <refmeta>
- <refentrytitle>
- <function>SIGN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SIGN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SERIESSUM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>m</parameter>,<parameter>coeff</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number where to evaluate the power series</para>
+ <para><parameter>n</parameter>: non-negative integer, exponent of the lowest term of the series</para>
+ <para><parameter>m</parameter>: increment to each exponent</para>
+ <para><parameter>coeff</parameter>: coefficients of the power series</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SIGN">
+ <refmeta>
+ <refentrytitle>
+ <function>SIGN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SIGN</function>
+ </refname>
+ <refpurpose>
sign of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SIGN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SIGN</function> returns 1 if the <parameter>x</parameter> is positive and it returns -1 if <parameter>x</parameter> is negative.</para>
- <para><parameter>x</parameter>: number</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ABS"><function>ABS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SIN">
- <refmeta>
- <refentrytitle>
- <function>SIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SIGN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SIGN</function> returns 1 if the <parameter>x</parameter> is positive and it returns -1 if <parameter>x</parameter> is negative.</para>
+ <para><parameter>x</parameter>: number</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ABS"><function>ABS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SIN">
+ <refmeta>
+ <refentrytitle>
+ <function>SIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SIN</function>
+ </refname>
+ <refpurpose>
Sine function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-CSC"><function>CSC</function></link>,
- <link linkend="gnumeric-SEC"><function>SEC</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SIN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SINH">
- <refmeta>
- <refentrytitle>
- <function>SINH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SINH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-CSC"><function>CSC</function></link>,
+ <link linkend="gnumeric-SEC"><function>SEC</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SIN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SINH">
+ <refmeta>
+ <refentrytitle>
+ <function>SINH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SINH</function>
+ </refname>
+ <refpurpose>
the hyperbolic sine of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
- <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SINH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SQRT">
- <refmeta>
- <refentrytitle>
- <function>SQRT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SQRT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
+ <link linkend="gnumeric-ASINH"><function>ASINH</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SINH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SQRT">
+ <refmeta>
+ <refentrytitle>
+ <function>SQRT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SQRT</function>
+ </refname>
+ <refpurpose>
square root of <parameter>x</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SQRT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: non-negative number</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> is negative, <function>SQRT</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POWER"><function>POWER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SQRTPI">
- <refmeta>
- <refentrytitle>
- <function>SQRTPI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SQRTPI</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SQRT</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: non-negative number</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> is negative, <function>SQRT</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-POWER"><function>POWER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SQRTPI">
+ <refmeta>
+ <refentrytitle>
+ <function>SQRTPI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SQRTPI</function>
+ </refname>
+ <refpurpose>
the square root of <parameter>x</parameter> times Ï?
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PI"><function>PI</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SQRTPI</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: non-negative number</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SUM">
- <refmeta>
- <refentrytitle>
- <function>SUM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PI"><function>PI</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SQRTPI</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: non-negative number</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUM">
+ <refmeta>
+ <refentrytitle>
+ <function>SUM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUM</function>
+ </refname>
+ <refpurpose>
sum of the given values
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SUM</function>(<parameter>values</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUM</function> computes the sum of all the values and cells referenced in the argument list.</para>
- <para><parameter>values</parameter>: a list of values to add</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUMA">
- <refmeta>
- <refentrytitle>
- <function>SUMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SUM</function>(<parameter>values</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SUM</function> computes the sum of all the values and cells referenced in the argument list.</para>
+ <para><parameter>values</parameter>: a list of values to add</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMA">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMA</function>
+ </refname>
+ <refpurpose>
sum of all values and cells referenced
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SUMA</function>(<parameter>area0</parameter>,<parameter>area1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1).</para>
- <para><parameter>area0</parameter>: first cell area</para>
- <para><parameter>area1</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUMIF">
- <refmeta>
- <refentrytitle>
- <function>SUMIF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMIF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SUMA</function>(<parameter>area0</parameter>,<parameter>area1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1).</para>
+ <para><parameter>area0</parameter>: first cell area</para>
+ <para><parameter>area1</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMIF">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMIF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMIF</function>
+ </refname>
+ <refpurpose>
sum of the cells in <parameter>actual_range</parameter> for which the corresponding cells in the range meet the given <parameter>criteria</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SUMIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>,<parameter>actual_range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>range</parameter>: cell area</para>
- <para><parameter>criteria</parameter>: condition for a cell to be summed</para>
- <para><parameter>actual_range</parameter>: cell area, defaults to <parameter>range</parameter></para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SUMPRODUCT">
- <refmeta>
- <refentrytitle>
- <function>SUMPRODUCT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMPRODUCT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SUMIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>,<parameter>actual_range</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>range</parameter>: cell area</para>
+ <para><parameter>criteria</parameter>: condition for a cell to be summed</para>
+ <para><parameter>actual_range</parameter>: cell area, defaults to <parameter>range</parameter></para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMPRODUCT">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMPRODUCT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMPRODUCT</function>
+ </refname>
+ <refpurpose>
Multiplies components and adds the results.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SUMPRODUCT</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Multiplies corresponding data entries in the given arrays or ranges, and then returns the sum of those products.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If an entry is not numeric, the value zero is used instead.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If arrays or range arguments do not have the same dimensions, return #VALUE! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>SUMPRODUCTs arguments are arrays or ranges. Attempting to use A1:A5>0 will not work, implicit intersection will kick in. Instead use --(A1:A5>0)</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-PRODUCT"><function>PRODUCT</function></link>,
- <link linkend="gnumeric-G_PRODUCT"><function>G_PRODUCT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUMSQ">
- <refmeta>
- <refentrytitle>
- <function>SUMSQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMSQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SUMPRODUCT</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Multiplies corresponding data entries in the given arrays or ranges, and then returns the sum of those products.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If an entry is not numeric, the value zero is used instead.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If arrays or range arguments do not have the same dimensions, return #VALUE! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>SUMPRODUCTs arguments are arrays or ranges. Attempting to use A1:A5>0 will not work, implicit intersection will kick in. Instead use --(A1:A5>0)</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-PRODUCT"><function>PRODUCT</function></link>,
+ <link linkend="gnumeric-G_PRODUCT"><function>G_PRODUCT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMSQ">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMSQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMSQ</function>
+ </refname>
+ <refpurpose>
sum of th squares of all values and cells referenced
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SUMSQ</function>(<parameter>area0</parameter>,<parameter>area1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>area0</parameter>: first cell area</para>
- <para><parameter>area1</parameter>: second cell area</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SUMX2MY2">
- <refmeta>
- <refentrytitle>
- <function>SUMX2MY2</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMX2MY2</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SUMSQ</function>(<parameter>area0</parameter>,<parameter>area1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>area0</parameter>: first cell area</para>
+ <para><parameter>area1</parameter>: second cell area</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMX2MY2">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMX2MY2</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMX2MY2</function>
+ </refname>
+ <refpurpose>
sum of the difference of squares
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SUMX2MY2</function>(<parameter>array0</parameter>,<parameter>array1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUMX2MY2</function> function returns the sum of the difference of squares of corresponding values in two arrays. The equation of <function>SUMX2MY2</function> is SUM(x^2-y^2).</para>
- <para><parameter>array0</parameter>: first cell area</para>
- <para><parameter>array1</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUMSQ"><function>SUMSQ</function></link>,
- <link linkend="gnumeric-SUMX2PY2"><function>SUMX2PY2</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUMX2PY2">
- <refmeta>
- <refentrytitle>
- <function>SUMX2PY2</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMX2PY2</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SUMX2MY2</function>(<parameter>array0</parameter>,<parameter>array1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SUMX2MY2</function> function returns the sum of the difference of squares of corresponding values in two arrays. The equation of <function>SUMX2MY2</function> is SUM(x^2-y^2).</para>
+ <para><parameter>array0</parameter>: first cell area</para>
+ <para><parameter>array1</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUMSQ"><function>SUMSQ</function></link>,
+ <link linkend="gnumeric-SUMX2PY2"><function>SUMX2PY2</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMX2PY2">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMX2PY2</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMX2PY2</function>
+ </refname>
+ <refpurpose>
sum of the sum of squares
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SUMX2PY2</function>(<parameter>array0</parameter>,<parameter>array1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUMX2PY2</function> function returns the sum of the sum of squares of corresponding values in two arrays. The equation of <function>SUMX2PY2</function> is SUM(x^2+y^2).</para>
- <para><parameter>array0</parameter>: first cell area</para>
- <para><parameter>array1</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>array0</parameter> and <parameter>array1</parameter> have different number of data points, <function>SUMX2PY2</function> returns #N/A.</para>
- <para>Strings and empty cells are simply ignored.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUMSQ"><function>SUMSQ</function></link>,
- <link linkend="gnumeric-SUMX2MY2"><function>SUMX2MY2</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUMXMY2">
- <refmeta>
- <refentrytitle>
- <function>SUMXMY2</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUMXMY2</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SUMX2PY2</function>(<parameter>array0</parameter>,<parameter>array1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SUMX2PY2</function> function returns the sum of the sum of squares of corresponding values in two arrays. The equation of <function>SUMX2PY2</function> is SUM(x^2+y^2).</para>
+ <para><parameter>array0</parameter>: first cell area</para>
+ <para><parameter>array1</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>array0</parameter> and <parameter>array1</parameter> have different number of data points, <function>SUMX2PY2</function> returns #N/A.</para>
+ <para>Strings and empty cells are simply ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUMSQ"><function>SUMSQ</function></link>,
+ <link linkend="gnumeric-SUMX2MY2"><function>SUMX2MY2</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUMXMY2">
+ <refmeta>
+ <refentrytitle>
+ <function>SUMXMY2</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUMXMY2</function>
+ </refname>
+ <refpurpose>
sum of the squares of differences
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SUMXMY2</function>(<parameter>array0</parameter>,<parameter>array1</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUMXMY2</function> function returns the sum of the squares of the differences of corresponding values in two arrays. The equation of <function>SUMXMY2</function> is SUM((x-y)^2).</para>
- <para><parameter>array0</parameter>: first cell area</para>
- <para><parameter>array1</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>array0</parameter> and <parameter>array1</parameter> have different number of data points, <function>SUMXMY2</function> returns #N/A.</para>
- <para>Strings and empty cells are simply ignored.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUMSQ"><function>SUMSQ</function></link>,
- <link linkend="gnumeric-SUMX2MY2"><function>SUMX2MY2</function></link>,
- <link linkend="gnumeric-SUMX2PY2"><function>SUMX2PY2</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TAN">
- <refmeta>
- <refentrytitle>
- <function>TAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SUMXMY2</function>(<parameter>array0</parameter>,<parameter>array1</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SUMXMY2</function> function returns the sum of the squares of the differences of corresponding values in two arrays. The equation of <function>SUMXMY2</function> is SUM((x-y)^2).</para>
+ <para><parameter>array0</parameter>: first cell area</para>
+ <para><parameter>array1</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>array0</parameter> and <parameter>array1</parameter> have different number of data points, <function>SUMXMY2</function> returns #N/A.</para>
+ <para>Strings and empty cells are simply ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUMSQ"><function>SUMSQ</function></link>,
+ <link linkend="gnumeric-SUMX2MY2"><function>SUMX2MY2</function></link>,
+ <link linkend="gnumeric-SUMX2PY2"><function>SUMX2PY2</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TAN">
+ <refmeta>
+ <refentrytitle>
+ <function>TAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TAN</function>
+ </refname>
+ <refpurpose>
tangent
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TANH"><function>TANH</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>TAN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-TANH">
- <refmeta>
- <refentrytitle>
- <function>TANH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TANH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>TAN</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TANH">
+ <refmeta>
+ <refentrytitle>
+ <function>TANH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TANH</function>
+ </refname>
+ <refpurpose>
hyperbolic tangent
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
- <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>TANH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: angle in radians</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-TRUNC">
- <refmeta>
- <refentrytitle>
- <function>TRUNC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TRUNC</function>
- </refname>
- <refpurpose><parameter>x</parameter> truncated to <parameter>d</parameter> digits
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TRUNC</function>(<parameter>x</parameter>,<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number</para>
- <para><parameter>x</parameter>: non-negative integer, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>d</parameter> is omitted or negative then it defaults to zero. If it is not an integer then it is truncated to an integer.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INT"><function>INT</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-SIN"><function>SIN</function></link>,
+ <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <link linkend="gnumeric-COSH"><function>COSH</function></link>,
+ <link linkend="gnumeric-DEGREES"><function>DEGREES</function></link>,
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>TANH</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: angle in radians</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TRUNC">
+ <refmeta>
+ <refentrytitle>
+ <function>TRUNC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TRUNC</function>
+ </refname>
+ <refpurpose><parameter>x</parameter> truncated to <parameter>d</parameter> digits
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TRUNC</function>(<parameter>x</parameter>,<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>x</parameter>: non-negative integer, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>d</parameter> is omitted or negative then it defaults to zero. If it is not an integer then it is truncated to an integer.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-INT"><function>INT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Number_Theory">
<title>Number Theory</title>
<refentry id="gnumeric-ISPRIME">
@@ -12253,240 +12253,240 @@
<function>ISPRIME</function>
</refname>
<refpurpose>
- whether <parameter>n</parameter> is prime
- </refpurpose>
+ whether <parameter>n</parameter> is prime
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ISPRIME</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ISPRIME</function> returns TRUE if <parameter>n</parameter> is prime and FALSE otherwise.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
+ <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ISPRIME</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISPRIME</function> returns TRUE if <parameter>n</parameter> is prime and FALSE otherwise.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
- <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ITHPRIME">
- <refmeta>
- <refentrytitle>
- <function>ITHPRIME</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ITHPRIME</function>
- </refname>
- <refpurpose><parameter>i</parameter>th prime
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ITHPRIME</function>(<parameter>i</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ITHPRIME</function> finds the <parameter>i</parameter>th prime.</para>
- <para><parameter>i</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
- <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NT_D">
- <refmeta>
- <refentrytitle>
- <function>NT_D</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NT_D</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-ITHPRIME">
+ <refmeta>
+ <refentrytitle>
+ <function>ITHPRIME</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ITHPRIME</function>
+ </refname>
+ <refpurpose><parameter>i</parameter>th prime
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ITHPRIME</function>(<parameter>i</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ITHPRIME</function> finds the <parameter>i</parameter>th prime.</para>
+ <para><parameter>i</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
+ <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NT_D">
+ <refmeta>
+ <refentrytitle>
+ <function>NT_D</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NT_D</function>
+ </refname>
+ <refpurpose>
number of divisors
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NT_D</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NT_D</function> calculates the number of divisors of <parameter>n</parameter>.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
- <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>,
- <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NT_MU">
- <refmeta>
- <refentrytitle>
- <function>NT_MU</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NT_MU</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NT_D</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NT_D</function> calculates the number of divisors of <parameter>n</parameter>.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
+ <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>,
+ <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NT_MU">
+ <refmeta>
+ <refentrytitle>
+ <function>NT_MU</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NT_MU</function>
+ </refname>
+ <refpurpose>
Möbius mu function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NT_MU</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NT_MU</function> function (Möbius mu function) returns 0 if <parameter>n</parameter> is divisible by the square of a prime. Otherwise, if <parameter>n</parameter> has an odd number of different prime factors, <function>NT_MU</function> returns -1, and if <parameter>n</parameter> has an even number of different prime factors, it returns 1. If <parameter>n</parameter> = 1, <function>NT_MU</function> returns 1.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
- <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>,
- <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>,
- <link linkend="gnumeric-NT_D"><function>NT_D</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NT_PHI">
- <refmeta>
- <refentrytitle>
- <function>NT_PHI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NT_PHI</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NT_MU</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NT_MU</function> function (Möbius mu function) returns 0 if <parameter>n</parameter> is divisible by the square of a prime. Otherwise, if <parameter>n</parameter> has an odd number of different prime factors, <function>NT_MU</function> returns -1, and if <parameter>n</parameter> has an even number of different prime factors, it returns 1. If <parameter>n</parameter> = 1, <function>NT_MU</function> returns 1.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
+ <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>,
+ <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>,
+ <link linkend="gnumeric-NT_D"><function>NT_D</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NT_PHI">
+ <refmeta>
+ <refentrytitle>
+ <function>NT_PHI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NT_PHI</function>
+ </refname>
+ <refpurpose>
Euler's totient function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NT_PHI</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Euler's totient function gives the number of integers less than or equal to <parameter>n</parameter> that are relatively prime (coprime) to <parameter>n</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
- <link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
- <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NT_PI">
- <refmeta>
- <refentrytitle>
- <function>NT_PI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NT_PI</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NT_PHI</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Euler's totient function gives the number of integers less than or equal to <parameter>n</parameter> that are relatively prime (coprime) to <parameter>n</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
+ <link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
+ <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NT_PI">
+ <refmeta>
+ <refentrytitle>
+ <function>NT_PI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NT_PI</function>
+ </refname>
+ <refpurpose>
number of primes upto <parameter>n</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NT_PI</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NT_PI</function> returns the number of primes less than or equal to <parameter>n</parameter>.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
- <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>,
- <link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
- <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NT_SIGMA">
- <refmeta>
- <refentrytitle>
- <function>NT_SIGMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NT_SIGMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NT_PI</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NT_PI</function> returns the number of primes less than or equal to <parameter>n</parameter>.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
+ <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>,
+ <link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
+ <link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NT_SIGMA">
+ <refmeta>
+ <refentrytitle>
+ <function>NT_SIGMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NT_SIGMA</function>
+ </refname>
+ <refpurpose>
sigma function
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NT_SIGMA</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NT_SIGMA</function> calculates the sum of the divisors of <parameter>n</parameter>.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
- <link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
- <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PFACTOR">
- <refmeta>
- <refentrytitle>
- <function>PFACTOR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PFACTOR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NT_SIGMA</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>NT_SIGMA</function> calculates the sum of the divisors of <parameter>n</parameter>.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
+ <link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>,
+ <link linkend="gnumeric-NT_PHI"><function>NT_PHI</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PFACTOR">
+ <refmeta>
+ <refentrytitle>
+ <function>PFACTOR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PFACTOR</function>
+ </refname>
+ <refpurpose>
smallest prime factor
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PFACTOR</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PFACTOR</function> finds the smallest prime factor of its argument.</para>
- <para><parameter>n</parameter>: positive integer</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The argument <parameter>n</parameter> must be at least 2. Otherwise a #VALUE! error is returned.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PFACTOR</function>(<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>PFACTOR</function> finds the smallest prime factor of its argument.</para>
+ <para><parameter>n</parameter>: positive integer</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The argument <parameter>n</parameter> must be at least 2. Otherwise a #VALUE! error is returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ITHPRIME"><function>ITHPRIME</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Random_Numbers">
<title>Random Numbers</title>
<refentry id="gnumeric-RAND">
@@ -12500,1046 +12500,1046 @@
<function>RAND</function>
</refname>
<refpurpose>
- a random number between zero and one.
- </refpurpose>
+ a random number between zero and one.
+ </refpurpose>
</refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RAND</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ </refsect1>
+ </refsect1>
</refentry>
- </sect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RAND</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDBERNOULLI">
- <refmeta>
- <refentrytitle>
- <function>RANDBERNOULLI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDBERNOULLI</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-RANDBERNOULLI">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDBERNOULLI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDBERNOULLI</function>
+ </refname>
+ <refpurpose>
random variate from a Bernoulli distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDBERNOULLI</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability of success</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDBERNOULLI</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDBETA">
- <refmeta>
- <refentrytitle>
- <function>RANDBETA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDBETA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDBERNOULLI</function>(<parameter>p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability of success</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDBERNOULLI</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDBETA">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDBETA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDBETA</function>
+ </refname>
+ <refpurpose>
random variate from a Beta distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDGAMMA"><function>RANDGAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDBETA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the Beta distribution</para>
- <para><parameter>b</parameter>: parameter of the Beta distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDBETWEEN">
- <refmeta>
- <refentrytitle>
- <function>RANDBETWEEN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDBETWEEN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDGAMMA"><function>RANDGAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDBETA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the Beta distribution</para>
+ <para><parameter>b</parameter>: parameter of the Beta distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDBETWEEN">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDBETWEEN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDBETWEEN</function>
+ </refname>
+ <refpurpose>
a random integer number between and including <parameter>bottom</parameter> and <parameter>top</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDBETWEEN</function>(<parameter>bottom</parameter>,<parameter>top</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>bottom</parameter>: lower limit</para>
- <para><parameter>top</parameter>: upper limit</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>bottom</parameter> > <parameter>top</parameter>, <function>RANDBETWEEN</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDUNIFORM"><function>RANDUNIFORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDBINOM">
- <refmeta>
- <refentrytitle>
- <function>RANDBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDBETWEEN</function>(<parameter>bottom</parameter>,<parameter>top</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>bottom</parameter>: lower limit</para>
+ <para><parameter>top</parameter>: upper limit</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>bottom</parameter> > <parameter>top</parameter>, <function>RANDBETWEEN</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDUNIFORM"><function>RANDUNIFORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDBINOM</function>
+ </refname>
+ <refpurpose>
random variate from a binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDBINOM</function>(<parameter>p</parameter>,<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability of success in a single trial</para>
- <para><parameter>n</parameter>: number of trials</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDBINOM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> < 0 <function>RANDBINOM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDCAUCHY">
- <refmeta>
- <refentrytitle>
- <function>RANDCAUCHY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDCAUCHY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDBINOM</function>(<parameter>p</parameter>,<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability of success in a single trial</para>
+ <para><parameter>n</parameter>: number of trials</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDBINOM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> < 0 <function>RANDBINOM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDCAUCHY">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDCAUCHY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDCAUCHY</function>
+ </refname>
+ <refpurpose>
random variate from a Cauchy or Lorentz distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDCAUCHY</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: scale parameter of the distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>a</parameter> < 0 <function>RANDCAUCHY</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDCHISQ">
- <refmeta>
- <refentrytitle>
- <function>RANDCHISQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDCHISQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDCAUCHY</function>(<parameter>a</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: scale parameter of the distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>a</parameter> < 0 <function>RANDCAUCHY</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDCHISQ">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDCHISQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDCHISQ</function>
+ </refname>
+ <refpurpose>
random variate from a Chi-square distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDGAMMA"><function>RANDGAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDCHISQ</function>(<parameter>df</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>df</parameter>: degrees of freedom</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDDISCRETE">
- <refmeta>
- <refentrytitle>
- <function>RANDDISCRETE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDDISCRETE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDGAMMA"><function>RANDGAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDCHISQ</function>(<parameter>df</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>df</parameter>: degrees of freedom</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDDISCRETE">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDDISCRETE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDDISCRETE</function>
+ </refname>
+ <refpurpose>
random variate from a finite discrete distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDDISCRETE</function>(<parameter>val_range</parameter>,<parameter>prob_range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDDISCRETE</function> returns one of the values in the <parameter>val_range</parameter>. The probabilities for each value are given in the <parameter>prob_range</parameter>.</para>
- <para><parameter>val_range</parameter>: possible values of the random variable</para>
- <para><parameter>prob_range</parameter>: probabilities of the corresponding values in <parameter>val_range</parameter>, defaults to equal probabilities</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the sum of all values in <parameter>prob_range</parameter> is not one, <function>RANDDISCRETE</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>val_range</parameter> and <parameter>prob_range</parameter> are not the same size, <function>RANDDISCRETE</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>val_range</parameter> or <parameter>prob_range</parameter> is not a range, <function>RANDDISCRETE</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>,
- <link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDEXP">
- <refmeta>
- <refentrytitle>
- <function>RANDEXP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDEXP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDDISCRETE</function>(<parameter>val_range</parameter>,<parameter>prob_range</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>RANDDISCRETE</function> returns one of the values in the <parameter>val_range</parameter>. The probabilities for each value are given in the <parameter>prob_range</parameter>.</para>
+ <para><parameter>val_range</parameter>: possible values of the random variable</para>
+ <para><parameter>prob_range</parameter>: probabilities of the corresponding values in <parameter>val_range</parameter>, defaults to equal probabilities</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the sum of all values in <parameter>prob_range</parameter> is not one, <function>RANDDISCRETE</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>val_range</parameter> and <parameter>prob_range</parameter> are not the same size, <function>RANDDISCRETE</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>val_range</parameter> or <parameter>prob_range</parameter> is not a range, <function>RANDDISCRETE</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>,
+ <link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDEXP">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDEXP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDEXP</function>
+ </refname>
+ <refpurpose>
random variate from an exponential distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDEXP</function>(<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>b</parameter>: parameter of the exponential distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDEXPPOW">
- <refmeta>
- <refentrytitle>
- <function>RANDEXPPOW</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDEXPPOW</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDEXP</function>(<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>b</parameter>: parameter of the exponential distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDEXPPOW">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDEXPPOW</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDEXPPOW</function>
+ </refname>
+ <refpurpose>
random variate from an exponential power distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDEXPPOW</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>For <parameter>b</parameter> = 1 the exponential power distribution reduces to the Laplace distribution.</para>
- <para><parameter>a</parameter>: scale parameter of the exponential power distribution</para>
- <para><parameter>b</parameter>: exponent of the exponential power distribution</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>For <parameter>b</parameter> = 2 the exponential power distribution reduces to the normal distribution with Ï? = a/sqrt(2)</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDFDIST">
- <refmeta>
- <refentrytitle>
- <function>RANDFDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDFDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDEXPPOW</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>For <parameter>b</parameter> = 1 the exponential power distribution reduces to the Laplace distribution.</para>
+ <para><parameter>a</parameter>: scale parameter of the exponential power distribution</para>
+ <para><parameter>b</parameter>: exponent of the exponential power distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>For <parameter>b</parameter> = 2 the exponential power distribution reduces to the normal distribution with Ï? = a/sqrt(2)</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDFDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDFDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDFDIST</function>
+ </refname>
+ <refpurpose>
random variate from an F distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDGAMMA"><function>RANDGAMMA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDFDIST</function>(<parameter>df1</parameter>,<parameter>df2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>df1</parameter>: numerator degrees of freedom</para>
- <para><parameter>df2</parameter>: denominator degrees of freedom</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDGAMMA">
- <refmeta>
- <refentrytitle>
- <function>RANDGAMMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDGAMMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDGAMMA"><function>RANDGAMMA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDFDIST</function>(<parameter>df1</parameter>,<parameter>df2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>df1</parameter>: numerator degrees of freedom</para>
+ <para><parameter>df2</parameter>: denominator degrees of freedom</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDGAMMA">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDGAMMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDGAMMA</function>
+ </refname>
+ <refpurpose>
random variate from a Gamma distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDGAMMA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the Gamma distribution</para>
- <para><parameter>b</parameter>: parameter of the Gamma distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>a</parameter> â?¤ 0, <function>RANDGAMMA</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDGEOM">
- <refmeta>
- <refentrytitle>
- <function>RANDGEOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDGEOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDGAMMA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the Gamma distribution</para>
+ <para><parameter>b</parameter>: parameter of the Gamma distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>a</parameter> â?¤ 0, <function>RANDGAMMA</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDGEOM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDGEOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDGEOM</function>
+ </refname>
+ <refpurpose>
random variate from a geometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDGEOM</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability of success in a single trial</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDGEOM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDGUMBEL">
- <refmeta>
- <refentrytitle>
- <function>RANDGUMBEL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDGUMBEL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDGEOM</function>(<parameter>p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability of success in a single trial</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDGEOM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDGUMBEL">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDGUMBEL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDGUMBEL</function>
+ </refname>
+ <refpurpose>
random variate from a Gumbel distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDGUMBEL</function>(<parameter>a</parameter>,<parameter>b</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the Gumbel distribution</para>
- <para><parameter>b</parameter>: parameter of the Gumbel distribution</para>
- <para><parameter>type</parameter>: type of the Gumbel distribution, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is neither 1 nor 2, <function>RANDGUMBEL</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDHYPERG">
- <refmeta>
- <refentrytitle>
- <function>RANDHYPERG</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDHYPERG</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDGUMBEL</function>(<parameter>a</parameter>,<parameter>b</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the Gumbel distribution</para>
+ <para><parameter>b</parameter>: parameter of the Gumbel distribution</para>
+ <para><parameter>type</parameter>: type of the Gumbel distribution, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is neither 1 nor 2, <function>RANDGUMBEL</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDHYPERG">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDHYPERG</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDHYPERG</function>
+ </refname>
+ <refpurpose>
random variate from a hypergeometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDHYPERG</function>(<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>t</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n1</parameter>: number of objects of type 1</para>
- <para><parameter>n2</parameter>: number of objects of type 2</para>
- <para><parameter>t</parameter>: total number of objects selected</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDLANDAU">
- <refmeta>
- <refentrytitle>
- <function>RANDLANDAU</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDLANDAU</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDHYPERG</function>(<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>t</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n1</parameter>: number of objects of type 1</para>
+ <para><parameter>n2</parameter>: number of objects of type 2</para>
+ <para><parameter>t</parameter>: total number of objects selected</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDLANDAU">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDLANDAU</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDLANDAU</function>
+ </refname>
+ <refpurpose>
random variate from the Landau distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDLANDAU</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDLAPLACE">
- <refmeta>
- <refentrytitle>
- <function>RANDLAPLACE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDLAPLACE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLANDAU</function>(<parameter/>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDLAPLACE">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDLAPLACE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDLAPLACE</function>
+ </refname>
+ <refpurpose>
random variate from a Laplace distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDLAPLACE</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the Laplace distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDLEVY">
- <refmeta>
- <refentrytitle>
- <function>RANDLEVY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDLEVY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLAPLACE</function>(<parameter>a</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the Laplace distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDLEVY">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDLEVY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDLEVY</function>
+ </refname>
+ <refpurpose>
random variate from a Lévy distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDLEVY</function>(<parameter>c</parameter>,<parameter/>α,<parameter/>β)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>For @{α} = 1, @{β}=0, the Lévy distribution reduces to the Cauchy (or Lorentzian) distribution.</para>
- <para><parameter>c</parameter>: parameter of the Lévy distribution</para>
- <para>@{α}: parameter of the Lévy distribution</para>
- <para>@{β}: parameter of the Lévy distribution, defaults to 0</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>For @{α} = 2, @{β}=0, the Lévy distribution reduces to the normal distribution.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{α} � 0 or @{α} > 2, <function>RANDLEVY</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{β} < -1 or @{β} > 1, <function>RANDLEVY</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDLOG">
- <refmeta>
- <refentrytitle>
- <function>RANDLOG</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDLOG</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLEVY</function>(<parameter>c</parameter>,<parameter/>α,<parameter/>β)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>For @{α} = 1, @{β}=0, the Lévy distribution reduces to the Cauchy (or Lorentzian) distribution.</para>
+ <para><parameter>c</parameter>: parameter of the Lévy distribution</para>
+ <para>@{α}: parameter of the Lévy distribution</para>
+ <para>@{β}: parameter of the Lévy distribution, defaults to 0</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>For @{α} = 2, @{β}=0, the Lévy distribution reduces to the normal distribution.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{α} � 0 or @{α} > 2, <function>RANDLEVY</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{β} < -1 or @{β} > 1, <function>RANDLEVY</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDLOG">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDLOG</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDLOG</function>
+ </refname>
+ <refpurpose>
random variate from a logarithmic distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDLOG</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDLOG</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDLOGISTIC">
- <refmeta>
- <refentrytitle>
- <function>RANDLOGISTIC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDLOGISTIC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLOG</function>(<parameter>p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDLOG</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDLOGISTIC">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDLOGISTIC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDLOGISTIC</function>
+ </refname>
+ <refpurpose>
random variate from a logistic distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDLOGISTIC</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the logistic distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDLOGNORM">
- <refmeta>
- <refentrytitle>
- <function>RANDLOGNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDLOGNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLOGISTIC</function>(<parameter>a</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the logistic distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDLOGNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDLOGNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDLOGNORM</function>
+ </refname>
+ <refpurpose>
random variate from a lognormal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDLOGNORM</function>(<parameter/>ζ,<parameter/>Ï?)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{ζ}: parameter of the lognormal distribution</para>
- <para>@{Ï?}: standard deviation of the distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{Ï?} < 0, <function>RANDLOGNORM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDNEGBINOM">
- <refmeta>
- <refentrytitle>
- <function>RANDNEGBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDNEGBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLOGNORM</function>(<parameter/>ζ,<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{ζ}: parameter of the lognormal distribution</para>
+ <para>@{Ï?}: standard deviation of the distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{Ï?} < 0, <function>RANDLOGNORM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDNEGBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDNEGBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDNEGBINOM</function>
+ </refname>
+ <refpurpose>
random variate from a negative binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDNEGBINOM</function>(<parameter>p</parameter>,<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability of success in a single trial</para>
- <para><parameter>n</parameter>: number of failures</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDNEGBINOM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> < 1 <function>RANDNEGBINOM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDNORM">
- <refmeta>
- <refentrytitle>
- <function>RANDNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDNEGBINOM</function>(<parameter>p</parameter>,<parameter>n</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability of success in a single trial</para>
+ <para><parameter>n</parameter>: number of failures</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDNEGBINOM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> < 1 <function>RANDNEGBINOM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDNORM</function>
+ </refname>
+ <refpurpose>
random variate from a normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDNORM</function>(<parameter/>μ,<parameter/>Ï?)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{μ}: mean of the distribution</para>
- <para>@{Ï?}: standard deviation of the distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{Ï?} < 0, <function>RANDNORM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDNORMTAIL">
- <refmeta>
- <refentrytitle>
- <function>RANDNORMTAIL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDNORMTAIL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDNORM</function>(<parameter/>μ,<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{μ}: mean of the distribution</para>
+ <para>@{Ï?}: standard deviation of the distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{Ï?} < 0, <function>RANDNORM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDNORMTAIL">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDNORMTAIL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDNORMTAIL</function>
+ </refname>
+ <refpurpose>
a random variates from the upper tail of a normal distribution with mean 0
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDNORMTAIL</function>(<parameter>a</parameter>,<parameter/>Ï?)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: lower limit of the tail</para>
- <para>@{Ï?}: standard deviation of the normal distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The method is based on Marsaglia's famous rectangle-wedge-tail algorithm (Ann Math Stat 32, 894-899 (1961)), with this aspect explained in Knuth, v2, 3rd ed, p139, 586 (exercise 11).</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDPARETO">
- <refmeta>
- <refentrytitle>
- <function>RANDPARETO</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDPARETO</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDNORMTAIL</function>(<parameter>a</parameter>,<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: lower limit of the tail</para>
+ <para>@{Ï?}: standard deviation of the normal distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The method is based on Marsaglia's famous rectangle-wedge-tail algorithm (Ann Math Stat 32, 894-899 (1961)), with this aspect explained in Knuth, v2, 3rd ed, p139, 586 (exercise 11).</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDPARETO">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDPARETO</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDPARETO</function>
+ </refname>
+ <refpurpose>
random variate from a Pareto distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDPARETO</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the Pareto distribution</para>
- <para><parameter>b</parameter>: parameter of the Pareto distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDPOISSON">
- <refmeta>
- <refentrytitle>
- <function>RANDPOISSON</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDPOISSON</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDPARETO</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the Pareto distribution</para>
+ <para><parameter>b</parameter>: parameter of the Pareto distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDPOISSON">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDPOISSON</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDPOISSON</function>
+ </refname>
+ <refpurpose>
random variate from a Poisson distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDPOISSON</function>(<parameter/>λ)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{λ}: parameter of the Poisson distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{λ} < 0 <function>RANDPOISSON</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDRAYLEIGH">
- <refmeta>
- <refentrytitle>
- <function>RANDRAYLEIGH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDRAYLEIGH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDPOISSON</function>(<parameter/>λ)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{λ}: parameter of the Poisson distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{λ} < 0 <function>RANDPOISSON</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDRAYLEIGH">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDRAYLEIGH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDRAYLEIGH</function>
+ </refname>
+ <refpurpose>
random variate from a Rayleigh distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDRAYLEIGH</function>(<parameter/>Ï?)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{Ï?}: scale parameter of the Rayleigh distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDRAYLEIGHTAIL">
- <refmeta>
- <refentrytitle>
- <function>RANDRAYLEIGHTAIL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDRAYLEIGHTAIL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDRAYLEIGH</function>(<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{Ï?}: scale parameter of the Rayleigh distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDRAYLEIGHTAIL">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDRAYLEIGHTAIL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDRAYLEIGHTAIL</function>
+ </refname>
+ <refpurpose>
random variate from the tail of a Rayleigh distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
- <link linkend="gnumeric-RANDRAYLEIGH"><function>RANDRAYLEIGH</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDRAYLEIGHTAIL</function>(<parameter>a</parameter>,<parameter/>Ï?)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: lower limit of the tail</para>
- <para>@{Ï?}: scale parameter of the Rayleigh distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDSNORM">
- <refmeta>
- <refentrytitle>
- <function>RANDSNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDSNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
+ <link linkend="gnumeric-RANDRAYLEIGH"><function>RANDRAYLEIGH</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDRAYLEIGHTAIL</function>(<parameter>a</parameter>,<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: lower limit of the tail</para>
+ <para>@{Ï?}: scale parameter of the Rayleigh distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDSNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDSNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDSNORM</function>
+ </refname>
+ <refpurpose>
random variate from a skew normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDSNORM</function>(<parameter>a</parameter>,<parameter/>μ,<parameter/>Ï?)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: amount of skew, defaults to 0</para>
- <para>@{μ}: mean of the underlying normal distribution, defaults to 0</para>
- <para>@{Ï?}: standard deviation of the underlying normal distribution, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{Ï?} < 0, <function>RANDSNORM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDNORM"><function>RANDNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDSTDIST">
- <refmeta>
- <refentrytitle>
- <function>RANDSTDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDSTDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDSNORM</function>(<parameter>a</parameter>,<parameter/>μ,<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: amount of skew, defaults to 0</para>
+ <para>@{μ}: mean of the underlying normal distribution, defaults to 0</para>
+ <para>@{Ï?}: standard deviation of the underlying normal distribution, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{Ï?} < 0, <function>RANDSNORM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDNORM"><function>RANDNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDSTDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDSTDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDSTDIST</function>
+ </refname>
+ <refpurpose>
random variate from a skew t distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDTDIST"><function>RANDTDIST</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDSTDIST</function>(<parameter>df</parameter>,<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>df</parameter>: degrees of freedom</para>
- <para><parameter>a</parameter>: amount of skew, defaults to 0</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDTDIST">
- <refmeta>
- <refentrytitle>
- <function>RANDTDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDTDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDTDIST"><function>RANDTDIST</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDSTDIST</function>(<parameter>df</parameter>,<parameter>a</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>df</parameter>: degrees of freedom</para>
+ <para><parameter>a</parameter>: amount of skew, defaults to 0</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDTDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDTDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDTDIST</function>
+ </refname>
+ <refpurpose>
random variate from a Student t distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDTDIST</function>(<parameter>df</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>df</parameter>: degrees of freedom</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RANDUNIFORM">
- <refmeta>
- <refentrytitle>
- <function>RANDUNIFORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDUNIFORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDTDIST</function>(<parameter>df</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>df</parameter>: degrees of freedom</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDUNIFORM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDUNIFORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDUNIFORM</function>
+ </refname>
+ <refpurpose>
random variate from the uniform distribution from <parameter>a</parameter> to <parameter>b</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANDUNIFORM</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: lower limit of the uniform distribution</para>
- <para><parameter>b</parameter>: upper limit of the uniform distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>a</parameter> > <parameter>b</parameter> <function>RANDUNIFORM</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>,
- <link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANDWEIBULL">
- <refmeta>
- <refentrytitle>
- <function>RANDWEIBULL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANDWEIBULL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDUNIFORM</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: lower limit of the uniform distribution</para>
+ <para><parameter>b</parameter>: upper limit of the uniform distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>a</parameter> > <parameter>b</parameter> <function>RANDUNIFORM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>,
+ <link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDWEIBULL">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDWEIBULL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDWEIBULL</function>
+ </refname>
+ <refpurpose>
random variate from a Weibull distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RANDWEIBULL</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>a</parameter>: parameter of the Weibull distribution</para>
- <para><parameter>b</parameter>: parameter of the Weibull distribution</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-SIMTABLE">
- <refmeta>
- <refentrytitle>
- <function>SIMTABLE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SIMTABLE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RANDWEIBULL</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>a</parameter>: parameter of the Weibull distribution</para>
+ <para><parameter>b</parameter>: parameter of the Weibull distribution</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SIMTABLE">
+ <refmeta>
+ <refentrytitle>
+ <function>SIMTABLE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SIMTABLE</function>
+ </refname>
+ <refpurpose>
one of the values in the given argument list depending on the round number of the simulation tool.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SIMTABLE</function>(<parameter>d1</parameter>,<parameter>d2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SIMTABLE</function> returns one of the values in the given argument list depending on the round number of the simulation tool. When the simulation tool is not activated, <function>SIMTABLE</function> returns <parameter>d1</parameter>.</para>
- <para>With the simulation tool and the <function>SIMTABLE</function> function you can test given decision variables. Each <function>SIMTABLE</function> function contains the possible values of a simulation variable. In most valid simulation models you should have the same number of values <parameter>dN</parameter> for all decision variables. If the simulation is run more rounds than there are values defined, <function>SIMTABLE</function> returns #N/A! error (e.g. if A1 contains `=<function>SIMTABLE</function>(1)' and A2 `=<function>SIMTABLE</function>(1,2)', A1 yields #N/A! error on the second round).</para>
- <para>The successive use of the simulation tool also requires that you give to the tool at least one input variable having RAND() or any other RAND<distribution name>() function in it. On each round, the simulation tool iterates for the given number of rounds over all the input variables to reevaluate them. On each iteration, the values of the output variables are stored, and when the round is completed, descriptive statistical information is created according to the values.</para>
- <para><parameter>d1</parameter>: first value</para>
- <para><parameter>d2</parameter>: second value</para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SIMTABLE</function>(<parameter>d1</parameter>,<parameter>d2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>SIMTABLE</function> returns one of the values in the given argument list depending on the round number of the simulation tool. When the simulation tool is not activated, <function>SIMTABLE</function> returns <parameter>d1</parameter>.</para>
+ <para>With the simulation tool and the <function>SIMTABLE</function> function you can test given decision variables. Each <function>SIMTABLE</function> function contains the possible values of a simulation variable. In most valid simulation models you should have the same number of values <parameter>dN</parameter> for all decision variables. If the simulation is run more rounds than there are values defined, <function>SIMTABLE</function> returns #N/A! error (e.g. if A1 contains `=<function>SIMTABLE</function>(1)' and A2 `=<function>SIMTABLE</function>(1,2)', A1 yields #N/A! error on the second round).</para>
+ <para>The successive use of the simulation tool also requires that you give to the tool at least one input variable having RAND() or any other RAND<distribution name>() function in it. On each round, the simulation tool iterates for the given number of rounds over all the input variables to reevaluate them. On each iteration, the values of the output variables are stored, and when the round is completed, descriptive statistical information is created according to the values.</para>
+ <para><parameter>d1</parameter>: first value</para>
+ <para><parameter>d2</parameter>: second value</para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Statistics">
<title>Statistics</title>
<refentry id="gnumeric-ADTEST">
@@ -13553,5201 +13553,5201 @@
<function>ADTEST</function>
</refname>
<refpurpose>
- Anderson-Darling Test of Normality
- </refpurpose>
+ Anderson-Darling Test of Normality
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ADTEST</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns an array with the first row giving the p-value of the Anderson-Darling Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
+ <para><parameter>x</parameter>: array of sample values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If there are less than 8 sample values, <function>ADTEST</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
+ <link linkend="gnumeric-CVMTEST"><function>CVMTEST</function></link>,
+ <link linkend="gnumeric-LKSTEST"><function>LKSTEST</function></link>,
+ <link linkend="gnumeric-SFTEST"><function>SFTEST</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ADTEST</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns an array with the first row giving the p-value of the Anderson-Darling Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
- <para><parameter>x</parameter>: array of sample values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If there are less than 8 sample values, <function>ADTEST</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
- <link linkend="gnumeric-CVMTEST"><function>CVMTEST</function></link>,
- <link linkend="gnumeric-LKSTEST"><function>LKSTEST</function></link>,
- <link linkend="gnumeric-SFTEST"><function>SFTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-AVEDEV">
- <refmeta>
- <refentrytitle>
- <function>AVEDEV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AVEDEV</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-AVEDEV">
+ <refmeta>
+ <refentrytitle>
+ <function>AVEDEV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AVEDEV</function>
+ </refname>
+ <refpurpose>
average of the absolute deviations of a data set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>AVEDEV</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-AVERAGE">
- <refmeta>
- <refentrytitle>
- <function>AVERAGE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AVERAGE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>AVEDEV</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-AVERAGE">
+ <refmeta>
+ <refentrytitle>
+ <function>AVERAGE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AVERAGE</function>
+ </refname>
+ <refpurpose>
average of all the numeric values and cells
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>AVERAGE</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-AVERAGEA">
- <refmeta>
- <refentrytitle>
- <function>AVERAGEA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>AVERAGEA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>AVERAGE</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-AVERAGEA">
+ <refmeta>
+ <refentrytitle>
+ <function>AVERAGEA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>AVERAGEA</function>
+ </refname>
+ <refpurpose>
average of all the values and cells
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>AVERAGEA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BERNOULLI">
- <refmeta>
- <refentrytitle>
- <function>BERNOULLI</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BERNOULLI</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>AVERAGEA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BERNOULLI">
+ <refmeta>
+ <refentrytitle>
+ <function>BERNOULLI</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BERNOULLI</function>
+ </refname>
+ <refpurpose>
probability mass function of a Bernoulli distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BERNOULLI</function>(<parameter>k</parameter>,<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>k</parameter>: </para>
- <para><parameter>p</parameter>: probability of success</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>k</parameter> != 0 and <parameter>k</parameter> != 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDBERNOULLI"><function>RANDBERNOULLI</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BETADIST">
- <refmeta>
- <refentrytitle>
- <function>BETADIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BETADIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BERNOULLI</function>(<parameter>k</parameter>,<parameter>p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>k</parameter>: </para>
+ <para><parameter>p</parameter>: probability of success</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>k</parameter> != 0 and <parameter>k</parameter> != 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDBERNOULLI"><function>RANDBERNOULLI</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BETADIST">
+ <refmeta>
+ <refentrytitle>
+ <function>BETADIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BETADIST</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the beta distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BETADIST</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>alpha</parameter>: scale parameter</para>
- <para><parameter>beta</parameter>: scale parameter</para>
- <para><parameter>a</parameter>: optional lower bound, defaults to 0</para>
- <para><parameter>b</parameter>: optional upper bound, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < <parameter>a</parameter> or <parameter>x</parameter> > <parameter>b</parameter> this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>a</parameter> >= <parameter>b</parameter> this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BETAINV"><function>BETAINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BETAINV">
- <refmeta>
- <refentrytitle>
- <function>BETAINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BETAINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BETADIST</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>alpha</parameter>: scale parameter</para>
+ <para><parameter>beta</parameter>: scale parameter</para>
+ <para><parameter>a</parameter>: optional lower bound, defaults to 0</para>
+ <para><parameter>b</parameter>: optional upper bound, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < <parameter>a</parameter> or <parameter>x</parameter> > <parameter>b</parameter> this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>a</parameter> >= <parameter>b</parameter> this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BETAINV"><function>BETAINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BETAINV">
+ <refmeta>
+ <refentrytitle>
+ <function>BETAINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BETAINV</function>
+ </refname>
+ <refpurpose>
inverse of the cumulative distribution function of the beta distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BETAINV</function>(<parameter>p</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>alpha</parameter>: scale parameter</para>
- <para><parameter>beta</parameter>: scale parameter</para>
- <para><parameter>a</parameter>: optional lower bound, defaults to 0</para>
- <para><parameter>b</parameter>: optional upper bound, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>a</parameter> >= <parameter>b</parameter> this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BETADIST"><function>BETADIST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BINOM.DIST.RANGE">
- <refmeta>
- <refentrytitle>
- <function>BINOM.DIST.RANGE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BINOM.DIST.RANGE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BETAINV</function>(<parameter>p</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>alpha</parameter>: scale parameter</para>
+ <para><parameter>beta</parameter>: scale parameter</para>
+ <para><parameter>a</parameter>: optional lower bound, defaults to 0</para>
+ <para><parameter>b</parameter>: optional upper bound, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>a</parameter> >= <parameter>b</parameter> this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BETADIST"><function>BETADIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BINOM.DIST.RANGE">
+ <refmeta>
+ <refentrytitle>
+ <function>BINOM.DIST.RANGE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BINOM.DIST.RANGE</function>
+ </refname>
+ <refpurpose>
probability of the binomial distribution over an interval
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BINOM.DIST.RANGE</function>(<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>start</parameter>,<parameter>end</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>trials</parameter>: number of trials</para>
- <para><parameter>p</parameter>: probability of success in each trial</para>
- <para><parameter>start</parameter>: start of the interval</para>
- <para><parameter>end</parameter>: start of the interval, defaults to <parameter>start</parameter></para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>start</parameter>, <parameter>end</parameter> or <parameter>trials</parameter> are non-integer they are truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>start</parameter> > <parameter>end</parameter> this function returns 0.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
- <link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-BINOMDIST">
- <refmeta>
- <refentrytitle>
- <function>BINOMDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>BINOMDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BINOM.DIST.RANGE</function>(<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>start</parameter>,<parameter>end</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>trials</parameter>: number of trials</para>
+ <para><parameter>p</parameter>: probability of success in each trial</para>
+ <para><parameter>start</parameter>: start of the interval</para>
+ <para><parameter>end</parameter>: start of the interval, defaults to <parameter>start</parameter></para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>start</parameter>, <parameter>end</parameter> or <parameter>trials</parameter> are non-integer they are truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>start</parameter> > <parameter>end</parameter> this function returns 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
+ <link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-BINOMDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>BINOMDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BINOMDIST</function>
+ </refname>
+ <refpurpose>
(cumulative) probability mass function of the binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>BINOMDIST</function>(<parameter>n</parameter>,<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: number of successes</para>
- <para><parameter>trials</parameter>: number of trials</para>
- <para><parameter>p</parameter>: probability of success in each trial</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> or <parameter>trials</parameter> are non-integer they are truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> < 0 or <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> > <parameter>trials</parameter> this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CAUCHY">
- <refmeta>
- <refentrytitle>
- <function>CAUCHY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CAUCHY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BINOMDIST</function>(<parameter>n</parameter>,<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: number of successes</para>
+ <para><parameter>trials</parameter>: number of trials</para>
+ <para><parameter>p</parameter>: probability of success in each trial</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> or <parameter>trials</parameter> are non-integer they are truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> < 0 or <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> > <parameter>trials</parameter> this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CAUCHY">
+ <refmeta>
+ <refentrytitle>
+ <function>CAUCHY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CAUCHY</function>
+ </refname>
+ <refpurpose>
(cumulative) probability density function of the Cauchy, Lorentz or Breit-Wigner distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CAUCHY</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>a</parameter>: scale parameter</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>a</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>cumulative</parameter> is neither TRUE nor FALSE this function returns a #VALUE! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDCAUCHY"><function>RANDCAUCHY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CHIDIST">
- <refmeta>
- <refentrytitle>
- <function>CHIDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CHIDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CAUCHY</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>a</parameter>: scale parameter</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>a</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>cumulative</parameter> is neither TRUE nor FALSE this function returns a #VALUE! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDCAUCHY"><function>RANDCAUCHY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CHIDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>CHIDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CHIDIST</function>
+ </refname>
+ <refpurpose>
survival function of the chi-squared distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CHIDIST</function>(<parameter>x</parameter>,<parameter>dof</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The survival function is 1 minus the cumulative distribution function.</para>
- <para><parameter>x</parameter>: </para>
- <para><parameter>dof</parameter>: number of degrees of freedom</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>dof</parameter> is non-integer it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHIINV"><function>CHIINV</function></link>,
- <link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CHIINV">
- <refmeta>
- <refentrytitle>
- <function>CHIINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CHIINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CHIDIST</function>(<parameter>x</parameter>,<parameter>dof</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The survival function is 1 minus the cumulative distribution function.</para>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>dof</parameter>: number of degrees of freedom</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>dof</parameter> is non-integer it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHIINV"><function>CHIINV</function></link>,
+ <link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CHIINV">
+ <refmeta>
+ <refentrytitle>
+ <function>CHIINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CHIINV</function>
+ </refname>
+ <refpurpose>
inverse of the survival function of the chi-squared distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CHIINV</function>(<parameter>p</parameter>,<parameter>dof</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The survival function is 1 minus the cumulative distribution function.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>dof</parameter>: number of degrees of freedom</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHIDIST"><function>CHIDIST</function></link>,
- <link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CHITEST">
- <refmeta>
- <refentrytitle>
- <function>CHITEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CHITEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CHIINV</function>(<parameter>p</parameter>,<parameter>dof</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The survival function is 1 minus the cumulative distribution function.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>dof</parameter>: number of degrees of freedom</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHIDIST"><function>CHIDIST</function></link>,
+ <link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CHITEST">
+ <refmeta>
+ <refentrytitle>
+ <function>CHITEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CHITEST</function>
+ </refname>
+ <refpurpose>
p value of the Goodness of Fit Test
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CHITEST</function>(<parameter>actual_range</parameter>,<parameter>theoretical_range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>actual_range</parameter>: observed data</para>
- <para><parameter>theoretical_range</parameter>: expected values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the actual range is not an n by 1 or 1 by n range, the returned value appears to have no sensible meaning.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHIDIST"><function>CHIDIST</function></link>,
- <link linkend="gnumeric-CHIINV"><function>CHIINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CONFIDENCE">
- <refmeta>
- <refentrytitle>
- <function>CONFIDENCE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CONFIDENCE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CHITEST</function>(<parameter>actual_range</parameter>,<parameter>theoretical_range</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>actual_range</parameter>: observed data</para>
+ <para><parameter>theoretical_range</parameter>: expected values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the actual range is not an n by 1 or 1 by n range, the returned value appears to have no sensible meaning.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHIDIST"><function>CHIDIST</function></link>,
+ <link linkend="gnumeric-CHIINV"><function>CHIINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CONFIDENCE">
+ <refmeta>
+ <refentrytitle>
+ <function>CONFIDENCE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CONFIDENCE</function>
+ </refname>
+ <refpurpose>
margin of error of a confidence interval for the population mean
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CONFIDENCE</function>(<parameter>alpha</parameter>,<parameter>stddev</parameter>,<parameter>size</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>alpha</parameter>: significance level</para>
- <para><parameter>stddev</parameter>: population standard deviation</para>
- <para><parameter>size</parameter>: sample size</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This function requires the usually unknown population standard deviation.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>size</parameter> is non-integer it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>size</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>size</parameter> is 0 this function returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CORREL">
- <refmeta>
- <refentrytitle>
- <function>CORREL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CORREL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CONFIDENCE</function>(<parameter>alpha</parameter>,<parameter>stddev</parameter>,<parameter>size</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>alpha</parameter>: significance level</para>
+ <para><parameter>stddev</parameter>: population standard deviation</para>
+ <para><parameter>size</parameter>: sample size</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This function requires the usually unknown population standard deviation.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>size</parameter> is non-integer it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>size</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>size</parameter> is 0 this function returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CORREL">
+ <refmeta>
+ <refentrytitle>
+ <function>CORREL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CORREL</function>
+ </refname>
+ <refpurpose>
Pearson correlation coefficient of two data sets
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CORREL</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>array1</parameter>: first data set</para>
- <para><parameter>array2</parameter>: second data set</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COVAR"><function>COVAR</function></link>,
- <link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
- <link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-COUNT">
- <refmeta>
- <refentrytitle>
- <function>COUNT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUNT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CORREL</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>array1</parameter>: first data set</para>
+ <para><parameter>array2</parameter>: second data set</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COVAR"><function>COVAR</function></link>,
+ <link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
+ <link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUNT">
+ <refmeta>
+ <refentrytitle>
+ <function>COUNT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUNT</function>
+ </refname>
+ <refpurpose>
total number of integer or floating point arguments passed
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COUNT</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-COUNTA">
- <refmeta>
- <refentrytitle>
- <function>COUNTA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COUNTA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COUNT</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COUNTA">
+ <refmeta>
+ <refentrytitle>
+ <function>COUNTA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COUNTA</function>
+ </refname>
+ <refpurpose>
number of arguments passed not including empty cells
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>,
- <link linkend="gnumeric-DCOUNTA"><function>DCOUNTA</function></link>,
- <link linkend="gnumeric-PRODUCT"><function>PRODUCT</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>COUNTA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-COVAR">
- <refmeta>
- <refentrytitle>
- <function>COVAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>COVAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>,
+ <link linkend="gnumeric-DCOUNTA"><function>DCOUNTA</function></link>,
+ <link linkend="gnumeric-PRODUCT"><function>PRODUCT</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>COUNTA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-COVAR">
+ <refmeta>
+ <refentrytitle>
+ <function>COVAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COVAR</function>
+ </refname>
+ <refpurpose>
covariance of two data sets
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>COVAR</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>array1</parameter>: first data set</para>
- <para><parameter>array2</parameter>: set data set</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CORREL"><function>CORREL</function></link>,
- <link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
- <link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CRITBINOM">
- <refmeta>
- <refentrytitle>
- <function>CRITBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CRITBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>COVAR</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>array1</parameter>: first data set</para>
+ <para><parameter>array2</parameter>: set data set</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CORREL"><function>CORREL</function></link>,
+ <link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
+ <link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CRITBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>CRITBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CRITBINOM</function>
+ </refname>
+ <refpurpose>
right-tailed critical value of the binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CRITBINOM</function>(<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>alpha</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>trials</parameter>: number of trials</para>
- <para><parameter>p</parameter>: probability of success in each trial</para>
- <para><parameter>alpha</parameter>: significance level (area of the tail)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>trials</parameter> is a non-integer it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>alpha</parameter> < 0 or <parameter>alpha</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CRONBACH">
- <refmeta>
- <refentrytitle>
- <function>CRONBACH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CRONBACH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CRITBINOM</function>(<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>alpha</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>trials</parameter>: number of trials</para>
+ <para><parameter>p</parameter>: probability of success in each trial</para>
+ <para><parameter>alpha</parameter>: significance level (area of the tail)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>trials</parameter> is a non-integer it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>alpha</parameter> < 0 or <parameter>alpha</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CRONBACH">
+ <refmeta>
+ <refentrytitle>
+ <function>CRONBACH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CRONBACH</function>
+ </refname>
+ <refpurpose>
Cronbach's alpha
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VAR"><function>VAR</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>CRONBACH</function>(<parameter>ref1</parameter>,<parameter>ref2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>ref1</parameter>: first data set</para>
- <para><parameter>ref2</parameter>: second data set</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-CVMTEST">
- <refmeta>
- <refentrytitle>
- <function>CVMTEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CVMTEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VAR"><function>VAR</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>CRONBACH</function>(<parameter>ref1</parameter>,<parameter>ref2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>ref1</parameter>: first data set</para>
+ <para><parameter>ref2</parameter>: second data set</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CVMTEST">
+ <refmeta>
+ <refentrytitle>
+ <function>CVMTEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CVMTEST</function>
+ </refname>
+ <refpurpose>
Cramér-von Mises Test of Normality
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CVMTEST</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns an array with the first row giving the p-value of the Cramér-von Mises Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
- <para><parameter>x</parameter>: array of sample values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If there are less than 8 sample values, <function>CVMTEST</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
- <link linkend="gnumeric-ADTEST"><function>ADTEST</function></link>,
- <link linkend="gnumeric-LKSTEST"><function>LKSTEST</function></link>,
- <link linkend="gnumeric-SFTEST"><function>SFTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-DEVSQ">
- <refmeta>
- <refentrytitle>
- <function>DEVSQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DEVSQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CVMTEST</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns an array with the first row giving the p-value of the Cramér-von Mises Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
+ <para><parameter>x</parameter>: array of sample values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If there are less than 8 sample values, <function>CVMTEST</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
+ <link linkend="gnumeric-ADTEST"><function>ADTEST</function></link>,
+ <link linkend="gnumeric-LKSTEST"><function>LKSTEST</function></link>,
+ <link linkend="gnumeric-SFTEST"><function>SFTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DEVSQ">
+ <refmeta>
+ <refentrytitle>
+ <function>DEVSQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DEVSQ</function>
+ </refname>
+ <refpurpose>
sum of squares of deviations of a data set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>DEVSQ</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EXPONDIST">
- <refmeta>
- <refentrytitle>
- <function>EXPONDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EXPONDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DEVSQ</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EXPONDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>EXPONDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EXPONDIST</function>
+ </refname>
+ <refpurpose>
(cumulative)density function of the exponential distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EXPONDIST</function>(<parameter>x</parameter>,<parameter>y</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>cumulative</parameter> is false it will return: <parameter>y</parameter> * exp (-<parameter>y</parameter>*<parameter>x</parameter>),otherwise it will return 1 - exp (-<parameter>y</parameter>*<parameter>x</parameter>).</para>
- <para><parameter>x</parameter>: </para>
- <para><parameter>y</parameter>: scale parameter</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 or <parameter>y</parameter> <= 0 this will return an error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-EXPPOWDIST">
- <refmeta>
- <refentrytitle>
- <function>EXPPOWDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EXPPOWDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EXPONDIST</function>(<parameter>x</parameter>,<parameter>y</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>cumulative</parameter> is false it will return: <parameter>y</parameter> * exp (-<parameter>y</parameter>*<parameter>x</parameter>),otherwise it will return 1 - exp (-<parameter>y</parameter>*<parameter>x</parameter>).</para>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>y</parameter>: scale parameter</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 or <parameter>y</parameter> <= 0 this will return an error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EXPPOWDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>EXPPOWDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EXPPOWDIST</function>
+ </refname>
+ <refpurpose>
the probability density function of the Exponential Power distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>EXPPOWDIST</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This distribution has been recommended for lifetime analysis when a U-shaped hazard function is desired. This corresponds to rapid failure once the product starts to wear out after a period of steady or even improving reliability.</para>
- <para><parameter>x</parameter>: </para>
- <para><parameter>a</parameter>: scale parameter</para>
- <para><parameter>b</parameter>: scale parameter</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDEXPPOW"><function>RANDEXPPOW</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FDIST">
- <refmeta>
- <refentrytitle>
- <function>FDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EXPPOWDIST</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This distribution has been recommended for lifetime analysis when a U-shaped hazard function is desired. This corresponds to rapid failure once the product starts to wear out after a period of steady or even improving reliability.</para>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>a</parameter>: scale parameter</para>
+ <para><parameter>b</parameter>: scale parameter</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDEXPPOW"><function>RANDEXPPOW</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>FDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FDIST</function>
+ </refname>
+ <refpurpose>
survival function of the F distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FDIST</function>(<parameter>x</parameter>,<parameter>dof_of_num</parameter>,<parameter>dof_of_denom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The survival function is 1 minus the cumulative distribution function.</para>
- <para><parameter>x</parameter>: </para>
- <para><parameter>dof_of_num</parameter>: numerator degrees of freedom</para>
- <para><parameter>dof_of_denom</parameter>: denominator degrees of freedom</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>dof_of_num</parameter> < 1 or <parameter>dof_of_denom</parameter> < 1, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FINV"><function>FINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FINV">
- <refmeta>
- <refentrytitle>
- <function>FINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FDIST</function>(<parameter>x</parameter>,<parameter>dof_of_num</parameter>,<parameter>dof_of_denom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The survival function is 1 minus the cumulative distribution function.</para>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>dof_of_num</parameter>: numerator degrees of freedom</para>
+ <para><parameter>dof_of_denom</parameter>: denominator degrees of freedom</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>dof_of_num</parameter> < 1 or <parameter>dof_of_denom</parameter> < 1, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FINV"><function>FINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FINV">
+ <refmeta>
+ <refentrytitle>
+ <function>FINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FINV</function>
+ </refname>
+ <refpurpose>
inverse of the survival function of the F distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FINV</function>(<parameter>p</parameter>,<parameter>dof_of_num</parameter>,<parameter>dof_of_denom</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The survival function is 1 minus the cumulative distribution function.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>dof_of_num</parameter>: numerator degrees of freedom</para>
- <para><parameter>dof_of_denom</parameter>: denominator degrees of freedom</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>dof_of_num</parameter> < 1 or <parameter>dof_of_denom</parameter> < 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FISHER">
- <refmeta>
- <refentrytitle>
- <function>FISHER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FISHER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FINV</function>(<parameter>p</parameter>,<parameter>dof_of_num</parameter>,<parameter>dof_of_denom</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The survival function is 1 minus the cumulative distribution function.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>dof_of_num</parameter>: numerator degrees of freedom</para>
+ <para><parameter>dof_of_denom</parameter>: denominator degrees of freedom</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>dof_of_num</parameter> < 1 or <parameter>dof_of_denom</parameter> < 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FISHER">
+ <refmeta>
+ <refentrytitle>
+ <function>FISHER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FISHER</function>
+ </refname>
+ <refpurpose>
Fisher transformation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FISHER</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> is not a number, this function returns a #VALUE! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> <= -1 or <parameter>x</parameter> >= 1, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>,
- <link linkend="gnumeric-ATANH"><function>ATANH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FISHERINV">
- <refmeta>
- <refentrytitle>
- <function>FISHERINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FISHERINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FISHER</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> is not a number, this function returns a #VALUE! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> <= -1 or <parameter>x</parameter> >= 1, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>,
+ <link linkend="gnumeric-ATANH"><function>ATANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FISHERINV">
+ <refmeta>
+ <refentrytitle>
+ <function>FISHERINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FISHERINV</function>
+ </refname>
+ <refpurpose>
inverse of the Fisher transformation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FISHERINV</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> is a non-number this function returns a #VALUE! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FORECAST">
- <refmeta>
- <refentrytitle>
- <function>FORECAST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FORECAST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FISHERINV</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> is a non-number this function returns a #VALUE! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FORECAST">
+ <refmeta>
+ <refentrytitle>
+ <function>FORECAST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FORECAST</function>
+ </refname>
+ <refpurpose>
estimates a future value according to existing values using simple linear regression
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FORECAST</function>(<parameter>x</parameter>,<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function estimates a future value according to existing values using simple linear regression.</para>
- <para><parameter>x</parameter>: x-value whose matching y-value should be forecast</para>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, this function returns a #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the variance of the <parameter>known_x</parameter> is zero, this function returns a #DIV/0 error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INTERCEPT"><function>INTERCEPT</function></link>,
- <link linkend="gnumeric-TREND"><function>TREND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FREQUENCY">
- <refmeta>
- <refentrytitle>
- <function>FREQUENCY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FREQUENCY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FORECAST</function>(<parameter>x</parameter>,<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function estimates a future value according to existing values using simple linear regression.</para>
+ <para><parameter>x</parameter>: x-value whose matching y-value should be forecast</para>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, this function returns a #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the variance of the <parameter>known_x</parameter> is zero, this function returns a #DIV/0 error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-INTERCEPT"><function>INTERCEPT</function></link>,
+ <link linkend="gnumeric-TREND"><function>TREND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FREQUENCY">
+ <refmeta>
+ <refentrytitle>
+ <function>FREQUENCY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FREQUENCY</function>
+ </refname>
+ <refpurpose>
the frequency table
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FREQUENCY</function>(<parameter>data_array</parameter>,<parameter>bins_array</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The results are given as an array.</para>
- <para><parameter>data_array</parameter>: data values</para>
- <para><parameter>bins_array</parameter>: array of cutoff values</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>If the <parameter>bin_array</parameter> is empty, this function returns the number of data points in <parameter>data_array</parameter>.</para>
- </refsect1>
- <refentry id="gnumeric-FTEST">
- <refmeta>
- <refentrytitle>
- <function>FTEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FTEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FREQUENCY</function>(<parameter>data_array</parameter>,<parameter>bins_array</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The results are given as an array.</para>
+ <para><parameter>data_array</parameter>: data values</para>
+ <para><parameter>bins_array</parameter>: array of cutoff values</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>If the <parameter>bin_array</parameter> is empty, this function returns the number of data points in <parameter>data_array</parameter>.</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FTEST">
+ <refmeta>
+ <refentrytitle>
+ <function>FTEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FTEST</function>
+ </refname>
+ <refpurpose>
p-value for the two-tailed hypothesis test comparing the variances of two populations
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>,
- <link linkend="gnumeric-FINV"><function>FINV</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>FTEST</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>array1</parameter>: sample from the first population</para>
- <para><parameter>array2</parameter>: sample from the second population</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-GAMMADIST">
- <refmeta>
- <refentrytitle>
- <function>GAMMADIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GAMMADIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>,
+ <link linkend="gnumeric-FINV"><function>FINV</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>FTEST</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>array1</parameter>: sample from the first population</para>
+ <para><parameter>array2</parameter>: sample from the second population</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GAMMADIST">
+ <refmeta>
+ <refentrytitle>
+ <function>GAMMADIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GAMMADIST</function>
+ </refname>
+ <refpurpose>
(cumulative) density function of the gamma distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GAMMADIST</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>alpha</parameter>: scale parameter</para>
- <para><parameter>beta</parameter>: scale parameter</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GAMMAINV"><function>GAMMAINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GAMMAINV">
- <refmeta>
- <refentrytitle>
- <function>GAMMAINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GAMMAINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GAMMADIST</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>alpha</parameter>: scale parameter</para>
+ <para><parameter>beta</parameter>: scale parameter</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GAMMAINV"><function>GAMMAINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GAMMAINV">
+ <refmeta>
+ <refentrytitle>
+ <function>GAMMAINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GAMMAINV</function>
+ </refname>
+ <refpurpose>
inverse of the cumulative gamma distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GAMMAINV</function>(<parameter>p</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>alpha</parameter>: scale parameter</para>
- <para><parameter>beta</parameter>: scale parameter</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GAMMADIST"><function>GAMMADIST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GEOMDIST">
- <refmeta>
- <refentrytitle>
- <function>GEOMDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GEOMDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GAMMAINV</function>(<parameter>p</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>alpha</parameter>: scale parameter</para>
+ <para><parameter>beta</parameter>: scale parameter</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GAMMADIST"><function>GAMMADIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GEOMDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>GEOMDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GEOMDIST</function>
+ </refname>
+ <refpurpose>
(cumulative) probability mass function of the hypergeometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GEOMDIST</function>(<parameter>k</parameter>,<parameter>p</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>k</parameter>: number of trials</para>
- <para><parameter>p</parameter>: probability of success in any trial</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>k</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>cumulative</parameter> is neither TRUE nor FALSE this function returns a #VALUE! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDGEOM"><function>RANDGEOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GEOMEAN">
- <refmeta>
- <refentrytitle>
- <function>GEOMEAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GEOMEAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GEOMDIST</function>(<parameter>k</parameter>,<parameter>p</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>k</parameter>: number of trials</para>
+ <para><parameter>p</parameter>: probability of success in any trial</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>k</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>cumulative</parameter> is neither TRUE nor FALSE this function returns a #VALUE! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDGEOM"><function>RANDGEOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GEOMEAN">
+ <refmeta>
+ <refentrytitle>
+ <function>GEOMEAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GEOMEAN</function>
+ </refname>
+ <refpurpose>
geometric mean
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GEOMEAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The geometric mean is equal to the Nth root of the product of the N values.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-HARMEAN"><function>HARMEAN</function></link>,
- <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
- <link linkend="gnumeric-MODE"><function>MODE</function></link>,
- <link linkend="gnumeric-TRIMMEAN"><function>TRIMMEAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-GROWTH">
- <refmeta>
- <refentrytitle>
- <function>GROWTH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GROWTH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GEOMEAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The geometric mean is equal to the Nth root of the product of the N values.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-HARMEAN"><function>HARMEAN</function></link>,
+ <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
+ <link linkend="gnumeric-MODE"><function>MODE</function></link>,
+ <link linkend="gnumeric-TRIMMEAN"><function>TRIMMEAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-GROWTH">
+ <refmeta>
+ <refentrytitle>
+ <function>GROWTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GROWTH</function>
+ </refname>
+ <refpurpose>
predicts the exponential growth
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>GROWTH</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>new_x</parameter>'s,<parameter>const</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GROWTH</function> function applies the ``least squares'' method to fit an exponential curve to your data and predicts the exponential growth by using this curve.</para>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
- <para>@{new_x's}: x-values for which you want to estimate the y-values; defaults to <parameter>known_x</parameter>'s</para>
- <para><parameter>const</parameter>: if this is false the line will be forced to go through the origin; defaults to TRUE</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><function>GROWTH</function> returns an array having one column and a row for each data point in <parameter>new_x</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>,
- <link linkend="gnumeric-GROWTH"><function>GROWTH</function></link>,
- <link linkend="gnumeric-TREND"><function>TREND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HARMEAN">
- <refmeta>
- <refentrytitle>
- <function>HARMEAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HARMEAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GROWTH</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>new_x</parameter>'s,<parameter>const</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>GROWTH</function> function applies the ``least squares'' method to fit an exponential curve to your data and predicts the exponential growth by using this curve.</para>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
+ <para>@{new_x's}: x-values for which you want to estimate the y-values; defaults to <parameter>known_x</parameter>'s</para>
+ <para><parameter>const</parameter>: if this is false the line will be forced to go through the origin; defaults to TRUE</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><function>GROWTH</function> returns an array having one column and a row for each data point in <parameter>new_x</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>,
+ <link linkend="gnumeric-GROWTH"><function>GROWTH</function></link>,
+ <link linkend="gnumeric-TREND"><function>TREND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HARMEAN">
+ <refmeta>
+ <refentrytitle>
+ <function>HARMEAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HARMEAN</function>
+ </refname>
+ <refpurpose>
harmonic mean
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HARMEAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The harmonic mean of N data points is N divided by the sum of the reciprocals of the data points).</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-GEOMEAN"><function>GEOMEAN</function></link>,
- <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
- <link linkend="gnumeric-MODE"><function>MODE</function></link>,
- <link linkend="gnumeric-TRIMMEAN"><function>TRIMMEAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-HYPGEOMDIST">
- <refmeta>
- <refentrytitle>
- <function>HYPGEOMDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>HYPGEOMDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HARMEAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The harmonic mean of N data points is N divided by the sum of the reciprocals of the data points).</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-GEOMEAN"><function>GEOMEAN</function></link>,
+ <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
+ <link linkend="gnumeric-MODE"><function>MODE</function></link>,
+ <link linkend="gnumeric-TRIMMEAN"><function>TRIMMEAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HYPGEOMDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>HYPGEOMDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HYPGEOMDIST</function>
+ </refname>
+ <refpurpose>
(cumulative) probability mass function of the hypergeometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>HYPGEOMDIST</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter>,<parameter>N</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number of successes</para>
- <para><parameter>n</parameter>: sample size</para>
- <para><parameter>M</parameter>: number of possible successes in the population</para>
- <para><parameter>N</parameter>: population size</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter> or <parameter>N</parameter> is a non-integer it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter> or <parameter>N</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> > <parameter>M</parameter> or <parameter>n</parameter> > <parameter>N</parameter> this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
- <link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-INTERCEPT">
- <refmeta>
- <refentrytitle>
- <function>INTERCEPT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INTERCEPT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>HYPGEOMDIST</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter>,<parameter>N</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number of successes</para>
+ <para><parameter>n</parameter>: sample size</para>
+ <para><parameter>M</parameter>: number of possible successes in the population</para>
+ <para><parameter>N</parameter>: population size</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter> or <parameter>N</parameter> is a non-integer it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter> or <parameter>N</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> > <parameter>M</parameter> or <parameter>n</parameter> > <parameter>N</parameter> this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
+ <link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-INTERCEPT">
+ <refmeta>
+ <refentrytitle>
+ <function>INTERCEPT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INTERCEPT</function>
+ </refname>
+ <refpurpose>
the intercept of a linear regression line
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INTERCEPT</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, this function returns a #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the variance of the <parameter>known_x</parameter> is zero, this function returns #DIV/0 error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FORECAST"><function>FORECAST</function></link>,
- <link linkend="gnumeric-TREND"><function>TREND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-KURT">
- <refmeta>
- <refentrytitle>
- <function>KURT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>KURT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INTERCEPT</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, this function returns a #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the variance of the <parameter>known_x</parameter> is zero, this function returns #DIV/0 error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FORECAST"><function>FORECAST</function></link>,
+ <link linkend="gnumeric-TREND"><function>TREND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-KURT">
+ <refmeta>
+ <refentrytitle>
+ <function>KURT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>KURT</function>
+ </refname>
+ <refpurpose>
unbiased estimate of the kurtosis of a data set.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>KURT</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This is only meaningful if the underlying distribution really has a fourth moment. The kurtosis is offset by three such that a normal distribution will have zero kurtosis.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If fewer than four numbers are given or all of them are equal this function returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-VAR"><function>VAR</function></link>,
- <link linkend="gnumeric-SKEW"><function>SKEW</function></link>,
- <link linkend="gnumeric-KURTP"><function>KURTP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-KURTP">
- <refmeta>
- <refentrytitle>
- <function>KURTP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>KURTP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>KURT</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This is only meaningful if the underlying distribution really has a fourth moment. The kurtosis is offset by three such that a normal distribution will have zero kurtosis.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If fewer than four numbers are given or all of them are equal this function returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-VAR"><function>VAR</function></link>,
+ <link linkend="gnumeric-SKEW"><function>SKEW</function></link>,
+ <link linkend="gnumeric-KURTP"><function>KURTP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-KURTP">
+ <refmeta>
+ <refentrytitle>
+ <function>KURTP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>KURTP</function>
+ </refname>
+ <refpurpose>
population kurtosis of a data set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>KURTP</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If fewer than two numbers are given or all of them are equal this function returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-VARP"><function>VARP</function></link>,
- <link linkend="gnumeric-SKEWP"><function>SKEWP</function></link>,
- <link linkend="gnumeric-KURT"><function>KURT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LANDAU">
- <refmeta>
- <refentrytitle>
- <function>LANDAU</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LANDAU</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>KURTP</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If fewer than two numbers are given or all of them are equal this function returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-VARP"><function>VARP</function></link>,
+ <link linkend="gnumeric-SKEWP"><function>SKEWP</function></link>,
+ <link linkend="gnumeric-KURT"><function>KURT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LANDAU">
+ <refmeta>
+ <refentrytitle>
+ <function>LANDAU</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LANDAU</function>
+ </refname>
+ <refpurpose>
approximate probability density function of the Landau distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDLANDAU"><function>RANDLANDAU</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>LANDAU</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-LAPLACE">
- <refmeta>
- <refentrytitle>
- <function>LAPLACE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LAPLACE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDLANDAU"><function>RANDLANDAU</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>LANDAU</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LAPLACE">
+ <refmeta>
+ <refentrytitle>
+ <function>LAPLACE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LAPLACE</function>
+ </refname>
+ <refpurpose>
probability density function of the Laplace distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDLAPLACE"><function>RANDLAPLACE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>LAPLACE</function>(<parameter>x</parameter>,<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>a</parameter>: mean</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-LARGE">
- <refmeta>
- <refentrytitle>
- <function>LARGE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LARGE</function>
- </refname>
- <refpurpose><parameter>k</parameter>-th largest value in a data set
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LARGE</function>(<parameter>data</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>data</parameter>: data set</para>
- <para><parameter>k</parameter>: which value to find</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If data set is empty this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>k</parameter> <= 0 or <parameter>k</parameter> is greater than the number of data items given this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
- <link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
- <link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>,
- <link linkend="gnumeric-SMALL"><function>SMALL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LINEST">
- <refmeta>
- <refentrytitle>
- <function>LINEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LINEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDLAPLACE"><function>RANDLAPLACE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>LAPLACE</function>(<parameter>x</parameter>,<parameter>a</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>a</parameter>: mean</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LARGE">
+ <refmeta>
+ <refentrytitle>
+ <function>LARGE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LARGE</function>
+ </refname>
+ <refpurpose><parameter>k</parameter>-th largest value in a data set
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LARGE</function>(<parameter>data</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>data</parameter>: data set</para>
+ <para><parameter>k</parameter>: which value to find</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If data set is empty this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>k</parameter> <= 0 or <parameter>k</parameter> is greater than the number of data items given this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
+ <link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
+ <link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>,
+ <link linkend="gnumeric-SMALL"><function>SMALL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LINEST">
+ <refmeta>
+ <refentrytitle>
+ <function>LINEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LINEST</function>
+ </refname>
+ <refpurpose>
determines multiple linear regression coefficients and statistics.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LINEST</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>affine</parameter>,<parameter>stats</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns an array with the first row giving the regression coefficients for the independent variables x_m, x_(m-1),...,x_2, x_1 followed by the y-intercept if <parameter>affine</parameter> is true.</para>
- <para>@{known_y's}: vector of values of dependent variable.</para>
- <para>@{known_x's}: array of values of independent variables, defaults to a single vector 1,...,n.</para>
- <para><parameter>affine</parameter>: if true, the model contains a constant term, defaults to true.</para>
- <para><parameter>stats</parameter>: if true, some additional statistics are provided, defaults to false</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>stats</parameter> is true, the second row contains the corresponding standard errors of the regression coefficients.In this case, the third row contains the R^2 value and the standard error for the predicted value. The fourth row contains the observed F value and its degrees of freedom. Finally, the fifth row contains the regression sum of squares and the residual sum of squares.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>affine</parameter> is false, R^2 is the uncentered version of the coefficient of determination; that is the proportion of the sum of squares explained by the model.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the length of @{known_y's} does not match the corresponding length of @{known_x's}, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>,
- <link linkend="gnumeric-TREND"><function>TREND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LKSTEST">
- <refmeta>
- <refentrytitle>
- <function>LKSTEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LKSTEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LINEST</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>affine</parameter>,<parameter>stats</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns an array with the first row giving the regression coefficients for the independent variables x_m, x_(m-1),...,x_2, x_1 followed by the y-intercept if <parameter>affine</parameter> is true.</para>
+ <para>@{known_y's}: vector of values of dependent variable.</para>
+ <para>@{known_x's}: array of values of independent variables, defaults to a single vector 1,...,n.</para>
+ <para><parameter>affine</parameter>: if true, the model contains a constant term, defaults to true.</para>
+ <para><parameter>stats</parameter>: if true, some additional statistics are provided, defaults to false</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>stats</parameter> is true, the second row contains the corresponding standard errors of the regression coefficients.In this case, the third row contains the R^2 value and the standard error for the predicted value. The fourth row contains the observed F value and its degrees of freedom. Finally, the fifth row contains the regression sum of squares and the residual sum of squares.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>affine</parameter> is false, R^2 is the uncentered version of the coefficient of determination; that is the proportion of the sum of squares explained by the model.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the length of @{known_y's} does not match the corresponding length of @{known_x's}, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>,
+ <link linkend="gnumeric-TREND"><function>TREND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LKSTEST">
+ <refmeta>
+ <refentrytitle>
+ <function>LKSTEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LKSTEST</function>
+ </refname>
+ <refpurpose>
Lilliefors (Kolmogorov-Smirnov) Test of Normality
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LKSTEST</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns an array with the first row giving the p-value of the Lilliefors (Kolmogorov-Smirnov) Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
- <para><parameter>x</parameter>: array of sample values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If there are less than 5 sample values, <function>LKSTEST</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
- <link linkend="gnumeric-ADTEST"><function>ADTEST</function></link>,
- <link linkend="gnumeric-SFTEST"><function>SFTEST</function></link>,
- <link linkend="gnumeric-CVMTEST"><function>CVMTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOGEST">
- <refmeta>
- <refentrytitle>
- <function>LOGEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOGEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LKSTEST</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns an array with the first row giving the p-value of the Lilliefors (Kolmogorov-Smirnov) Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
+ <para><parameter>x</parameter>: array of sample values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If there are less than 5 sample values, <function>LKSTEST</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
+ <link linkend="gnumeric-ADTEST"><function>ADTEST</function></link>,
+ <link linkend="gnumeric-SFTEST"><function>SFTEST</function></link>,
+ <link linkend="gnumeric-CVMTEST"><function>CVMTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOGEST">
+ <refmeta>
+ <refentrytitle>
+ <function>LOGEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOGEST</function>
+ </refname>
+ <refpurpose>
exponential least square fit
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOGEST</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>const</parameter>,<parameter>stat</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOGEST</function> function applies the ``least squares'' method to fit an exponential curve of the form y = b * m{1}^x{1} * m{2}^x{2}... to your data.</para>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
- <para><parameter>const</parameter>: if this is false the line will be forced to go through (0,1); defaults to TRUE</para>
- <para><parameter>stat</parameter>: If <parameter>stat</parameter> is TRUE, extra statistical information will be returned; defaults to FALSE.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><function>LOGEST</function> returns an array { m{n},m{n-1}, ...,m{1},b }.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Extra statistical information is written below the regression line coefficients in the result array. Extra statistical information consists of four rows of data. In the first row the standard error values for the coefficients m1, (m2, ...), b are represented. The second row contains the square of R and the standard error for the y estimate. The third row contains the F-observed value and the degrees of freedom. The last row contains the regression sum of squares and the residual sum of squares.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-GROWTH"><function>GROWTH</function></link>,
- <link linkend="gnumeric-TREND"><function>TREND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOGFIT">
- <refmeta>
- <refentrytitle>
- <function>LOGFIT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOGFIT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOGEST</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>const</parameter>,<parameter>stat</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LOGEST</function> function applies the ``least squares'' method to fit an exponential curve of the form y = b * m{1}^x{1} * m{2}^x{2}... to your data.</para>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
+ <para><parameter>const</parameter>: if this is false the line will be forced to go through (0,1); defaults to TRUE</para>
+ <para><parameter>stat</parameter>: If <parameter>stat</parameter> is TRUE, extra statistical information will be returned; defaults to FALSE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LOGEST</function> returns an array { m{n},m{n-1}, ...,m{1},b }.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Extra statistical information is written below the regression line coefficients in the result array. Extra statistical information consists of four rows of data. In the first row the standard error values for the coefficients m1, (m2, ...), b are represented. The second row contains the square of R and the standard error for the y estimate. The third row contains the F-observed value and the degrees of freedom. The last row contains the regression sum of squares and the residual sum of squares.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GROWTH"><function>GROWTH</function></link>,
+ <link linkend="gnumeric-TREND"><function>TREND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOGFIT">
+ <refmeta>
+ <refentrytitle>
+ <function>LOGFIT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOGFIT</function>
+ </refname>
+ <refpurpose>
logarithmic least square fit (using a trial and error method)
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOGFIT</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOGFIT</function> function applies the ``least squares'' method to fit the logarithmic equation y = a + b * ln(sign * (x - c)) , sign = +1 or -1 to your data. The graph of the equation is a logarithmic curve moved horizontally by c and possibly mirrored across the y-axis (if sign = -1).</para>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><function>LOGFIT</function> returns an array having five columns and one row. `Sign' is given in the first column, `a', `b', and `c' are given in columns 2 to 4. Column 5 holds the sum of squared residuals.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>An error is returned when there are less than 3 different x's or y's, or when the shape of the point cloud is too different from a ``logarithmic'' one.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>You can use the above formula = a + b * ln(sign * (x - c)) or rearrange it to = (exp((y - a) / b)) / sign + c to compute unknown y's or x's, respectively. </para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This is non-linear fitting by trial-and-error. The accuracy of `c' is: width of x-range -> rounded to the next smaller (10^integer), times 0.000001. There might be cases in which the returned fit is not the best possible.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOGREG"><function>LOGREG</function></link>,
- <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
- <link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOGINV">
- <refmeta>
- <refentrytitle>
- <function>LOGINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOGINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOGFIT</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LOGFIT</function> function applies the ``least squares'' method to fit the logarithmic equation y = a + b * ln(sign * (x - c)) , sign = +1 or -1 to your data. The graph of the equation is a logarithmic curve moved horizontally by c and possibly mirrored across the y-axis (if sign = -1).</para>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LOGFIT</function> returns an array having five columns and one row. `Sign' is given in the first column, `a', `b', and `c' are given in columns 2 to 4. Column 5 holds the sum of squared residuals.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>An error is returned when there are less than 3 different x's or y's, or when the shape of the point cloud is too different from a ``logarithmic'' one.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>You can use the above formula = a + b * ln(sign * (x - c)) or rearrange it to = (exp((y - a) / b)) / sign + c to compute unknown y's or x's, respectively. </para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This is non-linear fitting by trial-and-error. The accuracy of `c' is: width of x-range -> rounded to the next smaller (10^integer), times 0.000001. There might be cases in which the returned fit is not the best possible.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOGREG"><function>LOGREG</function></link>,
+ <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
+ <link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOGINV">
+ <refmeta>
+ <refentrytitle>
+ <function>LOGINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOGINV</function>
+ </refname>
+ <refpurpose>
inverse of the cumulative distribution function of the lognormal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOGINV</function>(<parameter>p</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>mean</parameter>: mean</para>
- <para><parameter>stddev</parameter>: standard deviation</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>stddev</parameter> <= 0 this function returns #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
- <link linkend="gnumeric-LN"><function>LN</function></link>,
- <link linkend="gnumeric-LOG"><function>LOG</function></link>,
- <link linkend="gnumeric-LOG10"><function>LOG10</function></link>,
- <link linkend="gnumeric-LOGNORMDIST"><function>LOGNORMDIST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOGISTIC">
- <refmeta>
- <refentrytitle>
- <function>LOGISTIC</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOGISTIC</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOGINV</function>(<parameter>p</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>mean</parameter>: mean</para>
+ <para><parameter>stddev</parameter>: standard deviation</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>stddev</parameter> <= 0 this function returns #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
+ <link linkend="gnumeric-LN"><function>LN</function></link>,
+ <link linkend="gnumeric-LOG"><function>LOG</function></link>,
+ <link linkend="gnumeric-LOG10"><function>LOG10</function></link>,
+ <link linkend="gnumeric-LOGNORMDIST"><function>LOGNORMDIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOGISTIC">
+ <refmeta>
+ <refentrytitle>
+ <function>LOGISTIC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOGISTIC</function>
+ </refname>
+ <refpurpose>
probability density function of the logistic distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDLOGISTIC"><function>RANDLOGISTIC</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>LOGISTIC</function>(<parameter>x</parameter>,<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>a</parameter>: scale parameter</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-LOGNORMDIST">
- <refmeta>
- <refentrytitle>
- <function>LOGNORMDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOGNORMDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDLOGISTIC"><function>RANDLOGISTIC</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>LOGISTIC</function>(<parameter>x</parameter>,<parameter>a</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>a</parameter>: scale parameter</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOGNORMDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>LOGNORMDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOGNORMDIST</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the lognormal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOGNORMDIST</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>mean</parameter>: mean</para>
- <para><parameter>stddev</parameter>: standard deviation</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>stddev</parameter> = 0 <function>LOGNORMDIST</function> returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> <= 0, <parameter>mean</parameter> < 0 or <parameter>stddev</parameter> <= 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LOGREG">
- <refmeta>
- <refentrytitle>
- <function>LOGREG</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOGREG</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOGNORMDIST</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>mean</parameter>: mean</para>
+ <para><parameter>stddev</parameter>: standard deviation</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>stddev</parameter> = 0 <function>LOGNORMDIST</function> returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> <= 0, <parameter>mean</parameter> < 0 or <parameter>stddev</parameter> <= 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOGREG">
+ <refmeta>
+ <refentrytitle>
+ <function>LOGREG</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOGREG</function>
+ </refname>
+ <refpurpose>
the logarithmic regression
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LOGREG</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>const</parameter>,<parameter>stat</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOGREG</function> function transforms your x's to z=ln(x) and applies the ``least squares'' method to fit the linear equation y = m * z + b to your y's and z's --- equivalent to fitting the equation y = m * ln(x) + b to y's and x's. <function>LOGREG</function> returns an array having two columns and one row. m is given in the first column and b in the second. </para>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
- <para><parameter>const</parameter>: If this is FALSE, the curve will be forced to go through [1; 0], i.e., b will be zero. The default is TRUE.</para>
- <para><parameter>stat</parameter>: If <parameter>stat</parameter> is TRUE, extra statistical information will be returned; defaults to FALSE.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Any extra statistical information is written below m and b in the result array. This extra statistical information consists of four rows of data: In the first row the standard error values for the coefficients m, b are given. The second row contains the square of R and the standard error for the y estimate. The third row contains the F-observed value and the degrees of freedom. The last row contains the regression sum of squares and the residual sum of squares.The default of <parameter>stat</parameter> is FALSE.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOGFIT"><function>LOGFIT</function></link>,
- <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
- <link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MAX">
- <refmeta>
- <refentrytitle>
- <function>MAX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MAX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LOGREG</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>const</parameter>,<parameter>stat</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>LOGREG</function> function transforms your x's to z=ln(x) and applies the ``least squares'' method to fit the linear equation y = m * z + b to your y's and z's --- equivalent to fitting the equation y = m * ln(x) + b to y's and x's. <function>LOGREG</function> returns an array having two columns and one row. m is given in the first column and b in the second. </para>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
+ <para><parameter>const</parameter>: If this is FALSE, the curve will be forced to go through [1; 0], i.e., b will be zero. The default is TRUE.</para>
+ <para><parameter>stat</parameter>: If <parameter>stat</parameter> is TRUE, extra statistical information will be returned; defaults to FALSE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Any extra statistical information is written below m and b in the result array. This extra statistical information consists of four rows of data: In the first row the standard error values for the coefficients m, b are given. The second row contains the square of R and the standard error for the y estimate. The third row contains the F-observed value and the degrees of freedom. The last row contains the regression sum of squares and the residual sum of squares.The default of <parameter>stat</parameter> is FALSE.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOGFIT"><function>LOGFIT</function></link>,
+ <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
+ <link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MAX">
+ <refmeta>
+ <refentrytitle>
+ <function>MAX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MAX</function>
+ </refname>
+ <refpurpose>
largest value, with negative numbers considered smaller than positive numbers.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MAX</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MAXA">
- <refmeta>
- <refentrytitle>
- <function>MAXA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MAXA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MAX</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MAXA">
+ <refmeta>
+ <refentrytitle>
+ <function>MAXA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MAXA</function>
+ </refname>
+ <refpurpose>
largest value, with negative numbers considered smaller than positive numbers.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MAXA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MAX"><function>MAX</function></link>,
- <link linkend="gnumeric-MINA"><function>MINA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MEDIAN">
- <refmeta>
- <refentrytitle>
- <function>MEDIAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MEDIAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MAXA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MAX"><function>MAX</function></link>,
+ <link linkend="gnumeric-MINA"><function>MINA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MEDIAN">
+ <refmeta>
+ <refentrytitle>
+ <function>MEDIAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MEDIAN</function>
+ </refname>
+ <refpurpose>
median of a data set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MEDIAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If even numbers are given <function>MEDIAN</function> returns the average of the two numbers in the center.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-COUNTA"><function>COUNTA</function></link>,
- <link linkend="gnumeric-DAVERAGE"><function>DAVERAGE</function></link>,
- <link linkend="gnumeric-MODE"><function>MODE</function></link>,
- <link linkend="gnumeric-SSMEDIAN"><function>SSMEDIAN</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MIN">
- <refmeta>
- <refentrytitle>
- <function>MIN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MIN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MEDIAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If even numbers are given <function>MEDIAN</function> returns the average of the two numbers in the center.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-COUNTA"><function>COUNTA</function></link>,
+ <link linkend="gnumeric-DAVERAGE"><function>DAVERAGE</function></link>,
+ <link linkend="gnumeric-MODE"><function>MODE</function></link>,
+ <link linkend="gnumeric-SSMEDIAN"><function>SSMEDIAN</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MIN">
+ <refmeta>
+ <refentrytitle>
+ <function>MIN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MIN</function>
+ </refname>
+ <refpurpose>
smallest value, with negative numbers considered smaller than positive numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MAX"><function>MAX</function></link>,
- <link linkend="gnumeric-ABS"><function>ABS</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MIN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MINA">
- <refmeta>
- <refentrytitle>
- <function>MINA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MINA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MAX"><function>MAX</function></link>,
+ <link linkend="gnumeric-ABS"><function>ABS</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MIN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MINA">
+ <refmeta>
+ <refentrytitle>
+ <function>MINA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MINA</function>
+ </refname>
+ <refpurpose>
smallest value, with negative numbers considered smaller than positive numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MINA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
- <link linkend="gnumeric-MAXA"><function>MAXA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-MODE">
- <refmeta>
- <refentrytitle>
- <function>MODE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MODE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MINA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
+ <link linkend="gnumeric-MAXA"><function>MAXA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MODE">
+ <refmeta>
+ <refentrytitle>
+ <function>MODE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MODE</function>
+ </refname>
+ <refpurpose>
first most common number in the dataset
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MODE</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>If the data set does not contain any duplicates this function returns a #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NEGBINOMDIST">
- <refmeta>
- <refentrytitle>
- <function>NEGBINOMDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NEGBINOMDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MODE</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>If the data set does not contain any duplicates this function returns a #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NEGBINOMDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>NEGBINOMDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NEGBINOMDIST</function>
+ </refname>
+ <refpurpose>
probability mass function of the negative binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NEGBINOMDIST</function>(<parameter>f</parameter>,<parameter>t</parameter>,<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>f</parameter>: number of failures</para>
- <para><parameter>t</parameter>: threshold number of successes</para>
- <para><parameter>p</parameter>: probability of a success</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>f</parameter> or <parameter>t</parameter> is a non-integer it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If (<parameter>f</parameter> + <parameter>t</parameter> -1) <= 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this functions returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
- <link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>,
- <link linkend="gnumeric-FACT"><function>FACT</function></link>,
- <link linkend="gnumeric-HYPGEOMDIST"><function>HYPGEOMDIST</function></link>,
- <link linkend="gnumeric-PERMUT"><function>PERMUT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NORMDIST">
- <refmeta>
- <refentrytitle>
- <function>NORMDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NORMDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NEGBINOMDIST</function>(<parameter>f</parameter>,<parameter>t</parameter>,<parameter>p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>f</parameter>: number of failures</para>
+ <para><parameter>t</parameter>: threshold number of successes</para>
+ <para><parameter>p</parameter>: probability of a success</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>f</parameter> or <parameter>t</parameter> is a non-integer it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If (<parameter>f</parameter> + <parameter>t</parameter> -1) <= 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this functions returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
+ <link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>,
+ <link linkend="gnumeric-FACT"><function>FACT</function></link>,
+ <link linkend="gnumeric-HYPGEOMDIST"><function>HYPGEOMDIST</function></link>,
+ <link linkend="gnumeric-PERMUT"><function>PERMUT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NORMDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>NORMDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NORMDIST</function>
+ </refname>
+ <refpurpose>
(cumulative) probability density function of a normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NORMDIST</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>mean</parameter>: mean of the distribution</para>
- <para><parameter>stddev</parameter>: standard deviation of the distribution</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>stddev</parameter> is 0 this function returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NORMINV">
- <refmeta>
- <refentrytitle>
- <function>NORMINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NORMINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NORMDIST</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>mean</parameter>: mean of the distribution</para>
+ <para><parameter>stddev</parameter>: standard deviation of the distribution</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>stddev</parameter> is 0 this function returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NORMINV">
+ <refmeta>
+ <refentrytitle>
+ <function>NORMINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NORMINV</function>
+ </refname>
+ <refpurpose>
inverse of the cumulative distribution function of a normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NORMINV</function>(<parameter>p</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>mean</parameter>: mean of the distribution</para>
- <para><parameter>stddev</parameter>: standard deviation of the distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>stddev</parameter> <= 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
- <link linkend="gnumeric-NORMSDIST"><function>NORMSDIST</function></link>,
- <link linkend="gnumeric-NORMSINV"><function>NORMSINV</function></link>,
- <link linkend="gnumeric-STANDARDIZE"><function>STANDARDIZE</function></link>,
- <link linkend="gnumeric-ZTEST"><function>ZTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NORMSDIST">
- <refmeta>
- <refentrytitle>
- <function>NORMSDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NORMSDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NORMINV</function>(<parameter>p</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>mean</parameter>: mean of the distribution</para>
+ <para><parameter>stddev</parameter>: standard deviation of the distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>stddev</parameter> <= 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
+ <link linkend="gnumeric-NORMSDIST"><function>NORMSDIST</function></link>,
+ <link linkend="gnumeric-NORMSINV"><function>NORMSINV</function></link>,
+ <link linkend="gnumeric-STANDARDIZE"><function>STANDARDIZE</function></link>,
+ <link linkend="gnumeric-ZTEST"><function>ZTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NORMSDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>NORMSDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NORMSDIST</function>
+ </refname>
+ <refpurpose>
cumulative density function of the standard normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>NORMSDIST</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-NORMSINV">
- <refmeta>
- <refentrytitle>
- <function>NORMSINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NORMSINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>NORMSDIST</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NORMSINV">
+ <refmeta>
+ <refentrytitle>
+ <function>NORMSINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NORMSINV</function>
+ </refname>
+ <refpurpose>
inverse of the cumulative density function of the standard normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NORMSINV</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>p</parameter>: given probability</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
- <link linkend="gnumeric-NORMINV"><function>NORMINV</function></link>,
- <link linkend="gnumeric-NORMSDIST"><function>NORMSDIST</function></link>,
- <link linkend="gnumeric-STANDARDIZE"><function>STANDARDIZE</function></link>,
- <link linkend="gnumeric-ZTEST"><function>ZTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PARETO">
- <refmeta>
- <refentrytitle>
- <function>PARETO</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PARETO</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NORMSINV</function>(<parameter>p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>p</parameter>: given probability</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
+ <link linkend="gnumeric-NORMINV"><function>NORMINV</function></link>,
+ <link linkend="gnumeric-NORMSDIST"><function>NORMSDIST</function></link>,
+ <link linkend="gnumeric-STANDARDIZE"><function>STANDARDIZE</function></link>,
+ <link linkend="gnumeric-ZTEST"><function>ZTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PARETO">
+ <refmeta>
+ <refentrytitle>
+ <function>PARETO</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PARETO</function>
+ </refname>
+ <refpurpose>
probability density function of the pareto distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDPARETO"><function>RANDPARETO</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>PARETO</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>a</parameter>: exponent</para>
- <para><parameter>b</parameter>: scale parameter</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-PEARSON">
- <refmeta>
- <refentrytitle>
- <function>PEARSON</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PEARSON</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDPARETO"><function>RANDPARETO</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>PARETO</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>a</parameter>: exponent</para>
+ <para><parameter>b</parameter>: scale parameter</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PEARSON">
+ <refmeta>
+ <refentrytitle>
+ <function>PEARSON</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PEARSON</function>
+ </refname>
+ <refpurpose>
Pearson correlation coefficient of the paired set of data
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PEARSON</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>array1</parameter>: first component values</para>
- <para><parameter>array2</parameter>: second component values</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INTERCEPT"><function>INTERCEPT</function></link>,
- <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
- <link linkend="gnumeric-RSQ"><function>RSQ</function></link>,
- <link linkend="gnumeric-SLOPE"><function>SLOPE</function></link>,
- <link linkend="gnumeric-STEYX"><function>STEYX</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PERCENTILE">
- <refmeta>
- <refentrytitle>
- <function>PERCENTILE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PERCENTILE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PEARSON</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>array1</parameter>: first component values</para>
+ <para><parameter>array2</parameter>: second component values</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-INTERCEPT"><function>INTERCEPT</function></link>,
+ <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
+ <link linkend="gnumeric-RSQ"><function>RSQ</function></link>,
+ <link linkend="gnumeric-SLOPE"><function>SLOPE</function></link>,
+ <link linkend="gnumeric-STEYX"><function>STEYX</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PERCENTILE">
+ <refmeta>
+ <refentrytitle>
+ <function>PERCENTILE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PERCENTILE</function>
+ </refname>
+ <refpurpose>
determines the 100*<parameter>k</parameter>-th percentile of the given data points
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PERCENTILE</function>(<parameter>array</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>array</parameter>: data points</para>
- <para><parameter>k</parameter>: which percentile to calculate</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>array</parameter> is empty, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>k</parameter> < 0 or <parameter>k</parameter> > 1, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PERCENTRANK">
- <refmeta>
- <refentrytitle>
- <function>PERCENTRANK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PERCENTRANK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PERCENTILE</function>(<parameter>array</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>array</parameter>: data points</para>
+ <para><parameter>k</parameter>: which percentile to calculate</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>array</parameter> is empty, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>k</parameter> < 0 or <parameter>k</parameter> > 1, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PERCENTRANK">
+ <refmeta>
+ <refentrytitle>
+ <function>PERCENTRANK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PERCENTRANK</function>
+ </refname>
+ <refpurpose>
rank of a data point in a data set.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PERCENTRANK</function>(<parameter>array</parameter>,<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>array</parameter>: range of numeric values</para>
- <para><parameter>x</parameter>: data point to be ranked</para>
- <para><parameter>significance</parameter>: number of significant digits, defaults to 3</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>array</parameter> contains no data points, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>significance</parameter> is less than one, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> exceeds the largest value or is less than the smallest value in <parameter>array</parameter>, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> does not match any of the values in <parameter>array</parameter> or <parameter>x</parameter> matches more than once, this function interpolates the returned value.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LARGE"><function>LARGE</function></link>,
- <link linkend="gnumeric-MAX"><function>MAX</function></link>,
- <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
- <link linkend="gnumeric-MIN"><function>MIN</function></link>,
- <link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
- <link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>,
- <link linkend="gnumeric-SMALL"><function>SMALL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PERMUT">
- <refmeta>
- <refentrytitle>
- <function>PERMUT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PERMUT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PERCENTRANK</function>(<parameter>array</parameter>,<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>array</parameter>: range of numeric values</para>
+ <para><parameter>x</parameter>: data point to be ranked</para>
+ <para><parameter>significance</parameter>: number of significant digits, defaults to 3</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>array</parameter> contains no data points, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>significance</parameter> is less than one, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> exceeds the largest value or is less than the smallest value in <parameter>array</parameter>, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> does not match any of the values in <parameter>array</parameter> or <parameter>x</parameter> matches more than once, this function interpolates the returned value.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LARGE"><function>LARGE</function></link>,
+ <link linkend="gnumeric-MAX"><function>MAX</function></link>,
+ <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
+ <link linkend="gnumeric-MIN"><function>MIN</function></link>,
+ <link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
+ <link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>,
+ <link linkend="gnumeric-SMALL"><function>SMALL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PERMUT">
+ <refmeta>
+ <refentrytitle>
+ <function>PERMUT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PERMUT</function>
+ </refname>
+ <refpurpose>
number of <parameter>k</parameter>-permutations of a <parameter>n</parameter>-set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PERMUT</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>n</parameter>: size of the base set</para>
- <para><parameter>k</parameter>: number of elements in each permutation</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> = 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>n</parameter> < <parameter>k</parameter> this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PERMUTATIONA">
- <refmeta>
- <refentrytitle>
- <function>PERMUTATIONA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PERMUTATIONA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PERMUT</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>n</parameter>: size of the base set</para>
+ <para><parameter>k</parameter>: number of elements in each permutation</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> = 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>n</parameter> < <parameter>k</parameter> this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PERMUTATIONA">
+ <refmeta>
+ <refentrytitle>
+ <function>PERMUTATIONA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PERMUTATIONA</function>
+ </refname>
+ <refpurpose>
the number of permutations of <parameter>y</parameter> objects chosen from <parameter>x</parameter> objects with repetition allowed.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PERMUTATIONA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: total number of objects</para>
- <para><parameter>y</parameter>: number of selected objects</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If both <parameter>x</parameter> and <parameter>y</parameter> equal 0, <function>PERMUTATIONA</function> returns 1.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 or <parameter>y</parameter> < 0, <function>PERMUTATIONA</function> returns #NUM!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> or <parameter>y</parameter> are not integers, they are truncated</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POWER"><function>POWER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-POISSON">
- <refmeta>
- <refentrytitle>
- <function>POISSON</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>POISSON</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PERMUTATIONA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: total number of objects</para>
+ <para><parameter>y</parameter>: number of selected objects</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If both <parameter>x</parameter> and <parameter>y</parameter> equal 0, <function>PERMUTATIONA</function> returns 1.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 or <parameter>y</parameter> < 0, <function>PERMUTATIONA</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> or <parameter>y</parameter> are not integers, they are truncated</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-POWER"><function>POWER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-POISSON">
+ <refmeta>
+ <refentrytitle>
+ <function>POISSON</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>POISSON</function>
+ </refname>
+ <refpurpose>
(cumulative) probability mass function of the Poisson distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>POISSON</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number of events</para>
- <para><parameter>mean</parameter>: mean of the distribution</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> is a non-integer it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>mean</parameter> <= 0 <function>POISSON</function> returns the #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
- <link linkend="gnumeric-WEIBULL"><function>WEIBULL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PROB">
- <refmeta>
- <refentrytitle>
- <function>PROB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PROB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>POISSON</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number of events</para>
+ <para><parameter>mean</parameter>: mean of the distribution</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the mass function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> is a non-integer it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>mean</parameter> <= 0 <function>POISSON</function> returns the #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
+ <link linkend="gnumeric-WEIBULL"><function>WEIBULL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PROB">
+ <refmeta>
+ <refentrytitle>
+ <function>PROB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PROB</function>
+ </refname>
+ <refpurpose>
probability of an interval for a discrete (and finite) probability distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PROB</function>(<parameter>x_range</parameter>,<parameter>prob_range</parameter>,<parameter>lower_limit</parameter>,<parameter>upper_limit</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x_range</parameter>: possible values</para>
- <para><parameter>prob_range</parameter>: probabilities of the corresponding values</para>
- <para><parameter>lower_limit</parameter>: lower interval limit</para>
- <para><parameter>upper_limit</parameter>: upper interval limit, defaults to <parameter>lower_limit</parameter></para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the sum of the probabilities in <parameter>prob_range</parameter> is not equal to 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If any value in <parameter>prob_range</parameter> is <=0 or > 1, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x_range</parameter> and <parameter>prob_range</parameter> contain a different number of data entries, this function returns a #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
- <link linkend="gnumeric-CRITBINOM"><function>CRITBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-QUARTILE">
- <refmeta>
- <refentrytitle>
- <function>QUARTILE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>QUARTILE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PROB</function>(<parameter>x_range</parameter>,<parameter>prob_range</parameter>,<parameter>lower_limit</parameter>,<parameter>upper_limit</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x_range</parameter>: possible values</para>
+ <para><parameter>prob_range</parameter>: probabilities of the corresponding values</para>
+ <para><parameter>lower_limit</parameter>: lower interval limit</para>
+ <para><parameter>upper_limit</parameter>: upper interval limit, defaults to <parameter>lower_limit</parameter></para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the sum of the probabilities in <parameter>prob_range</parameter> is not equal to 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If any value in <parameter>prob_range</parameter> is <=0 or > 1, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x_range</parameter> and <parameter>prob_range</parameter> contain a different number of data entries, this function returns a #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
+ <link linkend="gnumeric-CRITBINOM"><function>CRITBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-QUARTILE">
+ <refmeta>
+ <refentrytitle>
+ <function>QUARTILE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>QUARTILE</function>
+ </refname>
+ <refpurpose>
the <parameter>k</parameter>-th quartile of the data points
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>QUARTILE</function>(<parameter>array</parameter>,<parameter>quart</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>array</parameter>: data points</para>
- <para><parameter>quart</parameter>: A number from 0 to 4, indicating which quartile to calculate. A value of 0 causes the smallest value of <parameter>array</parameter> to be returned.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>array</parameter> is empty, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>quart</parameter> < 0 or <parameter>quart</parameter> > 4, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>quart</parameter> is not an integer, it is truncated.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LARGE"><function>LARGE</function></link>,
- <link linkend="gnumeric-MAX"><function>MAX</function></link>,
- <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
- <link linkend="gnumeric-MIN"><function>MIN</function></link>,
- <link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
- <link linkend="gnumeric-SMALL"><function>SMALL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DBETA">
- <refmeta>
- <refentrytitle>
- <function>R.DBETA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DBETA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>QUARTILE</function>(<parameter>array</parameter>,<parameter>quart</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>array</parameter>: data points</para>
+ <para><parameter>quart</parameter>: A number from 0 to 4, indicating which quartile to calculate. A value of 0 causes the smallest value of <parameter>array</parameter> to be returned.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>array</parameter> is empty, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>quart</parameter> < 0 or <parameter>quart</parameter> > 4, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>quart</parameter> is not an integer, it is truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LARGE"><function>LARGE</function></link>,
+ <link linkend="gnumeric-MAX"><function>MAX</function></link>,
+ <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
+ <link linkend="gnumeric-MIN"><function>MIN</function></link>,
+ <link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
+ <link linkend="gnumeric-SMALL"><function>SMALL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DBETA">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DBETA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DBETA</function>
+ </refname>
+ <refpurpose>
probability density function of the beta distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DBETA</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the beta distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>a</parameter>: the first shape parameter of the distribution</para>
- <para><parameter>b</parameter>: the second scale parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PBETA"><function>R.PBETA</function></link>,
- <link linkend="gnumeric-R.QBETA"><function>R.QBETA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DBINOM">
- <refmeta>
- <refentrytitle>
- <function>R.DBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DBETA</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the beta distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>a</parameter>: the first shape parameter of the distribution</para>
+ <para><parameter>b</parameter>: the second scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PBETA"><function>R.PBETA</function></link>,
+ <link linkend="gnumeric-R.QBETA"><function>R.QBETA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DBINOM</function>
+ </refname>
+ <refpurpose>
probability density function of the binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the binomial distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of trials</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>,
- <link linkend="gnumeric-R.QBINOM"><function>R.QBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DCAUCHY">
- <refmeta>
- <refentrytitle>
- <function>R.DCAUCHY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DCAUCHY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the binomial distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of trials</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>,
+ <link linkend="gnumeric-R.QBINOM"><function>R.QBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DCAUCHY">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DCAUCHY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DCAUCHY</function>
+ </refname>
+ <refpurpose>
probability density function of the Cauchy distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DCAUCHY</function>(<parameter>x</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the Cauchy distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>location</parameter>: the center of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PCAUCHY"><function>R.PCAUCHY</function></link>,
- <link linkend="gnumeric-R.QCAUCHY"><function>R.QCAUCHY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DCHISQ">
- <refmeta>
- <refentrytitle>
- <function>R.DCHISQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DCHISQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DCAUCHY</function>(<parameter>x</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the Cauchy distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>location</parameter>: the center of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PCAUCHY"><function>R.PCAUCHY</function></link>,
+ <link linkend="gnumeric-R.QCAUCHY"><function>R.QCAUCHY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DCHISQ">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DCHISQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DCHISQ</function>
+ </refname>
+ <refpurpose>
probability density function of the chi-square distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DCHISQ</function>(<parameter>x</parameter>,<parameter>df</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the chi-square distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>df</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PCHISQ"><function>R.PCHISQ</function></link>,
- <link linkend="gnumeric-R.QCHISQ"><function>R.QCHISQ</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DEXP">
- <refmeta>
- <refentrytitle>
- <function>R.DEXP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DEXP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DCHISQ</function>(<parameter>x</parameter>,<parameter>df</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the chi-square distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>df</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PCHISQ"><function>R.PCHISQ</function></link>,
+ <link linkend="gnumeric-R.QCHISQ"><function>R.QCHISQ</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DEXP">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DEXP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DEXP</function>
+ </refname>
+ <refpurpose>
probability density function of the exponential distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DEXP</function>(<parameter>x</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the exponential distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PEXP"><function>R.PEXP</function></link>,
- <link linkend="gnumeric-R.QEXP"><function>R.QEXP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DF">
- <refmeta>
- <refentrytitle>
- <function>R.DF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DEXP</function>(<parameter>x</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the exponential distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PEXP"><function>R.PEXP</function></link>,
+ <link linkend="gnumeric-R.QEXP"><function>R.QEXP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DF">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DF</function>
+ </refname>
+ <refpurpose>
probability density function of the F distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DF</function>(<parameter>x</parameter>,<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the F distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n1</parameter>: the first number of degrees of freedom of the distribution</para>
- <para><parameter>n2</parameter>: the second number of degrees of freedom of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PF"><function>R.PF</function></link>,
- <link linkend="gnumeric-R.QF"><function>R.QF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DGAMMA">
- <refmeta>
- <refentrytitle>
- <function>R.DGAMMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DGAMMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DF</function>(<parameter>x</parameter>,<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the F distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n1</parameter>: the first number of degrees of freedom of the distribution</para>
+ <para><parameter>n2</parameter>: the second number of degrees of freedom of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PF"><function>R.PF</function></link>,
+ <link linkend="gnumeric-R.QF"><function>R.QF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DGAMMA">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DGAMMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DGAMMA</function>
+ </refname>
+ <refpurpose>
probability density function of the gamma distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DGAMMA</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the gamma distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PGAMMA"><function>R.PGAMMA</function></link>,
- <link linkend="gnumeric-R.QGAMMA"><function>R.QGAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DGEOM">
- <refmeta>
- <refentrytitle>
- <function>R.DGEOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DGEOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DGAMMA</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the gamma distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PGAMMA"><function>R.PGAMMA</function></link>,
+ <link linkend="gnumeric-R.QGAMMA"><function>R.QGAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DGEOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DGEOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DGEOM</function>
+ </refname>
+ <refpurpose>
probability density function of the geometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DGEOM</function>(<parameter>x</parameter>,<parameter>psuc</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the geometric distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PGEOM"><function>R.PGEOM</function></link>,
- <link linkend="gnumeric-R.QGEOM"><function>R.QGEOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DHYPER">
- <refmeta>
- <refentrytitle>
- <function>R.DHYPER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DHYPER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DGEOM</function>(<parameter>x</parameter>,<parameter>psuc</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the geometric distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PGEOM"><function>R.PGEOM</function></link>,
+ <link linkend="gnumeric-R.QGEOM"><function>R.QGEOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DHYPER">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DHYPER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DHYPER</function>
+ </refname>
+ <refpurpose>
probability density function of the hypergeometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DHYPER</function>(<parameter>x</parameter>,<parameter>r</parameter>,<parameter>b</parameter>,<parameter>n</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the hypergeometric distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>r</parameter>: the number of red balls</para>
- <para><parameter>b</parameter>: the number of black balls</para>
- <para><parameter>n</parameter>: the number of balls drawn</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PHYPER"><function>R.PHYPER</function></link>,
- <link linkend="gnumeric-R.QHYPER"><function>R.QHYPER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DLNORM">
- <refmeta>
- <refentrytitle>
- <function>R.DLNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DLNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DHYPER</function>(<parameter>x</parameter>,<parameter>r</parameter>,<parameter>b</parameter>,<parameter>n</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the hypergeometric distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>r</parameter>: the number of red balls</para>
+ <para><parameter>b</parameter>: the number of black balls</para>
+ <para><parameter>n</parameter>: the number of balls drawn</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PHYPER"><function>R.PHYPER</function></link>,
+ <link linkend="gnumeric-R.QHYPER"><function>R.QHYPER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DLNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DLNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DLNORM</function>
+ </refname>
+ <refpurpose>
probability density function of the log-normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DLNORM</function>(<parameter>x</parameter>,<parameter>logmean</parameter>,<parameter>logsd</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the log-normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>logmean</parameter>: mean of the underlying normal distribution</para>
- <para><parameter>logsd</parameter>: standard deviation of the underlying normal distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PLNORM"><function>R.PLNORM</function></link>,
- <link linkend="gnumeric-R.QLNORM"><function>R.QLNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DNBINOM">
- <refmeta>
- <refentrytitle>
- <function>R.DNBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DNBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DLNORM</function>(<parameter>x</parameter>,<parameter>logmean</parameter>,<parameter>logsd</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the log-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>logmean</parameter>: mean of the underlying normal distribution</para>
+ <para><parameter>logsd</parameter>: standard deviation of the underlying normal distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PLNORM"><function>R.PLNORM</function></link>,
+ <link linkend="gnumeric-R.QLNORM"><function>R.QLNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DNBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DNBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DNBINOM</function>
+ </refname>
+ <refpurpose>
probability density function of the negative binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DNBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the negative binomial distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of trials</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PNBINOM"><function>R.PNBINOM</function></link>,
- <link linkend="gnumeric-R.QNBINOM"><function>R.QNBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DNORM">
- <refmeta>
- <refentrytitle>
- <function>R.DNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DNBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the negative binomial distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of trials</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PNBINOM"><function>R.PNBINOM</function></link>,
+ <link linkend="gnumeric-R.QNBINOM"><function>R.QNBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DNORM</function>
+ </refname>
+ <refpurpose>
probability density function of the normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DNORM</function>(<parameter>x</parameter>,<parameter>mu</parameter>,<parameter>sigma</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>mu</parameter>: mean of the distribution</para>
- <para><parameter>sigma</parameter>: standard deviation of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PNORM"><function>R.PNORM</function></link>,
- <link linkend="gnumeric-R.QNORM"><function>R.QNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DPOIS">
- <refmeta>
- <refentrytitle>
- <function>R.DPOIS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DPOIS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DNORM</function>(<parameter>x</parameter>,<parameter>mu</parameter>,<parameter>sigma</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>mu</parameter>: mean of the distribution</para>
+ <para><parameter>sigma</parameter>: standard deviation of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PNORM"><function>R.PNORM</function></link>,
+ <link linkend="gnumeric-R.QNORM"><function>R.QNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DPOIS">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DPOIS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DPOIS</function>
+ </refname>
+ <refpurpose>
probability density function of the Poisson distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DPOIS</function>(<parameter>x</parameter>,<parameter>lambda</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the Poisson distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>lambda</parameter>: the mean of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PPOIS"><function>R.PPOIS</function></link>,
- <link linkend="gnumeric-R.QPOIS"><function>R.QPOIS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DSNORM">
- <refmeta>
- <refentrytitle>
- <function>R.DSNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DSNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DPOIS</function>(<parameter>x</parameter>,<parameter>lambda</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the Poisson distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>lambda</parameter>: the mean of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PPOIS"><function>R.PPOIS</function></link>,
+ <link linkend="gnumeric-R.QPOIS"><function>R.QPOIS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DSNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DSNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DSNORM</function>
+ </refname>
+ <refpurpose>
probability density function of the skew-normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DSNORM</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the skew-normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>location</parameter>: the location parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PSNORM"><function>R.PSNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DST">
- <refmeta>
- <refentrytitle>
- <function>R.DST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DSNORM</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the skew-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>location</parameter>: the location parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PSNORM"><function>R.PSNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DST">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DST</function>
+ </refname>
+ <refpurpose>
probability density function of the skew-t distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DST</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>shape</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the skew-t distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DT">
- <refmeta>
- <refentrytitle>
- <function>R.DT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DST</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>shape</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the skew-t distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DT">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DT</function>
+ </refname>
+ <refpurpose>
probability density function of the Student t distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DT</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the Student t distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PT"><function>R.PT</function></link>,
- <link linkend="gnumeric-R.QT"><function>R.QT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.DWEIBULL">
- <refmeta>
- <refentrytitle>
- <function>R.DWEIBULL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.DWEIBULL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DT</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the Student t distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PT"><function>R.PT</function></link>,
+ <link linkend="gnumeric-R.QT"><function>R.QT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DWEIBULL">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DWEIBULL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DWEIBULL</function>
+ </refname>
+ <refpurpose>
probability density function of the Weibull distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.DWEIBULL</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability density function of the Weibull distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.PWEIBULL"><function>R.PWEIBULL</function></link>,
- <link linkend="gnumeric-R.QWEIBULL"><function>R.QWEIBULL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PBETA">
- <refmeta>
- <refentrytitle>
- <function>R.PBETA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PBETA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DWEIBULL</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the Weibull distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PWEIBULL"><function>R.PWEIBULL</function></link>,
+ <link linkend="gnumeric-R.QWEIBULL"><function>R.QWEIBULL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PBETA">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PBETA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PBETA</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the beta distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PBETA</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the beta distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>a</parameter>: the first shape parameter of the distribution</para>
- <para><parameter>b</parameter>: the second scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DBETA"><function>R.DBETA</function></link>,
- <link linkend="gnumeric-R.QBETA"><function>R.QBETA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PBINOM">
- <refmeta>
- <refentrytitle>
- <function>R.PBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PBETA</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the beta distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>a</parameter>: the first shape parameter of the distribution</para>
+ <para><parameter>b</parameter>: the second scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DBETA"><function>R.DBETA</function></link>,
+ <link linkend="gnumeric-R.QBETA"><function>R.QBETA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PBINOM</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the binomial distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of trials</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DBINOM"><function>R.DBINOM</function></link>,
- <link linkend="gnumeric-R.QBINOM"><function>R.QBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PCAUCHY">
- <refmeta>
- <refentrytitle>
- <function>R.PCAUCHY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PCAUCHY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the binomial distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of trials</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DBINOM"><function>R.DBINOM</function></link>,
+ <link linkend="gnumeric-R.QBINOM"><function>R.QBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PCAUCHY">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PCAUCHY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PCAUCHY</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the Cauchy distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PCAUCHY</function>(<parameter>x</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the Cauchy distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>location</parameter>: the center of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DCAUCHY"><function>R.DCAUCHY</function></link>,
- <link linkend="gnumeric-R.QCAUCHY"><function>R.QCAUCHY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PCHISQ">
- <refmeta>
- <refentrytitle>
- <function>R.PCHISQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PCHISQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PCAUCHY</function>(<parameter>x</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the Cauchy distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>location</parameter>: the center of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DCAUCHY"><function>R.DCAUCHY</function></link>,
+ <link linkend="gnumeric-R.QCAUCHY"><function>R.QCAUCHY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PCHISQ">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PCHISQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PCHISQ</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the chi-square distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PCHISQ</function>(<parameter>x</parameter>,<parameter>df</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the chi-square distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>df</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DCHISQ"><function>R.DCHISQ</function></link>,
- <link linkend="gnumeric-R.QCHISQ"><function>R.QCHISQ</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PEXP">
- <refmeta>
- <refentrytitle>
- <function>R.PEXP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PEXP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PCHISQ</function>(<parameter>x</parameter>,<parameter>df</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the chi-square distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>df</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DCHISQ"><function>R.DCHISQ</function></link>,
+ <link linkend="gnumeric-R.QCHISQ"><function>R.QCHISQ</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PEXP">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PEXP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PEXP</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the exponential distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PEXP</function>(<parameter>x</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the exponential distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DEXP"><function>R.DEXP</function></link>,
- <link linkend="gnumeric-R.QEXP"><function>R.QEXP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PF">
- <refmeta>
- <refentrytitle>
- <function>R.PF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PEXP</function>(<parameter>x</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the exponential distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DEXP"><function>R.DEXP</function></link>,
+ <link linkend="gnumeric-R.QEXP"><function>R.QEXP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PF">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PF</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the F distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PF</function>(<parameter>x</parameter>,<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the F distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n1</parameter>: the first number of degrees of freedom of the distribution</para>
- <para><parameter>n2</parameter>: the second number of degrees of freedom of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DF"><function>R.DF</function></link>,
- <link linkend="gnumeric-R.QF"><function>R.QF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PGAMMA">
- <refmeta>
- <refentrytitle>
- <function>R.PGAMMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PGAMMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PF</function>(<parameter>x</parameter>,<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the F distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n1</parameter>: the first number of degrees of freedom of the distribution</para>
+ <para><parameter>n2</parameter>: the second number of degrees of freedom of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DF"><function>R.DF</function></link>,
+ <link linkend="gnumeric-R.QF"><function>R.QF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PGAMMA">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PGAMMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PGAMMA</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the gamma distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PGAMMA</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the gamma distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DGAMMA"><function>R.DGAMMA</function></link>,
- <link linkend="gnumeric-R.QGAMMA"><function>R.QGAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PGEOM">
- <refmeta>
- <refentrytitle>
- <function>R.PGEOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PGEOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PGAMMA</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the gamma distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DGAMMA"><function>R.DGAMMA</function></link>,
+ <link linkend="gnumeric-R.QGAMMA"><function>R.QGAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PGEOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PGEOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PGEOM</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the geometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PGEOM</function>(<parameter>x</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the geometric distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DGEOM"><function>R.DGEOM</function></link>,
- <link linkend="gnumeric-R.QGEOM"><function>R.QGEOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PHYPER">
- <refmeta>
- <refentrytitle>
- <function>R.PHYPER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PHYPER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PGEOM</function>(<parameter>x</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the geometric distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DGEOM"><function>R.DGEOM</function></link>,
+ <link linkend="gnumeric-R.QGEOM"><function>R.QGEOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PHYPER">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PHYPER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PHYPER</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the hypergeometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PHYPER</function>(<parameter>x</parameter>,<parameter>r</parameter>,<parameter>b</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the hypergeometric distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>r</parameter>: the number of red balls</para>
- <para><parameter>b</parameter>: the number of black balls</para>
- <para><parameter>n</parameter>: the number of balls drawn</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DHYPER"><function>R.DHYPER</function></link>,
- <link linkend="gnumeric-R.QHYPER"><function>R.QHYPER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PLNORM">
- <refmeta>
- <refentrytitle>
- <function>R.PLNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PLNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PHYPER</function>(<parameter>x</parameter>,<parameter>r</parameter>,<parameter>b</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the hypergeometric distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>r</parameter>: the number of red balls</para>
+ <para><parameter>b</parameter>: the number of black balls</para>
+ <para><parameter>n</parameter>: the number of balls drawn</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DHYPER"><function>R.DHYPER</function></link>,
+ <link linkend="gnumeric-R.QHYPER"><function>R.QHYPER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PLNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PLNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PLNORM</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the log-normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PLNORM</function>(<parameter>x</parameter>,<parameter>logmean</parameter>,<parameter>logsd</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the log-normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>logmean</parameter>: mean of the underlying normal distribution</para>
- <para><parameter>logsd</parameter>: standard deviation of the underlying normal distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DLNORM"><function>R.DLNORM</function></link>,
- <link linkend="gnumeric-R.QLNORM"><function>R.QLNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PNBINOM">
- <refmeta>
- <refentrytitle>
- <function>R.PNBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PNBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PLNORM</function>(<parameter>x</parameter>,<parameter>logmean</parameter>,<parameter>logsd</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the log-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>logmean</parameter>: mean of the underlying normal distribution</para>
+ <para><parameter>logsd</parameter>: standard deviation of the underlying normal distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DLNORM"><function>R.DLNORM</function></link>,
+ <link linkend="gnumeric-R.QLNORM"><function>R.QLNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PNBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PNBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PNBINOM</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the negative binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PNBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the negative binomial distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of trials</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DNBINOM"><function>R.DNBINOM</function></link>,
- <link linkend="gnumeric-R.QNBINOM"><function>R.QNBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PNORM">
- <refmeta>
- <refentrytitle>
- <function>R.PNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PNBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the negative binomial distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of trials</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DNBINOM"><function>R.DNBINOM</function></link>,
+ <link linkend="gnumeric-R.QNBINOM"><function>R.QNBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PNORM</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PNORM</function>(<parameter>x</parameter>,<parameter>mu</parameter>,<parameter>sigma</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>mu</parameter>: mean of the distribution</para>
- <para><parameter>sigma</parameter>: standard deviation of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DNORM"><function>R.DNORM</function></link>,
- <link linkend="gnumeric-R.QNORM"><function>R.QNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PPOIS">
- <refmeta>
- <refentrytitle>
- <function>R.PPOIS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PPOIS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PNORM</function>(<parameter>x</parameter>,<parameter>mu</parameter>,<parameter>sigma</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>mu</parameter>: mean of the distribution</para>
+ <para><parameter>sigma</parameter>: standard deviation of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DNORM"><function>R.DNORM</function></link>,
+ <link linkend="gnumeric-R.QNORM"><function>R.QNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PPOIS">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PPOIS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PPOIS</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the Poisson distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PPOIS</function>(<parameter>x</parameter>,<parameter>lambda</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the Poisson distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>lambda</parameter>: the mean of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DPOIS"><function>R.DPOIS</function></link>,
- <link linkend="gnumeric-R.QPOIS"><function>R.QPOIS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PSNORM">
- <refmeta>
- <refentrytitle>
- <function>R.PSNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PSNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PPOIS</function>(<parameter>x</parameter>,<parameter>lambda</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the Poisson distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>lambda</parameter>: the mean of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DPOIS"><function>R.DPOIS</function></link>,
+ <link linkend="gnumeric-R.QPOIS"><function>R.QPOIS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PSNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PSNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PSNORM</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the skew-normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PSNORM</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the skew-normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>location</parameter>: the location parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DSNORM"><function>R.DSNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PT">
- <refmeta>
- <refentrytitle>
- <function>R.PT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PSNORM</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the skew-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>location</parameter>: the location parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DSNORM"><function>R.DSNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PT">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PT</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the Student t distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PT</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the Student t distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DT"><function>R.DT</function></link>,
- <link linkend="gnumeric-R.QT"><function>R.QT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.PWEIBULL">
- <refmeta>
- <refentrytitle>
- <function>R.PWEIBULL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.PWEIBULL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PT</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the Student t distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DT"><function>R.DT</function></link>,
+ <link linkend="gnumeric-R.QT"><function>R.QT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.PWEIBULL">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PWEIBULL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PWEIBULL</function>
+ </refname>
+ <refpurpose>
cumulative distribution function of the Weibull distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.PWEIBULL</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the cumulative distribution function of the Weibull distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DWEIBULL"><function>R.DWEIBULL</function></link>,
- <link linkend="gnumeric-R.QWEIBULL"><function>R.QWEIBULL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QBETA">
- <refmeta>
- <refentrytitle>
- <function>R.QBETA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QBETA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PWEIBULL</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the Weibull distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DWEIBULL"><function>R.DWEIBULL</function></link>,
+ <link linkend="gnumeric-R.QWEIBULL"><function>R.QWEIBULL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QBETA">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QBETA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QBETA</function>
+ </refname>
+ <refpurpose>
probability quantile function of the beta distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QBETA</function>(<parameter>p</parameter>,<parameter>a</parameter>,<parameter>b</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the beta distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>a</parameter>: the first shape parameter of the distribution</para>
- <para><parameter>b</parameter>: the second scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DBETA"><function>R.DBETA</function></link>,
- <link linkend="gnumeric-R.PBETA"><function>R.PBETA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QBINOM">
- <refmeta>
- <refentrytitle>
- <function>R.QBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QBETA</function>(<parameter>p</parameter>,<parameter>a</parameter>,<parameter>b</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the beta distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>a</parameter>: the first shape parameter of the distribution</para>
+ <para><parameter>b</parameter>: the second scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DBETA"><function>R.DBETA</function></link>,
+ <link linkend="gnumeric-R.PBETA"><function>R.PBETA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QBINOM</function>
+ </refname>
+ <refpurpose>
probability quantile function of the binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the binomial distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n</parameter>: the number of trials</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DBINOM"><function>R.DBINOM</function></link>,
- <link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QCAUCHY">
- <refmeta>
- <refentrytitle>
- <function>R.QCAUCHY</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QCAUCHY</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QBINOM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the binomial distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of trials</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DBINOM"><function>R.DBINOM</function></link>,
+ <link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QCAUCHY">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QCAUCHY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QCAUCHY</function>
+ </refname>
+ <refpurpose>
probability quantile function of the Cauchy distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QCAUCHY</function>(<parameter>p</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Cauchy distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>location</parameter>: the center of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DCAUCHY"><function>R.DCAUCHY</function></link>,
- <link linkend="gnumeric-R.PCAUCHY"><function>R.PCAUCHY</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QCHISQ">
- <refmeta>
- <refentrytitle>
- <function>R.QCHISQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QCHISQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QCAUCHY</function>(<parameter>p</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Cauchy distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>location</parameter>: the center of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DCAUCHY"><function>R.DCAUCHY</function></link>,
+ <link linkend="gnumeric-R.PCAUCHY"><function>R.PCAUCHY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QCHISQ">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QCHISQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QCHISQ</function>
+ </refname>
+ <refpurpose>
probability quantile function of the chi-square distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QCHISQ</function>(<parameter>p</parameter>,<parameter>df</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the chi-square distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>df</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DCHISQ"><function>R.DCHISQ</function></link>,
- <link linkend="gnumeric-R.PCHISQ"><function>R.PCHISQ</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QEXP">
- <refmeta>
- <refentrytitle>
- <function>R.QEXP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QEXP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QCHISQ</function>(<parameter>p</parameter>,<parameter>df</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the chi-square distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>df</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DCHISQ"><function>R.DCHISQ</function></link>,
+ <link linkend="gnumeric-R.PCHISQ"><function>R.PCHISQ</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QEXP">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QEXP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QEXP</function>
+ </refname>
+ <refpurpose>
probability quantile function of the exponential distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QEXP</function>(<parameter>p</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the exponential distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DEXP"><function>R.DEXP</function></link>,
- <link linkend="gnumeric-R.PEXP"><function>R.PEXP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QF">
- <refmeta>
- <refentrytitle>
- <function>R.QF</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QF</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QEXP</function>(<parameter>p</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the exponential distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DEXP"><function>R.DEXP</function></link>,
+ <link linkend="gnumeric-R.PEXP"><function>R.PEXP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QF">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QF</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QF</function>
+ </refname>
+ <refpurpose>
probability quantile function of the F distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QF</function>(<parameter>x</parameter>,<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the F distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>n1</parameter>: the first number of degrees of freedom of the distribution</para>
- <para><parameter>n2</parameter>: the second number of degrees of freedom of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DF"><function>R.DF</function></link>,
- <link linkend="gnumeric-R.PF"><function>R.PF</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QGAMMA">
- <refmeta>
- <refentrytitle>
- <function>R.QGAMMA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QGAMMA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QF</function>(<parameter>x</parameter>,<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the F distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n1</parameter>: the first number of degrees of freedom of the distribution</para>
+ <para><parameter>n2</parameter>: the second number of degrees of freedom of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DF"><function>R.DF</function></link>,
+ <link linkend="gnumeric-R.PF"><function>R.PF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QGAMMA">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QGAMMA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QGAMMA</function>
+ </refname>
+ <refpurpose>
probability quantile function of the gamma distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QGAMMA</function>(<parameter>p</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the gamma distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DGAMMA"><function>R.DGAMMA</function></link>,
- <link linkend="gnumeric-R.PGAMMA"><function>R.PGAMMA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QGEOM">
- <refmeta>
- <refentrytitle>
- <function>R.QGEOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QGEOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QGAMMA</function>(<parameter>p</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the gamma distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DGAMMA"><function>R.DGAMMA</function></link>,
+ <link linkend="gnumeric-R.PGAMMA"><function>R.PGAMMA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QGEOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QGEOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QGEOM</function>
+ </refname>
+ <refpurpose>
probability quantile function of the geometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QGEOM</function>(<parameter>p</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the geometric distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DGEOM"><function>R.DGEOM</function></link>,
- <link linkend="gnumeric-R.PGEOM"><function>R.PGEOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QHYPER">
- <refmeta>
- <refentrytitle>
- <function>R.QHYPER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QHYPER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QGEOM</function>(<parameter>p</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the geometric distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DGEOM"><function>R.DGEOM</function></link>,
+ <link linkend="gnumeric-R.PGEOM"><function>R.PGEOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QHYPER">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QHYPER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QHYPER</function>
+ </refname>
+ <refpurpose>
probability quantile function of the hypergeometric distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QHYPER</function>(<parameter>p</parameter>,<parameter>r</parameter>,<parameter>b</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the hypergeometric distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>r</parameter>: the number of red balls</para>
- <para><parameter>b</parameter>: the number of black balls</para>
- <para><parameter>n</parameter>: the number of balls drawn</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DHYPER"><function>R.DHYPER</function></link>,
- <link linkend="gnumeric-R.PHYPER"><function>R.PHYPER</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QLNORM">
- <refmeta>
- <refentrytitle>
- <function>R.QLNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QLNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QHYPER</function>(<parameter>p</parameter>,<parameter>r</parameter>,<parameter>b</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the hypergeometric distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>r</parameter>: the number of red balls</para>
+ <para><parameter>b</parameter>: the number of black balls</para>
+ <para><parameter>n</parameter>: the number of balls drawn</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DHYPER"><function>R.DHYPER</function></link>,
+ <link linkend="gnumeric-R.PHYPER"><function>R.PHYPER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QLNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QLNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QLNORM</function>
+ </refname>
+ <refpurpose>
probability quantile function of the log-normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QLNORM</function>(<parameter>x</parameter>,<parameter>logmean</parameter>,<parameter>logsd</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the log-normal distribution.</para>
- <para><parameter>x</parameter>: observation</para>
- <para><parameter>logmean</parameter>: mean of the underlying normal distribution</para>
- <para><parameter>logsd</parameter>: standard deviation of the underlying normal distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DLNORM"><function>R.DLNORM</function></link>,
- <link linkend="gnumeric-R.PLNORM"><function>R.PLNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QNBINOM">
- <refmeta>
- <refentrytitle>
- <function>R.QNBINOM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QNBINOM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QLNORM</function>(<parameter>x</parameter>,<parameter>logmean</parameter>,<parameter>logsd</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the log-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>logmean</parameter>: mean of the underlying normal distribution</para>
+ <para><parameter>logsd</parameter>: standard deviation of the underlying normal distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DLNORM"><function>R.DLNORM</function></link>,
+ <link linkend="gnumeric-R.PLNORM"><function>R.PLNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QNBINOM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QNBINOM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QNBINOM</function>
+ </refname>
+ <refpurpose>
probability quantile function of the negative binomial distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QNBINOM</function>(<parameter>p</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the negative binomial distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>n</parameter>: the number of trials</para>
- <para><parameter>psuc</parameter>: the probability of success in each trial</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DNBINOM"><function>R.DNBINOM</function></link>,
- <link linkend="gnumeric-R.PNBINOM"><function>R.PNBINOM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QNORM">
- <refmeta>
- <refentrytitle>
- <function>R.QNORM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QNORM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QNBINOM</function>(<parameter>p</parameter>,<parameter>n</parameter>,<parameter>psuc</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the negative binomial distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>n</parameter>: the number of trials</para>
+ <para><parameter>psuc</parameter>: the probability of success in each trial</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DNBINOM"><function>R.DNBINOM</function></link>,
+ <link linkend="gnumeric-R.PNBINOM"><function>R.PNBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QNORM</function>
+ </refname>
+ <refpurpose>
probability quantile function of the normal distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QNORM</function>(<parameter>p</parameter>,<parameter>mu</parameter>,<parameter>sigma</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the normal distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>mu</parameter>: mean of the distribution</para>
- <para><parameter>sigma</parameter>: standard deviation of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DNORM"><function>R.DNORM</function></link>,
- <link linkend="gnumeric-R.PNORM"><function>R.PNORM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QPOIS">
- <refmeta>
- <refentrytitle>
- <function>R.QPOIS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QPOIS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QNORM</function>(<parameter>p</parameter>,<parameter>mu</parameter>,<parameter>sigma</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the normal distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>mu</parameter>: mean of the distribution</para>
+ <para><parameter>sigma</parameter>: standard deviation of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DNORM"><function>R.DNORM</function></link>,
+ <link linkend="gnumeric-R.PNORM"><function>R.PNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QPOIS">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QPOIS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QPOIS</function>
+ </refname>
+ <refpurpose>
probability quantile function of the Poisson distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QPOIS</function>(<parameter>p</parameter>,<parameter>lambda</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Poisson distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>lambda</parameter>: the mean of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DPOIS"><function>R.DPOIS</function></link>,
- <link linkend="gnumeric-R.PPOIS"><function>R.PPOIS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QT">
- <refmeta>
- <refentrytitle>
- <function>R.QT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QPOIS</function>(<parameter>p</parameter>,<parameter>lambda</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Poisson distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>lambda</parameter>: the mean of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DPOIS"><function>R.DPOIS</function></link>,
+ <link linkend="gnumeric-R.PPOIS"><function>R.PPOIS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QT">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QT</function>
+ </refname>
+ <refpurpose>
probability quantile function of the Student t distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QT</function>(<parameter>p</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Student t distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DT"><function>R.DT</function></link>,
- <link linkend="gnumeric-R.PT"><function>R.PT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-R.QWEIBULL">
- <refmeta>
- <refentrytitle>
- <function>R.QWEIBULL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>R.QWEIBULL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QT</function>(<parameter>p</parameter>,<parameter>n</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Student t distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DT"><function>R.DT</function></link>,
+ <link linkend="gnumeric-R.PT"><function>R.PT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.QWEIBULL">
+ <refmeta>
+ <refentrytitle>
+ <function>R.QWEIBULL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.QWEIBULL</function>
+ </refname>
+ <refpurpose>
probability quantile function of the Weibull distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>R.QWEIBULL</function>(<parameter>p</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Weibull distribution.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
- <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
- <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
- <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-R.DWEIBULL"><function>R.DWEIBULL</function></link>,
- <link linkend="gnumeric-R.PWEIBULL"><function>R.PWEIBULL</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANK">
- <refmeta>
- <refentrytitle>
- <function>RANK</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANK</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.QWEIBULL</function>(<parameter>p</parameter>,<parameter>shape</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Weibull distribution.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DWEIBULL"><function>R.DWEIBULL</function></link>,
+ <link linkend="gnumeric-R.PWEIBULL"><function>R.PWEIBULL</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANK">
+ <refmeta>
+ <refentrytitle>
+ <function>RANK</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANK</function>
+ </refname>
+ <refpurpose>
rank of a number in a list of numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANK</function>(<parameter>x</parameter>,<parameter>ref</parameter>,<parameter>order</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number whose rank you want to find</para>
- <para><parameter>ref</parameter>: list of numbers</para>
- <para><parameter>order</parameter>: If this is 0, numbers are ranked in descending order, otherwise numbers are ranked in ascending order. Defaults to 0.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>In case of a tie, <function>RANK</function> returns the largest possible rank.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
- <link linkend="gnumeric-RANK.AVG"><function>RANK.AVG</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RANK.AVG">
- <refmeta>
- <refentrytitle>
- <function>RANK.AVG</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RANK.AVG</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANK</function>(<parameter>x</parameter>,<parameter>ref</parameter>,<parameter>order</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number whose rank you want to find</para>
+ <para><parameter>ref</parameter>: list of numbers</para>
+ <para><parameter>order</parameter>: If this is 0, numbers are ranked in descending order, otherwise numbers are ranked in ascending order. Defaults to 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>In case of a tie, <function>RANK</function> returns the largest possible rank.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
+ <link linkend="gnumeric-RANK.AVG"><function>RANK.AVG</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANK.AVG">
+ <refmeta>
+ <refentrytitle>
+ <function>RANK.AVG</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANK.AVG</function>
+ </refname>
+ <refpurpose>
rank of a number in a list of numbers
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RANK.AVG</function>(<parameter>x</parameter>,<parameter>ref</parameter>,<parameter>order</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: number whose rank you want to find</para>
- <para><parameter>ref</parameter>: list of numbers</para>
- <para><parameter>order</parameter>: If this is 0, numbers are ranked in descending order, otherwise numbers are ranked in ascending order. Defaults to 0.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>In case of a tie, RANK returns the average rank.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
- <link linkend="gnumeric-RANK"><function>RANK</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RAYLEIGH">
- <refmeta>
- <refentrytitle>
- <function>RAYLEIGH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RAYLEIGH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANK.AVG</function>(<parameter>x</parameter>,<parameter>ref</parameter>,<parameter>order</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: number whose rank you want to find</para>
+ <para><parameter>ref</parameter>: list of numbers</para>
+ <para><parameter>order</parameter>: If this is 0, numbers are ranked in descending order, otherwise numbers are ranked in ascending order. Defaults to 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>In case of a tie, RANK returns the average rank.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
+ <link linkend="gnumeric-RANK"><function>RANK</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RAYLEIGH">
+ <refmeta>
+ <refentrytitle>
+ <function>RAYLEIGH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RAYLEIGH</function>
+ </refname>
+ <refpurpose>
probability density function of the Rayleigh distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDRAYLEIGH"><function>RANDRAYLEIGH</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RAYLEIGH</function>(<parameter>x</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>sigma</parameter>: scale parameter</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RAYLEIGHTAIL">
- <refmeta>
- <refentrytitle>
- <function>RAYLEIGHTAIL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RAYLEIGHTAIL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDRAYLEIGH"><function>RANDRAYLEIGH</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RAYLEIGH</function>(<parameter>x</parameter>,<parameter>sigma</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>sigma</parameter>: scale parameter</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RAYLEIGHTAIL">
+ <refmeta>
+ <refentrytitle>
+ <function>RAYLEIGHTAIL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RAYLEIGHTAIL</function>
+ </refname>
+ <refpurpose>
probability density function of the Rayleigh tail distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-RANDRAYLEIGHTAIL"><function>RANDRAYLEIGHTAIL</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>RAYLEIGHTAIL</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: </para>
- <para><parameter>a</parameter>: lower limit</para>
- <para><parameter>sigma</parameter>: scale parameter</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RSQ">
- <refmeta>
- <refentrytitle>
- <function>RSQ</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RSQ</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDRAYLEIGHTAIL"><function>RANDRAYLEIGHTAIL</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>RAYLEIGHTAIL</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>sigma</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>a</parameter>: lower limit</para>
+ <para><parameter>sigma</parameter>: scale parameter</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RSQ">
+ <refmeta>
+ <refentrytitle>
+ <function>RSQ</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RSQ</function>
+ </refname>
+ <refpurpose>
square of the Pearson correlation coefficient of the paired set of data
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RSQ</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>array1</parameter>: first component values</para>
- <para><parameter>array2</parameter>: second component values</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CORREL"><function>CORREL</function></link>,
- <link linkend="gnumeric-COVAR"><function>COVAR</function></link>,
- <link linkend="gnumeric-INTERCEPT"><function>INTERCEPT</function></link>,
- <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
- <link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>,
- <link linkend="gnumeric-PEARSON"><function>PEARSON</function></link>,
- <link linkend="gnumeric-SLOPE"><function>SLOPE</function></link>,
- <link linkend="gnumeric-STEYX"><function>STEYX</function></link>,
- <link linkend="gnumeric-TREND"><function>TREND</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SFTEST">
- <refmeta>
- <refentrytitle>
- <function>SFTEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SFTEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RSQ</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>array1</parameter>: first component values</para>
+ <para><parameter>array2</parameter>: second component values</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CORREL"><function>CORREL</function></link>,
+ <link linkend="gnumeric-COVAR"><function>COVAR</function></link>,
+ <link linkend="gnumeric-INTERCEPT"><function>INTERCEPT</function></link>,
+ <link linkend="gnumeric-LINEST"><function>LINEST</function></link>,
+ <link linkend="gnumeric-LOGEST"><function>LOGEST</function></link>,
+ <link linkend="gnumeric-PEARSON"><function>PEARSON</function></link>,
+ <link linkend="gnumeric-SLOPE"><function>SLOPE</function></link>,
+ <link linkend="gnumeric-STEYX"><function>STEYX</function></link>,
+ <link linkend="gnumeric-TREND"><function>TREND</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SFTEST">
+ <refmeta>
+ <refentrytitle>
+ <function>SFTEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SFTEST</function>
+ </refname>
+ <refpurpose>
Shapiro-Francia Test of Normality
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SFTEST</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This function returns an array with the first row giving the p-value of the Shapiro-Francia Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
- <para><parameter>x</parameter>: array of sample values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If there are less than 5 or more than 5000 sample values, <function>SFTEST</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
- <link linkend="gnumeric-ADTEST"><function>ADTEST</function></link>,
- <link linkend="gnumeric-LKSTEST"><function>LKSTEST</function></link>,
- <link linkend="gnumeric-CVMTEST"><function>CVMTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SKEW">
- <refmeta>
- <refentrytitle>
- <function>SKEW</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SKEW</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SFTEST</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns an array with the first row giving the p-value of the Shapiro-Francia Test, the second row the test statistic of the test, and the third the number of observations in the sample.</para>
+ <para><parameter>x</parameter>: array of sample values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If there are less than 5 or more than 5000 sample values, <function>SFTEST</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHITEST"><function>CHITEST</function></link>,
+ <link linkend="gnumeric-ADTEST"><function>ADTEST</function></link>,
+ <link linkend="gnumeric-LKSTEST"><function>LKSTEST</function></link>,
+ <link linkend="gnumeric-CVMTEST"><function>CVMTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SKEW">
+ <refmeta>
+ <refentrytitle>
+ <function>SKEW</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SKEW</function>
+ </refname>
+ <refpurpose>
unbiased estimate for skewness of a distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SKEW</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This is only meaningful if the underlying distribution really has a third moment. The skewness of a symmetric (e.g., normal) distribution is zero.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If less than three numbers are given, this function returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-VAR"><function>VAR</function></link>,
- <link linkend="gnumeric-SKEWP"><function>SKEWP</function></link>,
- <link linkend="gnumeric-KURT"><function>KURT</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SKEWP">
- <refmeta>
- <refentrytitle>
- <function>SKEWP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SKEWP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SKEW</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This is only meaningful if the underlying distribution really has a third moment. The skewness of a symmetric (e.g., normal) distribution is zero.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If less than three numbers are given, this function returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-VAR"><function>VAR</function></link>,
+ <link linkend="gnumeric-SKEWP"><function>SKEWP</function></link>,
+ <link linkend="gnumeric-KURT"><function>KURT</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SKEWP">
+ <refmeta>
+ <refentrytitle>
+ <function>SKEWP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SKEWP</function>
+ </refname>
+ <refpurpose>
population skewness of a data set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SKEWP</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Strings and empty cells are simply ignored.</para>
- <para><parameter>number1</parameter>: first value</para>
- <para><parameter>number2</parameter>: second value</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If less than two numbers are given, <function>SKEWP</function> returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-VARP"><function>VARP</function></link>,
- <link linkend="gnumeric-SKEW"><function>SKEW</function></link>,
- <link linkend="gnumeric-KURTP"><function>KURTP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SLOPE">
- <refmeta>
- <refentrytitle>
- <function>SLOPE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SLOPE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SKEWP</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If less than two numbers are given, <function>SKEWP</function> returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-VARP"><function>VARP</function></link>,
+ <link linkend="gnumeric-SKEW"><function>SKEW</function></link>,
+ <link linkend="gnumeric-KURTP"><function>KURTP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SLOPE">
+ <refmeta>
+ <refentrytitle>
+ <function>SLOPE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SLOPE</function>
+ </refname>
+ <refpurpose>
the slope of a linear regression line
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SLOPE</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, this function returns a #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the variance of the <parameter>known_x</parameter> is zero, this function returns #DIV/0 error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
- <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SMALL">
- <refmeta>
- <refentrytitle>
- <function>SMALL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SMALL</function>
- </refname>
- <refpurpose><parameter>k</parameter>-th smallest value in a data set.
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SMALL</function>(<parameter>data</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>data</parameter>: data set</para>
- <para><parameter>k</parameter>: which value to find</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If data set is empty this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>k</parameter> <= 0 or <parameter>k</parameter> is greater than the number of data items given this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
- <link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
- <link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>,
- <link linkend="gnumeric-LARGE"><function>LARGE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SSMEDIAN">
- <refmeta>
- <refentrytitle>
- <function>SSMEDIAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SSMEDIAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SLOPE</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, this function returns a #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the variance of the <parameter>known_x</parameter> is zero, this function returns #DIV/0 error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
+ <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SMALL">
+ <refmeta>
+ <refentrytitle>
+ <function>SMALL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SMALL</function>
+ </refname>
+ <refpurpose><parameter>k</parameter>-th smallest value in a data set.
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SMALL</function>(<parameter>data</parameter>,<parameter>k</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>data</parameter>: data set</para>
+ <para><parameter>k</parameter>: which value to find</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If data set is empty this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>k</parameter> <= 0 or <parameter>k</parameter> is greater than the number of data items given this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
+ <link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>,
+ <link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>,
+ <link linkend="gnumeric-LARGE"><function>LARGE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SSMEDIAN">
+ <refmeta>
+ <refentrytitle>
+ <function>SSMEDIAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SSMEDIAN</function>
+ </refname>
+ <refpurpose>
median for grouped data as commonly determined in the social sciences
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SSMEDIAN</function>(<parameter>array</parameter>,<parameter>interval</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The data points given in <parameter>array</parameter> are assumed to be the result of grouping data into intervals of length <parameter>interval</parameter></para>
- <para><parameter>array</parameter>: data set</para>
- <para><parameter>interval</parameter>: length of each grouping interval, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>array</parameter> is empty, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>interval</parameter> <= 0, this function returns a #NUM! error.<function>SSMEDIAN</function> does not check whether the data points are at least <parameter>interval</parameter> apart.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-STANDARDIZE">
- <refmeta>
- <refentrytitle>
- <function>STANDARDIZE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>STANDARDIZE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SSMEDIAN</function>(<parameter>array</parameter>,<parameter>interval</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The data points given in <parameter>array</parameter> are assumed to be the result of grouping data into intervals of length <parameter>interval</parameter></para>
+ <para><parameter>array</parameter>: data set</para>
+ <para><parameter>interval</parameter>: length of each grouping interval, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>array</parameter> is empty, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>interval</parameter> <= 0, this function returns a #NUM! error.<function>SSMEDIAN</function> does not check whether the data points are at least <parameter>interval</parameter> apart.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-STANDARDIZE">
+ <refmeta>
+ <refentrytitle>
+ <function>STANDARDIZE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>STANDARDIZE</function>
+ </refname>
+ <refpurpose>
z-score of a value
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>STANDARDIZE</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: value</para>
- <para><parameter>mean</parameter>: mean of the original distribution</para>
- <para><parameter>stddev</parameter>: standard deviation of the original distribution</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>stddev</parameter> is 0 this function returns a #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-STDEV">
- <refmeta>
- <refentrytitle>
- <function>STDEV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>STDEV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>STANDARDIZE</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: value</para>
+ <para><parameter>mean</parameter>: mean of the original distribution</para>
+ <para><parameter>stddev</parameter>: standard deviation of the original distribution</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>stddev</parameter> is 0 this function returns a #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-STDEV">
+ <refmeta>
+ <refentrytitle>
+ <function>STDEV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>STDEV</function>
+ </refname>
+ <refpurpose>
sample standard deviation of the given sample
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>STDEV</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>STDEV</function> is also known as the N-1-standard deviation.</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>To obtain the population standard deviation of a whole population use STDEVP.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-DSTDEV"><function>DSTDEV</function></link>,
- <link linkend="gnumeric-DSTDEVP"><function>DSTDEVP</function></link>,
- <link linkend="gnumeric-STDEVA"><function>STDEVA</function></link>,
- <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>,
- <link linkend="gnumeric-VAR"><function>VAR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-STDEVA">
- <refmeta>
- <refentrytitle>
- <function>STDEVA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>STDEVA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>STDEV</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>STDEV</function> is also known as the N-1-standard deviation.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>To obtain the population standard deviation of a whole population use STDEVP.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-DSTDEV"><function>DSTDEV</function></link>,
+ <link linkend="gnumeric-DSTDEVP"><function>DSTDEVP</function></link>,
+ <link linkend="gnumeric-STDEVA"><function>STDEVA</function></link>,
+ <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>,
+ <link linkend="gnumeric-VAR"><function>VAR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-STDEVA">
+ <refmeta>
+ <refentrytitle>
+ <function>STDEVA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>STDEVA</function>
+ </refname>
+ <refpurpose>
sample standard deviation of the given sample.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>STDEVA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>STDEVA</function> is also known as the N-1-standard deviation.</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>To obtain the population standard deviation of a whole population use STDEVPA.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
- <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-STDEVP">
- <refmeta>
- <refentrytitle>
- <function>STDEVP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>STDEVP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>STDEVA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>STDEVA</function> is also known as the N-1-standard deviation.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>To obtain the population standard deviation of a whole population use STDEVPA.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
+ <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-STDEVP">
+ <refmeta>
+ <refentrytitle>
+ <function>STDEVP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>STDEVP</function>
+ </refname>
+ <refpurpose>
population standard deviation of the given population
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>STDEVP</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This is also known as the N-standard deviation</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
- <link linkend="gnumeric-STDEVA"><function>STDEVA</function></link>,
- <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-STDEVPA">
- <refmeta>
- <refentrytitle>
- <function>STDEVPA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>STDEVPA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>STDEVP</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This is also known as the N-standard deviation</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
+ <link linkend="gnumeric-STDEVA"><function>STDEVA</function></link>,
+ <link linkend="gnumeric-STDEVPA"><function>STDEVPA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-STDEVPA">
+ <refmeta>
+ <refentrytitle>
+ <function>STDEVPA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>STDEVPA</function>
+ </refname>
+ <refpurpose>
population standard deviation of an entire population.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>STDEVPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This is also known as the N-standard deviation</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-STDEVA"><function>STDEVA</function></link>,
- <link linkend="gnumeric-STDEVP"><function>STDEVP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-STEYX">
- <refmeta>
- <refentrytitle>
- <function>STEYX</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>STEYX</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>STDEVPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This is also known as the N-standard deviation</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-STDEVA"><function>STDEVA</function></link>,
+ <link linkend="gnumeric-STDEVP"><function>STDEVP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-STEYX">
+ <refmeta>
+ <refentrytitle>
+ <function>STEYX</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>STEYX</function>
+ </refname>
+ <refpurpose>
standard error of the predicted y-value in the regression
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>STEYX</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s are empty or have a different number of arguments then this function returns a #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PEARSON"><function>PEARSON</function></link>,
- <link linkend="gnumeric-RSQ"><function>RSQ</function></link>,
- <link linkend="gnumeric-SLOPE"><function>SLOPE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUBTOTAL">
- <refmeta>
- <refentrytitle>
- <function>SUBTOTAL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUBTOTAL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>STEYX</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s are empty or have a different number of arguments then this function returns a #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PEARSON"><function>PEARSON</function></link>,
+ <link linkend="gnumeric-RSQ"><function>RSQ</function></link>,
+ <link linkend="gnumeric-SLOPE"><function>SLOPE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUBTOTAL">
+ <refmeta>
+ <refentrytitle>
+ <function>SUBTOTAL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUBTOTAL</function>
+ </refname>
+ <refpurpose>
the subtotal of the given list of arguments
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SUBTOTAL</function>(<parameter>function_nbr</parameter>,<parameter>ref1</parameter>,<parameter>ref2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>function_nbr</parameter>: determines which function to use according to the following table:</para>
- <para> 1 AVERAGE</para>
- <para> 2 COUNT</para>
- <para> 3 COUNTA</para>
- <para> 4 MAX</para>
- <para> 5 MIN</para>
- <para> 6 PRODUCT</para>
- <para> 7 STDEV</para>
- <para> 8 STDEVP</para>
- <para> 9 SUM</para>
- <para> 10 VAR</para>
- <para> 11 VARP</para>
- <para><parameter>ref1</parameter>: first value</para>
- <para><parameter>ref2</parameter>: second value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-TDIST">
- <refmeta>
- <refentrytitle>
- <function>TDIST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TDIST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SUBTOTAL</function>(<parameter>function_nbr</parameter>,<parameter>ref1</parameter>,<parameter>ref2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>function_nbr</parameter>: determines which function to use according to the following table:</para>
+ <para> 1 AVERAGE</para>
+ <para> 2 COUNT</para>
+ <para> 3 COUNTA</para>
+ <para> 4 MAX</para>
+ <para> 5 MIN</para>
+ <para> 6 PRODUCT</para>
+ <para> 7 STDEV</para>
+ <para> 8 STDEVP</para>
+ <para> 9 SUM</para>
+ <para> 10 VAR</para>
+ <para> 11 VARP</para>
+ <para><parameter>ref1</parameter>: first value</para>
+ <para><parameter>ref2</parameter>: second value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>TDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TDIST</function>
+ </refname>
+ <refpurpose>
survival function of the Student t-distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TDIST</function>(<parameter>x</parameter>,<parameter>dof</parameter>,<parameter>tails</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The survival function is 1 minus the cumulative distribution function.</para>
- <para><parameter>x</parameter>: </para>
- <para><parameter>dof</parameter>: number of degrees of freedom</para>
- <para><parameter>tails</parameter>: 1 or 2. If this is 2, <parameter>x</parameter> is replaced by the absolute value and the returned value is multiplied by 2</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>tails</parameter> is neither 1 or 2 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The parameterization of this function is different from what is used for, e.g., NORMSDIST. This is a common source of mistakes, but necessary for compatibility.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>This function is Excel compatible for non-negative <parameter>x</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TINV"><function>TINV</function></link>,
- <link linkend="gnumeric-TTEST"><function>TTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TINV">
- <refmeta>
- <refentrytitle>
- <function>TINV</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TINV</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TDIST</function>(<parameter>x</parameter>,<parameter>dof</parameter>,<parameter>tails</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The survival function is 1 minus the cumulative distribution function.</para>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>dof</parameter>: number of degrees of freedom</para>
+ <para><parameter>tails</parameter>: 1 or 2. If this is 2, <parameter>x</parameter> is replaced by the absolute value and the returned value is multiplied by 2</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>tails</parameter> is neither 1 or 2 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The parameterization of this function is different from what is used for, e.g., NORMSDIST. This is a common source of mistakes, but necessary for compatibility.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>This function is Excel compatible for non-negative <parameter>x</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TINV"><function>TINV</function></link>,
+ <link linkend="gnumeric-TTEST"><function>TTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TINV">
+ <refmeta>
+ <refentrytitle>
+ <function>TINV</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TINV</function>
+ </refname>
+ <refpurpose>
inverse of the survival function of the Student t-distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TINV</function>(<parameter>p</parameter>,<parameter>dof</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>The survival function is 1 minus the cumulative distribution function.</para>
- <para><parameter>p</parameter>: probability</para>
- <para><parameter>dof</parameter>: number of degrees of freedom</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The parameterization of this function is different from what is used for, e.g., NORMSINV. This is a common source of mistakes, but necessary for compatibility.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TDIST"><function>TDIST</function></link>,
- <link linkend="gnumeric-TTEST"><function>TTEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TREND">
- <refmeta>
- <refentrytitle>
- <function>TREND</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TREND</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TINV</function>(<parameter>p</parameter>,<parameter>dof</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>The survival function is 1 minus the cumulative distribution function.</para>
+ <para><parameter>p</parameter>: probability</para>
+ <para><parameter>dof</parameter>: number of degrees of freedom</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>dof</parameter> < 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The parameterization of this function is different from what is used for, e.g., NORMSINV. This is a common source of mistakes, but necessary for compatibility.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TDIST"><function>TDIST</function></link>,
+ <link linkend="gnumeric-TTEST"><function>TTEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TREND">
+ <refmeta>
+ <refentrytitle>
+ <function>TREND</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TREND</function>
+ </refname>
+ <refpurpose>
estimates future values of a given data set using a least squares approximation
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TREND</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>new_x</parameter>'s,<parameter>const</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>@{known_y's}: known y-values</para>
- <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
- <para>@{new_x's}: x-values for which you want to estimate the y-values; defaults to <parameter>known_x</parameter>'s</para>
- <para><parameter>const</parameter>: if this is false the line will be forced to go through the origin; defaults to TRUE</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If @{known_y's} and @{known_x's} have unequal number of data points, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LINEST"><function>LINEST</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TRIMMEAN">
- <refmeta>
- <refentrytitle>
- <function>TRIMMEAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TRIMMEAN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TREND</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s,<parameter>new_x</parameter>'s,<parameter>const</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values; if <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
+ <para>@{new_x's}: x-values for which you want to estimate the y-values; defaults to <parameter>known_x</parameter>'s</para>
+ <para><parameter>const</parameter>: if this is false the line will be forced to go through the origin; defaults to TRUE</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{known_y's} and @{known_x's} have unequal number of data points, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LINEST"><function>LINEST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TRIMMEAN">
+ <refmeta>
+ <refentrytitle>
+ <function>TRIMMEAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TRIMMEAN</function>
+ </refname>
+ <refpurpose>
mean of the interior of a data set
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TRIMMEAN</function>(<parameter>ref</parameter>,<parameter>fraction</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If <parameter>fraction</parameter>=0.2 and the data set contains 40 numbers, 8 numbers are trimmed from the data set (40 x 0.2): the 4 largest and the 4 smallest. To avoid a bias, the number of points to be excluded is always rounded down to the nearest even number.</para>
- <para><parameter>ref</parameter>: list of numbers whose mean you want to calculate</para>
- <para><parameter>fraction</parameter>: fraction of the data set excluded from the mean</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-GEOMEAN"><function>GEOMEAN</function></link>,
- <link linkend="gnumeric-HARMEAN"><function>HARMEAN</function></link>,
- <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
- <link linkend="gnumeric-MODE"><function>MODE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-TTEST">
- <refmeta>
- <refentrytitle>
- <function>TTEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TTEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TRIMMEAN</function>(<parameter>ref</parameter>,<parameter>fraction</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If <parameter>fraction</parameter>=0.2 and the data set contains 40 numbers, 8 numbers are trimmed from the data set (40 x 0.2): the 4 largest and the 4 smallest. To avoid a bias, the number of points to be excluded is always rounded down to the nearest even number.</para>
+ <para><parameter>ref</parameter>: list of numbers whose mean you want to calculate</para>
+ <para><parameter>fraction</parameter>: fraction of the data set excluded from the mean</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-GEOMEAN"><function>GEOMEAN</function></link>,
+ <link linkend="gnumeric-HARMEAN"><function>HARMEAN</function></link>,
+ <link linkend="gnumeric-MEDIAN"><function>MEDIAN</function></link>,
+ <link linkend="gnumeric-MODE"><function>MODE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TTEST">
+ <refmeta>
+ <refentrytitle>
+ <function>TTEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TTEST</function>
+ </refname>
+ <refpurpose>
p-value for a hypothesis test comparing the means of two populations usingthe Student t-distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>TTEST</function>(<parameter>array1</parameter>,<parameter>array2</parameter>,<parameter>tails</parameter>,<parameter>type</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>array1</parameter>: sample from the first population</para>
- <para><parameter>array2</parameter>: sample from the second population</para>
- <para><parameter>tails</parameter>: number of tails to consider</para>
- <para><parameter>type</parameter>: Type of test to perform. 1 indicates a test for paired variables, 2 a test of unpaired variables with equal variances, and 3 a test of unpaired variables with unequal variances</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the data sets contain a different number of data points and the test is paired (<parameter>type</parameter> one), <function>TTEST</function> returns the #N/A error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para><parameter>tails</parameter> and <parameter>type</parameter> are truncated to integers.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>tails</parameter> is not one or two, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>type</parameter> is any other than one, two, or three, this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>,
- <link linkend="gnumeric-FINV"><function>FINV</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-VAR">
- <refmeta>
- <refentrytitle>
- <function>VAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>TTEST</function>(<parameter>array1</parameter>,<parameter>array2</parameter>,<parameter>tails</parameter>,<parameter>type</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>array1</parameter>: sample from the first population</para>
+ <para><parameter>array2</parameter>: sample from the second population</para>
+ <para><parameter>tails</parameter>: number of tails to consider</para>
+ <para><parameter>type</parameter>: Type of test to perform. 1 indicates a test for paired variables, 2 a test of unpaired variables with equal variances, and 3 a test of unpaired variables with unequal variances</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the data sets contain a different number of data points and the test is paired (<parameter>type</parameter> one), <function>TTEST</function> returns the #N/A error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para><parameter>tails</parameter> and <parameter>type</parameter> are truncated to integers.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>tails</parameter> is not one or two, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>type</parameter> is any other than one, two, or three, this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>,
+ <link linkend="gnumeric-FINV"><function>FINV</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VAR">
+ <refmeta>
+ <refentrytitle>
+ <function>VAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VAR</function>
+ </refname>
+ <refpurpose>
sample variance of the given sample
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>VAR</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VAR</function> is also known as the N-1-variance.</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Since the N-1-variance includes Bessel's correction, whereas the N-variance calculated by VARPA or VARP does not, under reasonable conditions the N-1-variance is an unbiased estimator of the variance of the population from which the sample is drawn.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VARP"><function>VARP</function></link>,
- <link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
- <link linkend="gnumeric-VARA"><function>VARA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-VARA">
- <refmeta>
- <refentrytitle>
- <function>VARA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VARA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>VAR</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>VAR</function> is also known as the N-1-variance.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Since the N-1-variance includes Bessel's correction, whereas the N-variance calculated by VARPA or VARP does not, under reasonable conditions the N-1-variance is an unbiased estimator of the variance of the population from which the sample is drawn.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VARP"><function>VARP</function></link>,
+ <link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
+ <link linkend="gnumeric-VARA"><function>VARA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VARA">
+ <refmeta>
+ <refentrytitle>
+ <function>VARA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VARA</function>
+ </refname>
+ <refpurpose>
sample variance of the given sample
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>VARA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VARA</function> is also known as the N-1-variance.</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>To get the true variance of a complete population use VARPA.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Since the N-1-variance includes Bessel's correction, whereas the N-variance calculated by VARPA or VARP does not, under reasonable conditions the N-1-variance is an unbiased estimator of the variance of the population from which the sample is drawn.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VAR"><function>VAR</function></link>,
- <link linkend="gnumeric-VARPA"><function>VARPA</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-VARP">
- <refmeta>
- <refentrytitle>
- <function>VARP</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VARP</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>VARA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>VARA</function> is also known as the N-1-variance.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>To get the true variance of a complete population use VARPA.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Since the N-1-variance includes Bessel's correction, whereas the N-variance calculated by VARPA or VARP does not, under reasonable conditions the N-1-variance is an unbiased estimator of the variance of the population from which the sample is drawn.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VAR"><function>VAR</function></link>,
+ <link linkend="gnumeric-VARPA"><function>VARPA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VARP">
+ <refmeta>
+ <refentrytitle>
+ <function>VARP</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VARP</function>
+ </refname>
+ <refpurpose>
variance of an entire population
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>VARP</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VARP</function> is also known as the N-variance.</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
- <link linkend="gnumeric-DVAR"><function>DVAR</function></link>,
- <link linkend="gnumeric-DVARP"><function>DVARP</function></link>,
- <link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
- <link linkend="gnumeric-VAR"><function>VAR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-VARPA">
- <refmeta>
- <refentrytitle>
- <function>VARPA</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VARPA</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>VARP</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>VARP</function> is also known as the N-variance.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
+ <link linkend="gnumeric-DVAR"><function>DVAR</function></link>,
+ <link linkend="gnumeric-DVARP"><function>DVARP</function></link>,
+ <link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
+ <link linkend="gnumeric-VAR"><function>VAR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VARPA">
+ <refmeta>
+ <refentrytitle>
+ <function>VARPA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VARPA</function>
+ </refname>
+ <refpurpose>
variance of an entire population
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>VARPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VARPA</function> is also known as the N-variance.</para>
- <para><parameter>area1</parameter>: first cell area</para>
- <para><parameter>area2</parameter>: second cell area</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VARA"><function>VARA</function></link>,
- <link linkend="gnumeric-VARP"><function>VARP</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-WEIBULL">
- <refmeta>
- <refentrytitle>
- <function>WEIBULL</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>WEIBULL</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>VARPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>VARPA</function> is also known as the N-variance.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VARA"><function>VARA</function></link>,
+ <link linkend="gnumeric-VARP"><function>VARP</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-WEIBULL">
+ <refmeta>
+ <refentrytitle>
+ <function>WEIBULL</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>WEIBULL</function>
+ </refname>
+ <refpurpose>
(cumulative) probability density function of the Weibull distribution
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>WEIBULL</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If the <parameter>cumulative</parameter> boolean is true it will return: 1 - exp (-(<parameter>x</parameter>/<parameter>beta</parameter>)^<parameter>alpha</parameter>),otherwise it will return (<parameter>alpha</parameter>/<parameter>beta</parameter>^<parameter>alpha</parameter>) * <parameter>x</parameter>^(<parameter>alpha</parameter>-1) * exp(-(<parameter>x</parameter>/<parameter>beta</parameter>^<parameter>alpha</parameter>)).</para>
- <para><parameter>x</parameter>: </para>
- <para><parameter>alpha</parameter>: scale parameter</para>
- <para><parameter>beta</parameter>: scale parameter</para>
- <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0 this function returns a #NUM! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-ZTEST">
- <refmeta>
- <refentrytitle>
- <function>ZTEST</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>ZTEST</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>WEIBULL</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>cumulative</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If the <parameter>cumulative</parameter> boolean is true it will return: 1 - exp (-(<parameter>x</parameter>/<parameter>beta</parameter>)^<parameter>alpha</parameter>),otherwise it will return (<parameter>alpha</parameter>/<parameter>beta</parameter>^<parameter>alpha</parameter>) * <parameter>x</parameter>^(<parameter>alpha</parameter>-1) * exp(-(<parameter>x</parameter>/<parameter>beta</parameter>^<parameter>alpha</parameter>)).</para>
+ <para><parameter>x</parameter>: </para>
+ <para><parameter>alpha</parameter>: scale parameter</para>
+ <para><parameter>beta</parameter>: scale parameter</para>
+ <para><parameter>cumulative</parameter>: whether to evaluate the density function or the cumulative distribution function</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>x</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ZTEST">
+ <refmeta>
+ <refentrytitle>
+ <function>ZTEST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ZTEST</function>
+ </refname>
+ <refpurpose>
p-value of a 2-tailed z-test for a population mean
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>ZTEST</function>(<parameter>ref</parameter>,<parameter>x</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>ref</parameter>: data set</para>
- <para><parameter>x</parameter>: mean as given in the null hypothesis</para>
- <para><parameter>stddev</parameter>: population standard deviation, defaults to the sample standard deviation</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>ref</parameter> contains less than two data items <function>ZTEST</function> returns #DIV/0! error.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CONFIDENCE"><function>CONFIDENCE</function></link>,
- <link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
- <link linkend="gnumeric-NORMINV"><function>NORMINV</function></link>,
- <link linkend="gnumeric-NORMSDIST"><function>NORMSDIST</function></link>,
- <link linkend="gnumeric-NORMSINV"><function>NORMSINV</function></link>,
- <link linkend="gnumeric-STANDARDIZE"><function>STANDARDIZE</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ZTEST</function>(<parameter>ref</parameter>,<parameter>x</parameter>,<parameter>stddev</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>ref</parameter>: data set</para>
+ <para><parameter>x</parameter>: mean as given in the null hypothesis</para>
+ <para><parameter>stddev</parameter>: population standard deviation, defaults to the sample standard deviation</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>ref</parameter> contains less than two data items <function>ZTEST</function> returns #DIV/0! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CONFIDENCE"><function>CONFIDENCE</function></link>,
+ <link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
+ <link linkend="gnumeric-NORMINV"><function>NORMINV</function></link>,
+ <link linkend="gnumeric-NORMSDIST"><function>NORMSDIST</function></link>,
+ <link linkend="gnumeric-NORMSINV"><function>NORMSINV</function></link>,
+ <link linkend="gnumeric-STANDARDIZE"><function>STANDARDIZE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_String">
<title>String</title>
<refentry id="gnumeric-ASC">
@@ -18761,1181 +18761,1181 @@
<function>ASC</function>
</refname>
<refpurpose>
- text with full-width katakana and ASCII characters converted to half-width.
- </refpurpose>
+ text with full-width katakana and ASCII characters converted to half-width.
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASC</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>ASC</function> converts full-width katakana and ASCII characters to half-width equivalent characters, copying all others. </para>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>While in obsolete encodings <function>ASC</function> used to translate between 2-byte and 1-byte characters, this is not the case in UTF-8.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-JIS"><function>JIS</function></link>.
+ </para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>ASC</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ASC</function> converts full-width katakana and ASCII characters to half-width equivalent characters, copying all others. </para>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>While in obsolete encodings <function>ASC</function> used to translate between 2-byte and 1-byte characters, this is not the case in UTF-8.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-JIS"><function>JIS</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CHAR">
- <refmeta>
- <refentrytitle>
- <function>CHAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CHAR</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-CHAR">
+ <refmeta>
+ <refentrytitle>
+ <function>CHAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CHAR</function>
+ </refname>
+ <refpurpose>
the CP1252 (Windows-1252) character for the code point <parameter>x</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CHAR</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CHAR</function>(<parameter>x</parameter>) returns the CP1252 (Windows-1252) character with code <parameter>x</parameter>.</para>
- <para><parameter>x</parameter>: code point</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter> must be in the range 1 to 255.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>CP1252 (Windows-1252) is based on an early draft of ISO-8859-1, and contains all of its printable characters (but partially at different positions.)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>In CP1252 (Windows-1252), 129, 141, 143, 144, and 157 do not have matching characters.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>For <parameter>x</parameter> from 1 to 255 except 129, 141, 143, 144, and 157 we have CODE(<function>CHAR</function>(<parameter>x</parameter>))=<parameter>x</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>This function is Excel compatible.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CODE"><function>CODE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CLEAN">
- <refmeta>
- <refentrytitle>
- <function>CLEAN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CLEAN</function>
- </refname>
- <refpurpose><parameter>text</parameter> with any non-printable characters removed
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CLEAN</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CLEAN</function> removes non-printable characters from its argument leaving only regular characters and white-space.</para>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- <refentry id="gnumeric-CODE">
- <refmeta>
- <refentrytitle>
- <function>CODE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CODE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CHAR</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CHAR</function>(<parameter>x</parameter>) returns the CP1252 (Windows-1252) character with code <parameter>x</parameter>.</para>
+ <para><parameter>x</parameter>: code point</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter> must be in the range 1 to 255.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>CP1252 (Windows-1252) is based on an early draft of ISO-8859-1, and contains all of its printable characters (but partially at different positions.)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>In CP1252 (Windows-1252), 129, 141, 143, 144, and 157 do not have matching characters.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>For <parameter>x</parameter> from 1 to 255 except 129, 141, 143, 144, and 157 we have CODE(<function>CHAR</function>(<parameter>x</parameter>))=<parameter>x</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>This function is Excel compatible.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CODE"><function>CODE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CLEAN">
+ <refmeta>
+ <refentrytitle>
+ <function>CLEAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CLEAN</function>
+ </refname>
+ <refpurpose><parameter>text</parameter> with any non-printable characters removed
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CLEAN</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>CLEAN</function> removes non-printable characters from its argument leaving only regular characters and white-space.</para>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CODE">
+ <refmeta>
+ <refentrytitle>
+ <function>CODE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CODE</function>
+ </refname>
+ <refpurpose>
the CP1252 (Windows-1252) code point for the character <parameter>c</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>CODE</function>(<parameter>c</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>c</parameter> must be a valid CP1252 (Windows-1252) character.</para>
- <para><parameter>c</parameter>: character</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>CP1252 (Windows-1252) is based on an early draft of ISO-8859-1, and contains all of its printable characters (but partially at different positions.)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>In CP1252 (Windows-1252), 129, 141, 143, 144, and 157 do not have matching characters.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>For <parameter>x</parameter> from 1 to 255 except 129, 141, 143, 144, and 157 we have <function>CODE</function>(CHAR(<parameter>x</parameter>))=<parameter>x</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>This function is Excel compatible.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-CONCATENATE">
- <refmeta>
- <refentrytitle>
- <function>CONCATENATE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>CONCATENATE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>CODE</function>(<parameter>c</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>c</parameter> must be a valid CP1252 (Windows-1252) character.</para>
+ <para><parameter>c</parameter>: character</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>CP1252 (Windows-1252) is based on an early draft of ISO-8859-1, and contains all of its printable characters (but partially at different positions.)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>In CP1252 (Windows-1252), 129, 141, 143, 144, and 157 do not have matching characters.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>For <parameter>x</parameter> from 1 to 255 except 129, 141, 143, 144, and 157 we have <function>CODE</function>(CHAR(<parameter>x</parameter>))=<parameter>x</parameter>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>This function is Excel compatible.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-CONCATENATE">
+ <refmeta>
+ <refentrytitle>
+ <function>CONCATENATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CONCATENATE</function>
+ </refname>
+ <refpurpose>
the concatenation of the strings <parameter>s1</parameter>, <parameter>s2</parameter>,...
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>CONCATENATE</function>(<parameter>s1</parameter>,<parameter>s2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s1</parameter>: first string</para>
- <para><parameter>s2</parameter>: second string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-DOLLAR">
- <refmeta>
- <refentrytitle>
- <function>DOLLAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>DOLLAR</function>
- </refname>
- <refpurpose><parameter>num</parameter> formatted as currency.
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
- <link linkend="gnumeric-TEXT"><function>TEXT</function></link>,
- <link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>DOLLAR</function>(<parameter>num</parameter>,<parameter>decimals</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>num</parameter>: number</para>
- <para><parameter>decimals</parameter>: decimals</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-EXACT">
- <refmeta>
- <refentrytitle>
- <function>EXACT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>EXACT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>CONCATENATE</function>(<parameter>s1</parameter>,<parameter>s2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s1</parameter>: first string</para>
+ <para><parameter>s2</parameter>: second string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-DOLLAR">
+ <refmeta>
+ <refentrytitle>
+ <function>DOLLAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DOLLAR</function>
+ </refname>
+ <refpurpose><parameter>num</parameter> formatted as currency.
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
+ <link linkend="gnumeric-TEXT"><function>TEXT</function></link>,
+ <link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>DOLLAR</function>(<parameter>num</parameter>,<parameter>decimals</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>num</parameter>: number</para>
+ <para><parameter>decimals</parameter>: decimals</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-EXACT">
+ <refmeta>
+ <refentrytitle>
+ <function>EXACT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EXACT</function>
+ </refname>
+ <refpurpose>
TRUE if <parameter>string1</parameter> is exactly equal to <parameter>string2</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LEN"><function>LEN</function></link>,
- <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>,
- <link linkend="gnumeric-DELTA"><function>DELTA</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>EXACT</function>(<parameter>string1</parameter>,<parameter>string2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>string1</parameter>: first string</para>
- <para><parameter>string2</parameter>: second string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-FIND">
- <refmeta>
- <refentrytitle>
- <function>FIND</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FIND</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LEN"><function>LEN</function></link>,
+ <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>,
+ <link linkend="gnumeric-DELTA"><function>DELTA</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>EXACT</function>(<parameter>string1</parameter>,<parameter>string2</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>string1</parameter>: first string</para>
+ <para><parameter>string2</parameter>: second string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FIND">
+ <refmeta>
+ <refentrytitle>
+ <function>FIND</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FIND</function>
+ </refname>
+ <refpurpose>
first position of <parameter>string1</parameter> in <parameter>string2</parameter> following position <parameter>start</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FIND</function>(<parameter>string1</parameter>,<parameter>string2</parameter>,<parameter>start</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>string1</parameter>: search string</para>
- <para><parameter>string2</parameter>: search field</para>
- <para><parameter>start</parameter>: starting position, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This search is case-sensitive.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-EXACT"><function>EXACT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FINDB">
- <refmeta>
- <refentrytitle>
- <function>FINDB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FINDB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FIND</function>(<parameter>string1</parameter>,<parameter>string2</parameter>,<parameter>start</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>string1</parameter>: search string</para>
+ <para><parameter>string2</parameter>: search field</para>
+ <para><parameter>start</parameter>: starting position, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This search is case-sensitive.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EXACT"><function>EXACT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FINDB">
+ <refmeta>
+ <refentrytitle>
+ <function>FINDB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FINDB</function>
+ </refname>
+ <refpurpose>
first byte position of <parameter>string1</parameter> in <parameter>string2</parameter> following byte position <parameter>start</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>FINDB</function>(<parameter>string1</parameter>,<parameter>string2</parameter>,<parameter>start</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>string1</parameter>: search string</para>
- <para><parameter>string2</parameter>: search field</para>
- <para><parameter>start</parameter>: starting byte position, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This search is case-sensitive.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FIND"><function>FIND</function></link>,
- <link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
- <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>,
- <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-FIXED">
- <refmeta>
- <refentrytitle>
- <function>FIXED</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>FIXED</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FINDB</function>(<parameter>string1</parameter>,<parameter>string2</parameter>,<parameter>start</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>string1</parameter>: search string</para>
+ <para><parameter>string2</parameter>: search field</para>
+ <para><parameter>start</parameter>: starting byte position, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This search is case-sensitive.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FIND"><function>FIND</function></link>,
+ <link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
+ <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>,
+ <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-FIXED">
+ <refmeta>
+ <refentrytitle>
+ <function>FIXED</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FIXED</function>
+ </refname>
+ <refpurpose>
formatted string representation of <parameter>num</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-TEXT"><function>TEXT</function></link>,
- <link linkend="gnumeric-VALUE"><function>VALUE</function></link>,
- <link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>FIXED</function>(<parameter>num</parameter>,<parameter>decimals</parameter>,<parameter>no_commas</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>num</parameter>: number</para>
- <para><parameter>decimals</parameter>: number of decimals</para>
- <para><parameter>no_commas</parameter>: TRUE if no thousand separators should be used, defaults to FALSE</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-JIS">
- <refmeta>
- <refentrytitle>
- <function>JIS</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>JIS</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TEXT"><function>TEXT</function></link>,
+ <link linkend="gnumeric-VALUE"><function>VALUE</function></link>,
+ <link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>FIXED</function>(<parameter>num</parameter>,<parameter>decimals</parameter>,<parameter>no_commas</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>num</parameter>: number</para>
+ <para><parameter>decimals</parameter>: number of decimals</para>
+ <para><parameter>no_commas</parameter>: TRUE if no thousand separators should be used, defaults to FALSE</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-JIS">
+ <refmeta>
+ <refentrytitle>
+ <function>JIS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>JIS</function>
+ </refname>
+ <refpurpose>
text with half-width katakana and ASCII characters converted to full-width.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>JIS</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>JIS</function> converts half-width katakana and ASCII characters to full-width equivalent characters, copying all others. </para>
- <para><parameter>text</parameter>: original text</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>While in obsolete encodings <function>JIS</function> used to translate between 1-byte and 2-byte characters, this is not the case in UTF-8.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-ASC"><function>ASC</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LEFT">
- <refmeta>
- <refentrytitle>
- <function>LEFT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LEFT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>JIS</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>JIS</function> converts half-width katakana and ASCII characters to full-width equivalent characters, copying all others. </para>
+ <para><parameter>text</parameter>: original text</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>While in obsolete encodings <function>JIS</function> used to translate between 1-byte and 2-byte characters, this is not the case in UTF-8.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ASC"><function>ASC</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LEFT">
+ <refmeta>
+ <refentrytitle>
+ <function>LEFT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LEFT</function>
+ </refname>
+ <refpurpose>
the first <parameter>num_chars</parameter> characters of the string <parameter>s</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LEFT</function>(<parameter>s</parameter>,<parameter>num_chars</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- <para><parameter>num_chars</parameter>: the number of characters to return (defaults to 1)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the string <parameter>s</parameter> is in a right-to-left script, the returned first characters are from the right of the string.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>,
- <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
- <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LEFTB">
- <refmeta>
- <refentrytitle>
- <function>LEFTB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LEFTB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LEFT</function>(<parameter>s</parameter>,<parameter>num_chars</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ <para><parameter>num_chars</parameter>: the number of characters to return (defaults to 1)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the string <parameter>s</parameter> is in a right-to-left script, the returned first characters are from the right of the string.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>,
+ <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
+ <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LEFTB">
+ <refmeta>
+ <refentrytitle>
+ <function>LEFTB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LEFTB</function>
+ </refname>
+ <refpurpose>
the first characters of the string <parameter>s</parameter> comprising at most <parameter>num_bytes</parameter> bytes
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>LEFTB</function>(<parameter>s</parameter>,<parameter>num_bytes</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- <para><parameter>num_bytes</parameter>: the maximum number of bytes to return (defaults to 1)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The semantics of this function is subject to change as various applications implement it.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the string is in a right-to-left script, the returned first characters are from the right of the string.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
- <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>,
- <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-LEN">
- <refmeta>
- <refentrytitle>
- <function>LEN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LEN</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>LEFTB</function>(<parameter>s</parameter>,<parameter>num_bytes</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ <para><parameter>num_bytes</parameter>: the maximum number of bytes to return (defaults to 1)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The semantics of this function is subject to change as various applications implement it.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the string is in a right-to-left script, the returned first characters are from the right of the string.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
+ <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>,
+ <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LEN">
+ <refmeta>
+ <refentrytitle>
+ <function>LEN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LEN</function>
+ </refname>
+ <refpurpose>
the number of characters of the string <parameter>s</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
- <link linkend="gnumeric-CODE"><function>CODE</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>LEN</function>(<parameter>s</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-LENB">
- <refmeta>
- <refentrytitle>
- <function>LENB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LENB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
+ <link linkend="gnumeric-CODE"><function>CODE</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>LEN</function>(<parameter>s</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LENB">
+ <refmeta>
+ <refentrytitle>
+ <function>LENB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LENB</function>
+ </refname>
+ <refpurpose>
the number of bytes in the string <parameter>s</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
- <link linkend="gnumeric-CODE"><function>CODE</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>LENB</function>(<parameter>s</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-LOWER">
- <refmeta>
- <refentrytitle>
- <function>LOWER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>LOWER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
+ <link linkend="gnumeric-CODE"><function>CODE</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>LENB</function>(<parameter>s</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-LOWER">
+ <refmeta>
+ <refentrytitle>
+ <function>LOWER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>LOWER</function>
+ </refname>
+ <refpurpose>
a lower-case version of the string <parameter>text</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-UPPER"><function>UPPER</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>LOWER</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MID">
- <refmeta>
- <refentrytitle>
- <function>MID</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MID</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-UPPER"><function>UPPER</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>LOWER</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MID">
+ <refmeta>
+ <refentrytitle>
+ <function>MID</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MID</function>
+ </refname>
+ <refpurpose>
the substring of the string <parameter>s</parameter> starting at position <parameter>position</parameter> consisting of <parameter>length</parameter> characters
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>,
- <link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
- <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
- <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>MID</function>(<parameter>s</parameter>,<parameter>position</parameter>,<parameter>length</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- <para><parameter>position</parameter>: the starting position</para>
- <para><parameter>length</parameter>: the number of characters to return</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-MIDB">
- <refmeta>
- <refentrytitle>
- <function>MIDB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>MIDB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>,
+ <link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
+ <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
+ <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>MID</function>(<parameter>s</parameter>,<parameter>position</parameter>,<parameter>length</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ <para><parameter>position</parameter>: the starting position</para>
+ <para><parameter>length</parameter>: the number of characters to return</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-MIDB">
+ <refmeta>
+ <refentrytitle>
+ <function>MIDB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>MIDB</function>
+ </refname>
+ <refpurpose>
the characters following the first <parameter>start_pos</parameter> bytes comprising at most <parameter>num_bytes</parameter> bytes
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>MIDB</function>(<parameter>s</parameter>,<parameter>start_pos</parameter>,<parameter>num_bytes</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- <para><parameter>start_pos</parameter>: the number of the byte with which to start (defaults to 1)</para>
- <para><parameter>num_bytes</parameter>: the maximum number of bytes to return (defaults to 1)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The semantics of this function is subject to change as various applications implement it.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
- <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>,
- <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-NUMBERVALUE">
- <refmeta>
- <refentrytitle>
- <function>NUMBERVALUE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>NUMBERVALUE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>MIDB</function>(<parameter>s</parameter>,<parameter>start_pos</parameter>,<parameter>num_bytes</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ <para><parameter>start_pos</parameter>: the number of the byte with which to start (defaults to 1)</para>
+ <para><parameter>num_bytes</parameter>: the maximum number of bytes to return (defaults to 1)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The semantics of this function is subject to change as various applications implement it.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
+ <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>,
+ <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-NUMBERVALUE">
+ <refmeta>
+ <refentrytitle>
+ <function>NUMBERVALUE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NUMBERVALUE</function>
+ </refname>
+ <refpurpose>
numeric value of <parameter>text</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>NUMBERVALUE</function>(<parameter>text</parameter>,<parameter>separator</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- <para><parameter>separator</parameter>: decimal separator</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>text</parameter> does not look like a decimal number, <function>NUMBERVALUE</function> returns the value VALUE would return (ignoring the given <parameter>separator</parameter>).</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PROPER">
- <refmeta>
- <refentrytitle>
- <function>PROPER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PROPER</function>
- </refname>
- <refpurpose><parameter>text</parameter> with initial of each word capitalised.
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOWER"><function>LOWER</function></link>,
- <link linkend="gnumeric-UPPER"><function>UPPER</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>PROPER</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-REPLACE">
- <refmeta>
- <refentrytitle>
- <function>REPLACE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>REPLACE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NUMBERVALUE</function>(<parameter>text</parameter>,<parameter>separator</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ <para><parameter>separator</parameter>: decimal separator</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>text</parameter> does not look like a decimal number, <function>NUMBERVALUE</function> returns the value VALUE would return (ignoring the given <parameter>separator</parameter>).</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PROPER">
+ <refmeta>
+ <refentrytitle>
+ <function>PROPER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PROPER</function>
+ </refname>
+ <refpurpose><parameter>text</parameter> with initial of each word capitalised.
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOWER"><function>LOWER</function></link>,
+ <link linkend="gnumeric-UPPER"><function>UPPER</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>PROPER</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-REPLACE">
+ <refmeta>
+ <refentrytitle>
+ <function>REPLACE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>REPLACE</function>
+ </refname>
+ <refpurpose>
String <parameter>old</parameter> with <parameter>num</parameter> characters starting at <parameter>start</parameter> replaced by <parameter>new</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>,
- <link linkend="gnumeric-SUBSTITUTE"><function>SUBSTITUTE</function></link>,
- <link linkend="gnumeric-TRIM"><function>TRIM</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>REPLACE</function>(<parameter>old</parameter>,<parameter>start</parameter>,<parameter>num</parameter>,<parameter>new</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>old</parameter>: original text</para>
- <para><parameter>start</parameter>: starting position</para>
- <para><parameter>num</parameter>: number of characters to be replaced</para>
- <para><parameter>new</parameter>: replacement string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-REPLACEB">
- <refmeta>
- <refentrytitle>
- <function>REPLACEB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>REPLACEB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>,
+ <link linkend="gnumeric-SUBSTITUTE"><function>SUBSTITUTE</function></link>,
+ <link linkend="gnumeric-TRIM"><function>TRIM</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>REPLACE</function>(<parameter>old</parameter>,<parameter>start</parameter>,<parameter>num</parameter>,<parameter>new</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>old</parameter>: original text</para>
+ <para><parameter>start</parameter>: starting position</para>
+ <para><parameter>num</parameter>: number of characters to be replaced</para>
+ <para><parameter>new</parameter>: replacement string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-REPLACEB">
+ <refmeta>
+ <refentrytitle>
+ <function>REPLACEB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>REPLACEB</function>
+ </refname>
+ <refpurpose>
string <parameter>old</parameter> with up to <parameter>num</parameter> bytes starting at <parameter>start</parameter> replaced by <parameter>new</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>REPLACEB</function>(<parameter>old</parameter>,<parameter>start</parameter>,<parameter>num</parameter>,<parameter>new</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>REPLACEB</function> replaces the string of valid unicode characters starting at the byte <parameter>start</parameter> and ending at <parameter>start</parameter>+<parameter>num</parameter>-1 with the string <parameter>new</parameter>.</para>
- <para><parameter>old</parameter>: original text</para>
- <para><parameter>start</parameter>: starting byte position</para>
- <para><parameter>num</parameter>: number of bytes to be replaced</para>
- <para><parameter>new</parameter>: replacement string</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The semantics of this function is subject to change as various applications implement it.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>,
- <link linkend="gnumeric-SUBSTITUTE"><function>SUBSTITUTE</function></link>,
- <link linkend="gnumeric-TRIM"><function>TRIM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-REPT">
- <refmeta>
- <refentrytitle>
- <function>REPT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>REPT</function>
- </refname>
- <refpurpose><parameter>num</parameter> repetitions of string <parameter>text</parameter>
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CONCATENATE"><function>CONCATENATE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>REPT</function>(<parameter>text</parameter>,<parameter>num</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- <para><parameter>num</parameter>: non-negative integer</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-RIGHT">
- <refmeta>
- <refentrytitle>
- <function>RIGHT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RIGHT</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>REPLACEB</function>(<parameter>old</parameter>,<parameter>start</parameter>,<parameter>num</parameter>,<parameter>new</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>REPLACEB</function> replaces the string of valid unicode characters starting at the byte <parameter>start</parameter> and ending at <parameter>start</parameter>+<parameter>num</parameter>-1 with the string <parameter>new</parameter>.</para>
+ <para><parameter>old</parameter>: original text</para>
+ <para><parameter>start</parameter>: starting byte position</para>
+ <para><parameter>num</parameter>: number of bytes to be replaced</para>
+ <para><parameter>new</parameter>: replacement string</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The semantics of this function is subject to change as various applications implement it.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>,
+ <link linkend="gnumeric-SUBSTITUTE"><function>SUBSTITUTE</function></link>,
+ <link linkend="gnumeric-TRIM"><function>TRIM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-REPT">
+ <refmeta>
+ <refentrytitle>
+ <function>REPT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>REPT</function>
+ </refname>
+ <refpurpose><parameter>num</parameter> repetitions of string <parameter>text</parameter>
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CONCATENATE"><function>CONCATENATE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>REPT</function>(<parameter>text</parameter>,<parameter>num</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ <para><parameter>num</parameter>: non-negative integer</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RIGHT">
+ <refmeta>
+ <refentrytitle>
+ <function>RIGHT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RIGHT</function>
+ </refname>
+ <refpurpose>
the last <parameter>num_chars</parameter> characters of the string <parameter>s</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RIGHT</function>(<parameter>s</parameter>,<parameter>num_chars</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- <para><parameter>num_chars</parameter>: the number of characters to return (defaults to 1)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the string <parameter>s</parameter> is in a right-to-left script, the returned last characters are from the left of the string.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>,
- <link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
- <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
- <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-RIGHTB">
- <refmeta>
- <refentrytitle>
- <function>RIGHTB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>RIGHTB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RIGHT</function>(<parameter>s</parameter>,<parameter>num_chars</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ <para><parameter>num_chars</parameter>: the number of characters to return (defaults to 1)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the string <parameter>s</parameter> is in a right-to-left script, the returned last characters are from the left of the string.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>,
+ <link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
+ <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
+ <link linkend="gnumeric-RIGHTB"><function>RIGHTB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RIGHTB">
+ <refmeta>
+ <refentrytitle>
+ <function>RIGHTB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RIGHTB</function>
+ </refname>
+ <refpurpose>
the last characters of the string <parameter>s</parameter> comprising at most <parameter>num_bytes</parameter> bytes
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>RIGHTB</function>(<parameter>s</parameter>,<parameter>num_bytes</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>s</parameter>: the string</para>
- <para><parameter>num_bytes</parameter>: the maximum number of bytes to return (defaults to 1)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The semantics of this function is subject to change as various applications implement it.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If the string <parameter>s</parameter> is in a right-to-left script, the returned last characters are from the left of the string.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
- <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
- <link linkend="gnumeric-LENB"><function>LENB</function></link>,
- <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
- <link linkend="gnumeric-LEN"><function>LEN</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SEARCH">
- <refmeta>
- <refentrytitle>
- <function>SEARCH</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SEARCH</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RIGHTB</function>(<parameter>s</parameter>,<parameter>num_bytes</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>s</parameter>: the string</para>
+ <para><parameter>num_bytes</parameter>: the maximum number of bytes to return (defaults to 1)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The semantics of this function is subject to change as various applications implement it.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If the string <parameter>s</parameter> is in a right-to-left script, the returned last characters are from the left of the string.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LEFTB"><function>LEFTB</function></link>,
+ <link linkend="gnumeric-MIDB"><function>MIDB</function></link>,
+ <link linkend="gnumeric-LENB"><function>LENB</function></link>,
+ <link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>,
+ <link linkend="gnumeric-LEN"><function>LEN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SEARCH">
+ <refmeta>
+ <refentrytitle>
+ <function>SEARCH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SEARCH</function>
+ </refname>
+ <refpurpose>
the location of the <parameter>search</parameter> string within <parameter>text</parameter> after position <parameter>start</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SEARCH</function>(<parameter>search</parameter>,<parameter>text</parameter>,<parameter>start</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>search</parameter> may contain wildcard characters (*) and question marks (?). A question mark matches any single character, and a wildcard matches any string including the empty string. To search for * or ?, precede the symbol with ~.</para>
- <para><parameter>search</parameter>: search string</para>
- <para><parameter>text</parameter>: search field</para>
- <para><parameter>start</parameter>: starting position, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This search is not case sensitive.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>search</parameter> is not found, <function>SEARCH</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>start</parameter> is less than one or it is greater than the length of <parameter>text</parameter>, <function>SEARCH</function> returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FIND"><function>FIND</function></link>,
- <link linkend="gnumeric-SEARCHB"><function>SEARCHB</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SEARCHB">
- <refmeta>
- <refentrytitle>
- <function>SEARCHB</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SEARCHB</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SEARCH</function>(<parameter>search</parameter>,<parameter>text</parameter>,<parameter>start</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>search</parameter> may contain wildcard characters (*) and question marks (?). A question mark matches any single character, and a wildcard matches any string including the empty string. To search for * or ?, precede the symbol with ~.</para>
+ <para><parameter>search</parameter>: search string</para>
+ <para><parameter>text</parameter>: search field</para>
+ <para><parameter>start</parameter>: starting position, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This search is not case sensitive.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>search</parameter> is not found, <function>SEARCH</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>start</parameter> is less than one or it is greater than the length of <parameter>text</parameter>, <function>SEARCH</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FIND"><function>FIND</function></link>,
+ <link linkend="gnumeric-SEARCHB"><function>SEARCHB</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SEARCHB">
+ <refmeta>
+ <refentrytitle>
+ <function>SEARCHB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SEARCHB</function>
+ </refname>
+ <refpurpose>
the location of the <parameter>search</parameter> string within <parameter>text</parameter> after byte position <parameter>start</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>SEARCHB</function>(<parameter>search</parameter>,<parameter>text</parameter>,<parameter>start</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>search</parameter> may contain wildcard characters (*) and question marks (?). A question mark matches any single character, and a wildcard matches any string including the empty string. To search for * or ?, precede the symbol with ~.</para>
- <para><parameter>search</parameter>: search string</para>
- <para><parameter>text</parameter>: search field</para>
- <para><parameter>start</parameter>: starting byte position, defaults to 1</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>This search is not case sensitive.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>search</parameter> is not found, SEARCH returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>start</parameter> is less than one or it is greater than the byte length of <parameter>text</parameter>, SEARCH returns #VALUE!</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>The semantics of this function is subject to change as various applications implement it.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-FINDB"><function>FINDB</function></link>,
- <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-SUBSTITUTE">
- <refmeta>
- <refentrytitle>
- <function>SUBSTITUTE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>SUBSTITUTE</function>
- </refname>
- <refpurpose><parameter>text</parameter> with all occurrences of <parameter>old</parameter> replaced by <parameter>new</parameter>
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-REPLACE"><function>REPLACE</function></link>,
- <link linkend="gnumeric-TRIM"><function>TRIM</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>SUBSTITUTE</function>(<parameter>text</parameter>,<parameter>old</parameter>,<parameter>new</parameter>,<parameter>num</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: original text</para>
- <para><parameter>old</parameter>: string to be replaced</para>
- <para><parameter>new</parameter>: replacement string</para>
- <para><parameter>num</parameter>: if <parameter>num</parameter> is specified and a number only the <parameter>num</parameter>th occurrence of <parameter>old</parameter> is replaced</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-T">
- <refmeta>
- <refentrytitle>
- <function>T</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>T</function>
- </refname>
- <refpurpose><parameter>value</parameter> if and only if <parameter>value</parameter> is text, otherwise empty
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CELL"><function>CELL</function></link>,
- <link linkend="gnumeric-N"><function>N</function></link>,
- <link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>T</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: original value</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-TEXT">
- <refmeta>
- <refentrytitle>
- <function>TEXT</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TEXT</function>
- </refname>
- <refpurpose><parameter>value</parameter> as a string formatted as <parameter>format</parameter>
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>,
- <link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
- <link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>TEXT</function>(<parameter>value</parameter>,<parameter>format</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>value</parameter>: value to be formatted</para>
- <para><parameter>format</parameter>: desired format</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-TRIM">
- <refmeta>
- <refentrytitle>
- <function>TRIM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>TRIM</function>
- </refname>
- <refpurpose><parameter>text</parameter> with only single spaces between words.
- </refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CLEAN"><function>CLEAN</function></link>,
- <link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-REPLACE"><function>REPLACE</function></link>,
- <link linkend="gnumeric-SUBSTITUTE"><function>SUBSTITUTE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>TRIM</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-UNICHAR">
- <refmeta>
- <refentrytitle>
- <function>UNICHAR</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>UNICHAR</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SEARCHB</function>(<parameter>search</parameter>,<parameter>text</parameter>,<parameter>start</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>search</parameter> may contain wildcard characters (*) and question marks (?). A question mark matches any single character, and a wildcard matches any string including the empty string. To search for * or ?, precede the symbol with ~.</para>
+ <para><parameter>search</parameter>: search string</para>
+ <para><parameter>text</parameter>: search field</para>
+ <para><parameter>start</parameter>: starting byte position, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>This search is not case sensitive.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>search</parameter> is not found, SEARCH returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>start</parameter> is less than one or it is greater than the byte length of <parameter>text</parameter>, SEARCH returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>The semantics of this function is subject to change as various applications implement it.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-FINDB"><function>FINDB</function></link>,
+ <link linkend="gnumeric-SEARCH"><function>SEARCH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SUBSTITUTE">
+ <refmeta>
+ <refentrytitle>
+ <function>SUBSTITUTE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SUBSTITUTE</function>
+ </refname>
+ <refpurpose><parameter>text</parameter> with all occurrences of <parameter>old</parameter> replaced by <parameter>new</parameter>
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-REPLACE"><function>REPLACE</function></link>,
+ <link linkend="gnumeric-TRIM"><function>TRIM</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>SUBSTITUTE</function>(<parameter>text</parameter>,<parameter>old</parameter>,<parameter>new</parameter>,<parameter>num</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: original text</para>
+ <para><parameter>old</parameter>: string to be replaced</para>
+ <para><parameter>new</parameter>: replacement string</para>
+ <para><parameter>num</parameter>: if <parameter>num</parameter> is specified and a number only the <parameter>num</parameter>th occurrence of <parameter>old</parameter> is replaced</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-T">
+ <refmeta>
+ <refentrytitle>
+ <function>T</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>T</function>
+ </refname>
+ <refpurpose><parameter>value</parameter> if and only if <parameter>value</parameter> is text, otherwise empty
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CELL"><function>CELL</function></link>,
+ <link linkend="gnumeric-N"><function>N</function></link>,
+ <link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>T</function>(<parameter>value</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: original value</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TEXT">
+ <refmeta>
+ <refentrytitle>
+ <function>TEXT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TEXT</function>
+ </refname>
+ <refpurpose><parameter>value</parameter> as a string formatted as <parameter>format</parameter>
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>,
+ <link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
+ <link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>TEXT</function>(<parameter>value</parameter>,<parameter>format</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>value</parameter>: value to be formatted</para>
+ <para><parameter>format</parameter>: desired format</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-TRIM">
+ <refmeta>
+ <refentrytitle>
+ <function>TRIM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>TRIM</function>
+ </refname>
+ <refpurpose><parameter>text</parameter> with only single spaces between words.
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CLEAN"><function>CLEAN</function></link>,
+ <link linkend="gnumeric-MID"><function>MID</function></link>,
+ <link linkend="gnumeric-REPLACE"><function>REPLACE</function></link>,
+ <link linkend="gnumeric-SUBSTITUTE"><function>SUBSTITUTE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>TRIM</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-UNICHAR">
+ <refmeta>
+ <refentrytitle>
+ <function>UNICHAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>UNICHAR</function>
+ </refname>
+ <refpurpose>
the Unicode character represented by the Unicode code point <parameter>x</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
- <link linkend="gnumeric-UNICODE"><function>UNICODE</function></link>,
- <link linkend="gnumeric-CODE"><function>CODE</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>UNICHAR</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>x</parameter>: Unicode code point</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-UNICODE">
- <refmeta>
- <refentrytitle>
- <function>UNICODE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>UNICODE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
+ <link linkend="gnumeric-UNICODE"><function>UNICODE</function></link>,
+ <link linkend="gnumeric-CODE"><function>CODE</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>UNICHAR</function>(<parameter>x</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>x</parameter>: Unicode code point</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-UNICODE">
+ <refmeta>
+ <refentrytitle>
+ <function>UNICODE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>UNICODE</function>
+ </refname>
+ <refpurpose>
the Unicode code point for the character <parameter>c</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-UNICHAR"><function>UNICHAR</function></link>,
- <link linkend="gnumeric-CODE"><function>CODE</function></link>,
- <link linkend="gnumeric-CHAR"><function>CHAR</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>UNICODE</function>(<parameter>c</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>c</parameter>: character</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-UPPER">
- <refmeta>
- <refentrytitle>
- <function>UPPER</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>UPPER</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-UNICHAR"><function>UNICHAR</function></link>,
+ <link linkend="gnumeric-CODE"><function>CODE</function></link>,
+ <link linkend="gnumeric-CHAR"><function>CHAR</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>UNICODE</function>(<parameter>c</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>c</parameter>: character</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-UPPER">
+ <refmeta>
+ <refentrytitle>
+ <function>UPPER</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>UPPER</function>
+ </refname>
+ <refpurpose>
an upper-case version of the string <parameter>text</parameter>.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-LOWER"><function>LOWER</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>UPPER</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- </refsect1>
- <refentry id="gnumeric-VALUE">
- <refmeta>
- <refentrytitle>
- <function>VALUE</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>VALUE</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LOWER"><function>LOWER</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>UPPER</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-VALUE">
+ <refmeta>
+ <refentrytitle>
+ <function>VALUE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>VALUE</function>
+ </refname>
+ <refpurpose>
numeric value of <parameter>text</parameter>
</refpurpose>
- </refnamediv>
- </refentry>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>,
- <link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
- <link linkend="gnumeric-TEXT"><function>TEXT</function></link>.
- </para>
- <refsynopsisdiv>
- <synopsis><function>VALUE</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><parameter>text</parameter>: string</para>
- </refsect1>
- </refsect1>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>,
+ <link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
+ <link linkend="gnumeric-TEXT"><function>TEXT</function></link>.
+ </para>
+ <refsynopsisdiv>
+ <synopsis><function>VALUE</function>(<parameter>text</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>text</parameter>: string</para>
+ </refsect1>
+ </refsect1>
+ </refentry>
+ </sect1>
<sect1 id="CATEGORY_Time_Series_Analysis">
<title>Time Series Analysis</title>
<refentry id="gnumeric-FOURIER">
@@ -19949,141 +19949,141 @@
<function>FOURIER</function>
</refname>
<refpurpose>
- Fourier or inverse Fourier transform.
- </refpurpose>
+ Fourier or inverse Fourier transform.
+ </refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>FOURIER</function>(<parameter>Sequence</parameter>,<parameter>Inverse</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This array function returns the Fourier or inverse Fourier transform of the given data sequence.</para>
+ <para><parameter>Sequence</parameter>: the data sequence to be transformed</para>
+ <para><parameter>Inverse</parameter>: if false, the inverse Fourier transform is calculated. Defaults to false</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>The output consists always of one column of complex numbers.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>Sequence</parameter> is neither an n by 1 nor 1 by n array, this function returns #NUM!</para>
+ </refsect1>
</refentry>
- </sect1>
- <refsynopsisdiv>
- <synopsis><function>FOURIER</function>(<parameter>Sequence</parameter>,<parameter>Inverse</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This array function returns the Fourier or inverse Fourier transform of the given data sequence.</para>
- <para><parameter>Sequence</parameter>: the data sequence to be transformed</para>
- <para><parameter>Inverse</parameter>: if false, the inverse Fourier transform is calculated. Defaults to false</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>The output consists always of one column of complex numbers.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If <parameter>Sequence</parameter> is neither an n by 1 nor 1 by n array, this function returns #NUM!</para>
- </refsect1>
- <refentry id="gnumeric-INTERPOLATION">
- <refmeta>
- <refentrytitle>
- <function>INTERPOLATION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INTERPOLATION</function>
- </refname>
- <refpurpose>
+ <refentry id="gnumeric-INTERPOLATION">
+ <refmeta>
+ <refentrytitle>
+ <function>INTERPOLATION</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>INTERPOLATION</function>
+ </refname>
+ <refpurpose>
interpolated values corresponding to the given abscissa targets.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>INTERPOLATION</function>(<parameter>abscissas</parameter>,<parameter>ordinates</parameter>,<parameter>targets</parameter>,<parameter>interpolation</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.</para>
- <para><parameter>abscissas</parameter>: The abscissas of the data to interpolate.</para>
- <para><parameter>ordinates</parameter>: The ordinates of the data to interpolate.</para>
- <para><parameter>targets</parameter>: The abscissas of the interpolated data.</para>
- <para><parameter>interpolation</parameter>: The method of interpolation to be used, defaults to no interpolation</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>The output consists always of one column of numbers.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Possible interpolation methods are:</para>
- <para>0: linear;</para>
- <para>1: linear with averaging;</para>
- <para>2: staircase;</para>
- <para>3: staircase with averaging;</para>
- <para>4: natural cubic spline;</para>
- <para>5: natural cubic spline with averaging.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Strings and empty cells in <parameter>abscissas</parameter> and <parameter>ordinates</parameter> are ignored.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If several target data are provided they must be in the same column in consecutive cells.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-PERIODOGRAM"><function>PERIODOGRAM</function></link>.
- </para>
- </refsect1>
- <refentry id="gnumeric-PERIODOGRAM">
- <refmeta>
- <refentrytitle>
- <function>PERIODOGRAM</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>PERIODOGRAM</function>
- </refname>
- <refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>INTERPOLATION</function>(<parameter>abscissas</parameter>,<parameter>ordinates</parameter>,<parameter>targets</parameter>,<parameter>interpolation</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.</para>
+ <para><parameter>abscissas</parameter>: The abscissas of the data to interpolate.</para>
+ <para><parameter>ordinates</parameter>: The ordinates of the data to interpolate.</para>
+ <para><parameter>targets</parameter>: The abscissas of the interpolated data.</para>
+ <para><parameter>interpolation</parameter>: The method of interpolation to be used, defaults to no interpolation</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>The output consists always of one column of numbers.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Possible interpolation methods are:</para>
+ <para>0: linear;</para>
+ <para>1: linear with averaging;</para>
+ <para>2: staircase;</para>
+ <para>3: staircase with averaging;</para>
+ <para>4: natural cubic spline;</para>
+ <para>5: natural cubic spline with averaging.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Strings and empty cells in <parameter>abscissas</parameter> and <parameter>ordinates</parameter> are ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If several target data are provided they must be in the same column in consecutive cells.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-PERIODOGRAM"><function>PERIODOGRAM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-PERIODOGRAM">
+ <refmeta>
+ <refentrytitle>
+ <function>PERIODOGRAM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PERIODOGRAM</function>
+ </refname>
+ <refpurpose>
Periodogram of the given data.
</refpurpose>
- </refnamediv>
- </refentry>
- <refsynopsisdiv>
- <synopsis><function>PERIODOGRAM</function>(<parameter>ordinates</parameter>,<parameter>filter</parameter>,<parameter>abscissas</parameter>,<parameter>interpolation</parameter>,<parameter>number</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.</para>
- <para><parameter>ordinates</parameter>: The ordinates of the data to interpolate.</para>
- <para><parameter>filter</parameter>: Window function to be used, defaults to no window function.</para>
- <para><parameter>abscissas</parameter>: The abscissas of the data to interpolate, defaults to regularly spaced abscissa.</para>
- <para><parameter>interpolation</parameter>: The method of interpolation to be used, defaults to no interpolation</para>
- <para><parameter>number</parameter>: Number of interpolated data points to be used.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>The output consists always of one column of numbers.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Possible interpolation methods are:</para>
- <para>0: linear;</para>
- <para>1: linear with averaging;</para>
- <para>2: staircase;</para>
- <para>3: staircase with averaging;</para>
- <para>4: natural cubic spline;</para>
- <para>5: natural cubic spline with averaging.</para>
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>Possible window functions are:</para>
- <para>0: no filter (rectangular window)</para>
- <para>1: Bartlett (triangular window)</para>
- <para>2: Hahn (cosine window)</para>
- <para>3: Welch (parabolic window)</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>Strings and empty cells in <parameter>abscissas</parameter> and <parameter>ordinates</parameter> are ignored.</para>
- </refsect1>
- <refsect1>
- <title>Note</title>
- <para>If several target data are provided they must be in the same column in consecutive cells.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INTERPOLATION"><function>INTERPOLATION</function></link>.
- </para>
- </refsect1>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PERIODOGRAM</function>(<parameter>ordinates</parameter>,<parameter>filter</parameter>,<parameter>abscissas</parameter>,<parameter>interpolation</parameter>,<parameter>number</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.</para>
+ <para><parameter>ordinates</parameter>: The ordinates of the data to interpolate.</para>
+ <para><parameter>filter</parameter>: Window function to be used, defaults to no window function.</para>
+ <para><parameter>abscissas</parameter>: The abscissas of the data to interpolate, defaults to regularly spaced abscissa.</para>
+ <para><parameter>interpolation</parameter>: The method of interpolation to be used, defaults to no interpolation</para>
+ <para><parameter>number</parameter>: Number of interpolated data points to be used.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>The output consists always of one column of numbers.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Possible interpolation methods are:</para>
+ <para>0: linear;</para>
+ <para>1: linear with averaging;</para>
+ <para>2: staircase;</para>
+ <para>3: staircase with averaging;</para>
+ <para>4: natural cubic spline;</para>
+ <para>5: natural cubic spline with averaging.</para>
+ </refsect1>
+ <refsect1>
+ <title>Description</title>
+ <para>Possible window functions are:</para>
+ <para>0: no filter (rectangular window)</para>
+ <para>1: Bartlett (triangular window)</para>
+ <para>2: Hahn (cosine window)</para>
+ <para>3: Welch (parabolic window)</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Strings and empty cells in <parameter>abscissas</parameter> and <parameter>ordinates</parameter> are ignored.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If several target data are provided they must be in the same column in consecutive cells.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-INTERPOLATION"><function>INTERPOLATION</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ </sect1>
</appendix>
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 67bbaaa..f3913d1 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,5 +1,11 @@
2010-01-07 Andreas J. Guelzow <aguelzow pyrshep>
+ * make-func-list.pl (process_function):
+ don't push refnamediv
+ (process_short_desc): close refnamediv
+
+2010-01-07 Andreas J. Guelzow <aguelzow pyrshep>
+
* make-func-list.pl: also include the short
description
diff --git a/doc/make-func-list.pl b/doc/make-func-list.pl
index 868e6b9..c313eed 100755
--- a/doc/make-func-list.pl
+++ b/doc/make-func-list.pl
@@ -121,7 +121,6 @@ sub process_function($) {
print $ws, " <refnamediv>\n";
print $ws, " <refname><function>$func</function></refname>\n";
push @tagstack, ('</refentry>');
- push @tagstack, ('</refnamediv>');
}
sub process_short_desc($) {
@@ -131,7 +130,7 @@ sub process_short_desc($) {
print $ws, " <refpurpose>\n";
print $ws, " ", &markup_stuff ($desc), "\n";
print $ws, " </refpurpose>\n";
- close_including('/refnamediv');
+ print $ws, "</refnamediv>\n";
}
sub process_description($) {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
