[gnumeric] Regenerated (using rewritten script)
- From: J.H.M. Dassen (Ray) <jdassen src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gnumeric] Regenerated (using rewritten script)
- Date: Sat, 22 Aug 2009 20:14:51 +0000 (UTC)
commit df82502f58cdfcf1c96423001940037790de4458
Author: J.H.M. Dassen (Ray) <jdassen debian org>
Date: Sat Aug 22 22:02:22 2009 +0200
Regenerated (using rewritten script)
doc/C/functions.xml |11176 +++++++++++----------------------------------------
1 files changed, 2414 insertions(+), 8762 deletions(-)
---
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index deed76c..9cd80a9 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -26,11 +26,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BITAND</function> function returns bitwise and-ing of its arguments.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -52,20 +50,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BITLSHIFT</function>(<parameter>x</parameter>,<parameter>n</parameter>)</synopsis>
+ <synopsis><function>BITLSHIFT</function>(<parameter>a</parameter>,<parameter>n</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BITLSHIFT</function> function returns <parameter>x</parameter> bit-shifted left by <parameter>n</parameter> bits.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>n</parameter> is negative, a right shift will in effect be performed.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -90,11 +81,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BITOR</function> function returns bitwise or-ing of its arguments.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -116,20 +105,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BITRSHIFT</function>(<parameter>x</parameter>,<parameter>n</parameter>)</synopsis>
+ <synopsis><function>BITRSHIFT</function>(<parameter>a</parameter>,<parameter>n</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BITRSHIFT</function> function returns <parameter>x</parameter> bit-shifted right by <parameter>n</parameter> bits.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>n</parameter> is negative, a left shift will in effect be performed.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -154,11 +136,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BITXOR</function> function returns bitwise exclusive or-ing of its arguments.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -182,32 +162,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COMPLEX</function>(<parameter>real</parameter>,<parameter>im</parameter>[,<parameter>suffix</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COMPLEX</function> returns a complex number of the form x + yi.</para>
- <para><parameter>real</parameter> is the real and <parameter>im</parameter> is the imaginary part of the complex number. <parameter>suffix</parameter> is the suffix for the imaginary part. If it is omitted, <function>COMPLEX</function> uses 'i' by default.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>suffix</parameter> is neither 'i' nor 'j', <function>COMPLEX</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COMPLEX</function>(1,-1) equals 1-i.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-IMABS">
<refmeta>
@@ -221,26 +175,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMABS</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMABS</function> returns the absolute value of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMABS</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMABS</function>("2-j") equals 2.23606798.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>,
@@ -260,26 +194,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMAGINARY</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMAGINARY</function> returns the imaginary part of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMAGINARY</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMAGINARY</function>("132-j") equals -1.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMREAL"><function>IMREAL</function></link>.
@@ -299,21 +213,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARCCOS</function>(<parameter>inumber</parameter>)</synopsis>
+ <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>inumber</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCCOS</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCCOS</function>("1+j") equals 0.9045569-1.061275j.</para>
+ <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>See also</title>
@@ -335,21 +240,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARCCOSH</function>(<parameter>inumber</parameter>)</synopsis>
+ <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>inumber</parameter>. The branch cut is on the real axis, less than 1.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCCOSH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCCOSH</function>("1+j") equals 1.06127506+0.904557j.</para>
+ <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>See also</title>
@@ -370,24 +266,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMARCCOT</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCCOT</function> returns the complex arccotangent of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> arccot(z) = arctan(1/z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCCOT</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCCOT</function>("1+j") equals 0.553574+0.4023595j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMARCSEC"><function>IMARCSEC</function></link>,
@@ -407,24 +285,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMARCCOTH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCCOTH</function> returns the complex hyperbolic arccotangent of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> arccoth(z) = arctanh(1/z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCCOTH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCCOTH</function>("1+j") equals 0.40235948-0.5535744j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMARCSECH"><function>IMARCSECH</function></link>,
@@ -444,24 +304,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMARCCSC</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCCSC</function> returns the complex arccosecant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> arccsc(z) = arcsin(1/z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCCSC</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCCSC</function>("1+j") equals 0.45227845-0.5306375j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMARCSEC"><function>IMARCSEC</function></link>,
@@ -481,24 +323,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMARCCSCH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCCSCH</function> returns the complex hyperbolic arccosecant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> arccsch(z) = arcsinh(1/z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCCSCH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCCSCH</function>("1+j") equals 0.5306375-0.452278j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMARCSECH"><function>IMARCSECH</function></link>,
@@ -518,24 +342,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMARCSEC</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCSEC</function> returns the complex arcsecant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> arcsec(z) = arccos(1/z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCSEC</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCSEC</function>("1+j") equals 1.1185179+0.5306375j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMARCCSC"><function>IMARCCSC</function></link>,
@@ -555,24 +361,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMARCSECH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMARCSECH</function> returns the complex hyperbolic arcsecant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> arcsech(z) = arccosh(1/z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCSECH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCSECH</function>("1+j") equals 0.5306375-1.118518j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMARCCSCH"><function>IMARCCSCH</function></link>,
@@ -593,21 +381,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARCSIN</function>(<parameter>inumber</parameter>)</synopsis>
+ <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>inumber</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCSIN</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCSIN</function>("1+j") equals 0.6662394+1.061275j.</para>
+ <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>See also</title>
@@ -629,21 +408,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARCSINH</function>(<parameter>inumber</parameter>)</synopsis>
+ <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>inumber</parameter>. The branch cuts are on the imaginary axis, below -i and above i.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCSINH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCSINH</function>("1+j") equals 1.061275+0.6662394j.</para>
+ <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>See also</title>
@@ -665,21 +435,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARCTAN</function>(<parameter>inumber</parameter>)</synopsis>
+ <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>inumber</parameter>. The branch cuts are on the imaginary axis, below -i and above i.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCTAN</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCTAN</function>("1+j") equals 1.0172220+0.4023595j.</para>
+ <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>See also</title>
@@ -701,21 +462,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARCTANH</function>(<parameter>inumber</parameter>)</synopsis>
+ <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>inumber</parameter>. The branch cuts are on the real axis, less than -1 and greater than 1.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARCTANH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARCTANH</function>("1+j") equals 0.4023595+1.0172220j.</para>
+ <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>See also</title>
@@ -737,29 +489,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMARGUMENT</function>(<parameter>inumber</parameter>)</synopsis>
+ <synopsis><function>IMARGUMENT</function>(<parameter>z</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IMARGUMENT</function> returns the argument theta of a complex number, i.e. the angle in radians from the real axis to the representation of the number in polar coordinates.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMARGUMENT</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMARGUMENT</function>("2-j") equals -0.463647609.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <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>
</refentry>
<refentry id="gnumeric-IMCONJUGATE">
@@ -774,26 +509,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMCONJUGATE</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMCONJUGATE</function> returns the complex conjugate of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCONJUGATE</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCONJUGATE</function>("1-j") equals 1+j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>,
@@ -813,26 +528,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMCOS</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMCOS</function> returns the cosine of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCOS</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCOS</function>("1+j") equals 0.833730-0.988898j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSIN"><function>IMSIN</function></link>,
@@ -852,24 +547,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMCOSH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMCOSH</function> returns the complex hyperbolic cosine of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> cosh(z) = (exp(z) + exp(-z))/2.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCOSH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCOSH</function>("1+j") equals 0.83373+0.988898j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSINH"><function>IMSINH</function></link>,
@@ -890,22 +567,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMCOT</function>(<parameter>inumber</parameter>)</synopsis>
+ <synopsis><function>IMCOT</function>(<parameter>z</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IMCOT</function> returns the complex cotangent of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> cot(z) = 1/tan(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCOT</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCOT</function>("2-j") equals -0.171384+0.821330j.</para>
+ <para>cotz = cosz/sinz.</para>
+ <para><parameter>z</parameter>: a complex number</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -926,24 +593,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMCOTH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMCOTH</function> returns the complex hyperbolic cotangent of the complex number z (<parameter>inumber</parameter>) where,</para>
- <para> coth(z) = 1/tanh(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCOTH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCOTH</function>("1+j") equals 0.868014-0.217622j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSECH"><function>IMSECH</function></link>,
@@ -964,22 +613,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMCSC</function>(<parameter>inumber</parameter>)</synopsis>
+ <synopsis><function>IMCSC</function>(<parameter>z</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IMCSC</function> returns the complex cosecant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> csc(z) = 1/sin(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCSC</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCSC</function>("2-j") equals 0.635494-0.221501j.</para>
+ <para>cscz = 1/sinz.</para>
+ <para><parameter>z</parameter>: a complex number</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -1000,24 +639,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMCSCH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMCSCH</function> returns the complex hyperbolic cosecant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> csch(z) = 1/sinh(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMCSCH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMCSCH</function>("1+j") equals 0.303931-0.621518j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSECH"><function>IMSECH</function></link>,
@@ -1037,26 +658,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMDIV</function>(<parameter>inumber1</parameter>,<parameter>inumber2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMDIV</function> returns the quotient of two complex numbers.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber1</parameter> or <parameter>inumber2</parameter> are not valid complex numbers, <function>IMDIV</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMDIV</function>("2-j","2+j") equals 0.6-0.8j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMPRODUCT"><function>IMPRODUCT</function></link>.
@@ -1075,26 +676,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMEXP</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMEXP</function> returns the exponential of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMEXP</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMEXP</function>("2-j") equals 3.992324-6.217676j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>.
@@ -1113,29 +694,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMINV</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMINV</function> returns the inverse, or reciprocal, of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> 1/z = (x - i y)/(x^2 + y^2).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMINV</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMINV</function>("1-j") equals 0.5+0.5j.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-IMLN">
<refmeta>
@@ -1150,25 +708,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMLN</function>(<parameter>inumber</parameter>)</synopsis>
+ <synopsis><function>IMLN</function>(<parameter>z</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IMLN</function> returns the natural logarithm of a complex number.</para>
- <para>The result will have an imaginary part between -pi and +pi. The natural logarithm is not uniquely defined on complex numbers. You may need to add or subtract an even multiple of pi to the imaginary part.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMLN</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMLN</function>("3-j") equals 1.15129-0.32175j.</para>
+ <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>See also</title>
@@ -1190,26 +736,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMLOG10</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMLOG10</function> returns the logarithm of a complex number in base 10.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMLOG10</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMLOG10</function>("3-j") equals 0.5-0.13973j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>,
@@ -1229,26 +755,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMLOG2</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMLOG2</function> returns the logarithm of a complex number in base 2.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMLOG2</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMLOG2</function>("3-j") equals 1.66096-0.46419j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMLN"><function>IMLN</function></link>,
@@ -1268,29 +774,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMNEG</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMNEG</function> returns the negative of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> -z = (-x) + i(-y).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMNEG</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMNEG</function>("1-j") equals -1+j.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-IMPOWER">
<refmeta>
@@ -1304,26 +787,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMPOWER</function>(<parameter>inumber1</parameter>,<parameter>inumber2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMPOWER</function> returns a complex number raised to a power. <parameter>inumber1</parameter> is the complex number to be raised to a power and <parameter>inumber2</parameter> is the power to which you want to raise it.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber1</parameter> or <parameter>inumber2</parameter> are not valid complex numbers, <function>IMPOWER</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMPOWER</function>("4-j",2) equals 15-8j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSQRT"><function>IMSQRT</function></link>.
@@ -1342,26 +805,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMPRODUCT</function>(<parameter>inumber1</parameter>[,<parameter>inumber2</parameter>,<parameter/>...])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMPRODUCT</function> returns the product of given complex numbers.</para>
- <itemizedlist>
- <listitem>
- <para>If any of the <parameter>inumbers</parameter> are not valid complex numbers, <function>IMPRODUCT</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMPRODUCT</function>("2-j","4-2j") equals 6-8j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMDIV"><function>IMDIV</function></link>.
@@ -1380,26 +823,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMREAL</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMREAL</function> returns the real part of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMREAL</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>imreal("132-j") equals 132.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMAGINARY"><function>IMAGINARY</function></link>.
@@ -1419,22 +842,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IMSEC</function>(<parameter>inumber</parameter>)</synopsis>
+ <synopsis><function>IMSEC</function>(<parameter>z</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IMSEC</function> returns the complex secant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> sec(z) = 1/cos(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMSEC</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSEC</function>("2-j") equals -0.413149-0.687527j.</para>
+ <para>secz = 1/cosz.</para>
+ <para><parameter>z</parameter>: a complex number</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -1455,24 +868,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMSECH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMSECH</function> returns the complex hyperbolic secant of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> sech(z) = 1/cosh(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMSECH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSECH</function>("1+j") equals 0.498337-0.5910838j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMCSCH"><function>IMCSCH</function></link>,
@@ -1492,26 +887,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMSIN</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMSIN</function> returns the sine of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMSIN</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSIN</function>("1+j") equals 1.29846+0.63496j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMCOS"><function>IMCOS</function></link>,
@@ -1531,24 +906,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMSINH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMSINH</function> returns the complex hyperbolic sine of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> sinh(z) = (exp(z) - exp(-z))/2.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMSINH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSINH</function>("1+j") equals 0.63496+1.29846j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMCOSH"><function>IMCOSH</function></link>,
@@ -1568,26 +925,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMSQRT</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMSQRT</function> returns the square root of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMSQRT</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSQRT</function>("1+j") equals 1.09868+0.4550899j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMPOWER"><function>IMPOWER</function></link>.
@@ -1606,26 +943,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMSUB</function>(<parameter>inumber1</parameter>,<parameter>inumber2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMSUB</function> returns the difference of two complex numbers.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber1</parameter> or <parameter>inumber2</parameter> are not valid complex numbers, <function>IMSUB</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSUB</function>("3-j","2+j") equals 1-2j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSUM"><function>IMSUM</function></link>.
@@ -1644,26 +961,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMSUM</function>(<parameter>inumber1</parameter>,<parameter>inumber2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMSUM</function> returns the sum of two complex numbers.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber1</parameter> or <parameter>inumber2</parameter> are not valid complex numbers, <function>IMSUM</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMSUM</function>("2-4j","9-j") equals 11-5j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSUB"><function>IMSUB</function></link>.
@@ -1682,26 +979,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMTAN</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMTAN</function> returns the tangent of a complex number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMTAN</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMTAN</function>("2-j") equals -0.2434582-1.1667363j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSIN"><function>IMSIN</function></link>,
@@ -1721,24 +998,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>IMTANH</function>(<parameter>inumber</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>IMTANH</function> returns the complex hyperbolic tangent of the complex number z (<parameter>inumber</parameter>), where</para>
- <para> tanh(z) = sinh(z)/cosh(z).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>inumber</parameter> is not a valid complex number, <function>IMTANH</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IMTANH</function>("1+j") equals 1.083923+0.2717526j.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-IMSINH"><function>IMSINH</function></link>,
@@ -1766,32 +1025,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DAVERAGE</function> function returns the average of the values in a list or database that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DAVERAGE</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DAVERAGE</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DAVERAGE</function>(A1:C7, "Salary", A9:A11) equals 42296.3333.</para>
- <para><function>DAVERAGE</function>(A1:C7, "Age", A9:A11) equals 39.</para>
- <para><function>DAVERAGE</function>(A1:C7, "Salary", A9:B11) equals 40782.5.</para>
- <para><function>DAVERAGE</function>(A1:C7, "Age", A9:B11) equals 36.</para>
+ <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>
+ <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>See also</title>
@@ -1816,35 +1073,35 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DCOUNT</function> function counts the cells that contain numbers in a database that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DCOUNT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DCOUNT</function>(A1:C7, "Salary", A9:A11) equals 3.</para>
- <para><function>DCOUNT</function>(A1:C7, "Salary", A9:B11) equals 2.</para>
- <para><function>DCOUNT</function>(A1:C7, "Name", A9:B11) equals 0.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DCOUNT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
- <para><link linkend="gnumeric-DAVERAGE"><function>DAVERAGE</function></link>.
+ <para><link linkend="gnumeric-DAVERAGE"><function>DAVERAGE</function></link>,
+ <link linkend="gnumeric-DCOUNTA"><function>DCOUNTA</function></link>.
</para>
</refsect1>
</refentry>
@@ -1865,31 +1122,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DCOUNTA</function> function counts the cells that contain data in a database that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DCOUNTA</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DCOUNTA</function>(A1:C7, "Salary", A9:A11) equals 3.</para>
- <para><function>DCOUNTA</function>(A1:C7, "Salary", A9:B11) equals 2.</para>
- <para><function>DCOUNTA</function>(A1:C7, "Name", A9:B11) equals 2.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DCOUNTA</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -1914,38 +1170,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DGET</function> function returns a single value from a column that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DGET</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <itemizedlist>
- <listitem>
- <para>If none of the items match the conditions, <function>DGET</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>If more than one items match the conditions, <function>DGET</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- <para><function>DGET</function>(A1:C7, "Salary", A9:A10) equals 34323.</para>
- <para><function>DGET</function>(A1:C7, "Name", A9:A10) equals "Clark".</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DGET</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -1970,31 +1218,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DMAX</function> function returns the largest number in a column that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DMAX</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DMAX</function>(A1:C7, "Salary", A9:A11) equals 47242.</para>
- <para><function>DMAX</function>(A1:C7, "Age", A9:A11) equals 45.</para>
- <para><function>DMAX</function>(A1:C7, "Age", A9:B11) equals 43.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DMAX</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -2019,34 +1266,34 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DMIN</function> function returns the smallest number in a column that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DMIN</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DMIN</function>(A1:C7, "Salary", A9:B11) equals 34323.</para>
- <para><function>DMIN</function>(A1:C7, "Age", A9:B11) equals 29.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DMIN</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
- <para><link linkend="gnumeric-DMAX"><function>DMAX</function></link>.
+ <para><link linkend="gnumeric-DCOUNT"><function>DCOUNT</function></link>.
</para>
</refsect1>
</refentry>
@@ -2067,29 +1314,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DPRODUCT</function> function returns the product of numbers in a column that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DPRODUCT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DPRODUCT</function>(A1:C7, "Age", A9:B11) equals 1247.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DPRODUCT</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -2114,30 +1362,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DSTDEV</function> function returns the estimate of the standard deviation of a population based on a sample. The population consists of numbers that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DSTDEV</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DSTDEV</function>(A1:C7, "Age", A9:B11) equals 9.89949.</para>
- <para><function>DSTDEV</function>(A1:C7, "Salary", A9:B11) equals 9135.112506.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DSTDEV</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -2162,30 +1410,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DSTDEVP</function> function returns the standard deviation of a population based on the entire population. The population consists of numbers that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DSTDEVP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DSTDEVP</function>(A1:C7, "Age", A9:B11) equals 7.</para>
- <para><function>DSTDEVP</function>(A1:C7, "Salary", A9:B11) equals 6459.5.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DSTDEVP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -2210,30 +1458,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DSUM</function> function returns the sum of numbers in a column that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DSUM</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DSUM</function>(A1:C7, "Age", A9:B11) equals 72.</para>
- <para><function>DSUM</function>(A1:C7, "Salary", A9:B11) equals 81565.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DSUM</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -2258,30 +1506,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DVAR</function> function returns the estimate of variance of a population based on a sample. The population consists of numbers that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DVAR</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DVAR</function>(A1:C7, "Age", A9:B11) equals 98.</para>
- <para><function>DVAR</function>(A1:C7, "Salary", A9:B11) equals 83450280.5.</para>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DVAR</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <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>See also</title>
@@ -2306,30 +1554,30 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DVARP</function> function returns the variance of a population based on the entire population. The population consists of numbers that match conditions specified.</para>
- <para><parameter>database</parameter> is a range of cells 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>field</parameter> specifies which column is used in the function. If <parameter>field</parameter> is an integer, for example 2, the second column is used. Field can also be the label of a column. For example, ``Age'' refers to the column with the label ``Age'' in <parameter>database</parameter> range.</para>
- <para><parameter>criteria</parameter> is the range of cells which contains the specified conditions. The first row of a <parameter>criteria</parameter> should contain the labels of the fields for which the criteria are for. Cells below the labels specify conditions, for example, ``>3'' or ``<9''. Equality condition can be given simply by specifying a value, e.g. ``3'' or ``John''.</para>
- <para>Each row in <parameter>criteria</parameter> specifies a separate condition. If a row in <parameter>database</parameter> matches a row in <parameter>criteria</parameter>, then that row is counted. Technically speaking, this a boolean OR operation between the rows in <parameter>criteria</parameter>.</para>
- <para>If <parameter>criteria</parameter> specifies more than one column, then each of the conditions in the specified columns must be true for the row in <parameter>database</parameter> to match. Technically speaking, this is a boolean AND operation between the columns in <parameter>criteria</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>DVARP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>))</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><parameter>field</parameter> is a string or integer specifying whichfield is to be used. If <parameter>field</parameter> is an integer nthen the nth column will be used. If <parameter>field</parameter> is a string, then the column with the matching label will be used.</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>
+ <refsynopsisdiv>
+ <synopsis><function>DVARP</function>(<parameter>database</parameter>,<parameter>field</parameter>,<parameter>criteria</parameter>)))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the range A1:C7 contain the following values:</para>
- <para>Name Age Salary</para>
- <para>John 34 54342</para>
- <para>Bill 35 22343</para>
- <para>Clark 29 34323</para>
- <para>Bob 43 47242</para>
- <para>Susan 37 42932</para>
- <para>Jill 45 45324</para>
- <para>In addition, the cells A9:B11 contain the following values:</para>
- <para>Age Salary</para>
- <para><30</para>
- <para>>40 >46000</para>
- <para><function>DVARP</function>(A1:C7, "Age", A9:B11) equals 49.</para>
- <para><function>DVARP</function>(A1:C7, "Salary", A9:B11) equals 41725140.25.</para>
+ <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>
+ <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>See also</title>
@@ -2349,27 +1597,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GETPIVOTDATA</function>(<parameter>pivot_table</parameter>,<parameter>field_name</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GETPIVOTDATA</function> function fetches summary data from a pivot table. <parameter>pivot_table</parameter> is a cell range containing the pivot table. <parameter>field_name</parameter> is the name of the field of which you want the summary data.</para>
- <itemizedlist>
- <listitem>
- <para>If the summary data is unavailable, <function>GETPIVOTDATA</function> returns #REF! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
</sect1>
<sect1 id="CATEGORY_DateTime">
@@ -2387,35 +1614,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DATE</function> (<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
+ <synopsis><function>DATE</function>(<parameter>year</parameter>,<parameter>month</parameter>,<parameter>day</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DATE</function> returns the number of days since the 1st of January of 1900(the date serial number) for the given year, month and day.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>month</parameter> < 1 or <parameter>month</parameter> > 12, the year will be corrected. A similar correction takes place for days.</para>
- </listitem>
- <listitem>
- <para>The <parameter>years</parameter> should be at least 1900. If <parameter>years</parameter> < 1900, it is assumed to be 1900 + <parameter>years</parameter>.</para>
- </listitem>
- <listitem>
- <para>If the given date is not valid, <function>DATE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DATE</function>(2001, 3, 30) returns 'Mar 30, 2001'.</para>
+ <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>See also</title>
<para><link linkend="gnumeric-TODAY"><function>TODAY</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</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>
@@ -2432,23 +1645,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DATE2UNIX</function>(<parameter>serial</parameter>)</synopsis>
+ <synopsis><function>DATE2UNIX</function>(<parameter>d</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DATE2UNIX</function> converts a spreadsheet date and time serial number into a unix time.</para>
- <para>A unix time is the number of seconds since midnight January 1, 1970.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DATE2UNIX</function>("01/01/2000") equals 946656000.</para>
+ <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-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>,
- <link linkend="gnumeric-UNIX2DATE"><function>UNIX2DATE</function></link>.
+ <para><link linkend="gnumeric-UNIX2DATE"><function>UNIX2DATE</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -2465,30 +1672,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DATEDIF</function>(<parameter>date1</parameter>,<parameter>date2</parameter>,<parameter>interval</parameter>)</synopsis>
+ <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 difference between two dates. <parameter>interval</parameter> is one of six possible values: "y", "m", "d", "ym", "md", and "yd".</para>
- <para>The first three options will return the number of complete years, months, or days, respectively, between the two dates specified.</para>
- <para> "ym" will return the number of full months between the two dates, not including the difference in years.</para>
- <para> "md" will return the number of full days between the two dates, not including the difference in months.</para>
- <para> "yd" will return the number of full days between the two dates, not including the difference in years.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DATEDIF</function>(DATE(2000,4,30),DATE(2003,8,4),"d") equals 1191.</para>
- <para><function>DATEDIF</function>(DATE(2000,4,30),DATE(2003,8,4),"y") equals 3.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ <para><link linkend="gnumeric-DAYS360"><function>DAYS360</function></link>.
</para>
</refsect1>
</refentry>
@@ -2505,25 +1700,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DATEVALUE</function>(<parameter>date_str</parameter>)</synopsis>
+ <synopsis><function>DATEVALUE</function>(<parameter>serial</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DATEVALUE</function> returns the serial number of the date. <parameter>date_str</parameter> is the string that contains the date. The value depends on the date convention. The MS Excel 1900 convention dates things from Jan 1 1900 while the 1904 convention uses Jan 1 1904.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DATEVALUE</function>("1/1/1999") equals 36161 (in the 1900 convention).</para>
+ <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-DATE"><function>DATE</function></link>.
+ <para><link linkend="gnumeric-TIMEVALUE"><function>TIMEVALUE</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -2540,31 +1727,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DAY</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>DAY</function>(<parameter>date</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DAY</function> converts a serial number to a day of month.</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DAY</function>("10/24/1968") equals 24.</para>
+ <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-MONTH"><function>MONTH</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
+ <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>
@@ -2581,40 +1755,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DAYS360</function> (<parameter>date1</parameter>,<parameter>date2</parameter>,<parameter>method</parameter>)</synopsis>
+ <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>date1</parameter> to <parameter>date2</parameter> following a 360-day calendar in which all months are assumed to have 30 days.</para>
- <itemizedlist>
- <listitem>
- <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>
- </listitem>
- <listitem>
- <para>If <parameter>method</parameter> is 0 or omitted, 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 the first date.</para>
- </listitem>
- <listitem>
- <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>
- </listitem>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is mostly Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DAYS360</function>(DATE(2003, 2, 3), DATE(2007, 4, 2)) equals 1499.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
+ <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
</para>
</refsect1>
</refentry>
@@ -2635,20 +1787,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>EDATE</function> returns the serial number of the date that is the specified number of months before or after a given date. <parameter>date</parameter> is the serial number of the initial date and <parameter>months</parameter> is the number of months before (negative number) or after (positive number) the initial date.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>months</parameter> is not an integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EDATE</function>(DATE(2001,12,30),2) returns 'Feb 28, 2002'.</para>
+ <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>
@@ -2669,28 +1810,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>EOMONTH</function> (<parameter>start_date</parameter>,<parameter>months</parameter>)</synopsis>
+ <synopsis><function>EOMONTH</function>(<parameter>date</parameter>,<parameter>months</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>EOMONTH</function> returns the last day of the month which is <parameter>months</parameter> from the <parameter>start_date</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><function>EOMONTH</function> returns #NUM! if <parameter>start_date</parameter> or <parameter>months</parameter> are invalid.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>If A1 contains 12/21/00 then <function>EOMONTH</function>(A1,0)=12/31/00, <function>EOMONTH</function>(A1,5)=5/31/01, and <function>EOMONTH</function>(A1,2)=2/28/01</para>
+ <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-MONTH"><function>MONTH</function></link>.
+ <para><link linkend="gnumeric-EDATE"><function>EDATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -2707,30 +1837,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>HOUR</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>HOUR</function>(<parameter>time</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>HOUR</function> converts a serial number to an hour. The hour is returned as an integer in the range 0 (12:00 A.M.) to 23 (11:00 P.M.).</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HOUR</function>(0.128472) equals 3.</para>
+ <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-MINUTE"><function>MINUTE</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
+ <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>
@@ -2748,27 +1865,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ISOWEEKNUM</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>ISOWEEKNUM</function>(<parameter>date</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ISOWEEKNUM</function> returns the ISO 8601 week number of <parameter>date</parameter>.</para>
- <para>An ISO 8601 week starts on Monday. Weeks are numbered from 1. A week including days from two different years is assigned to the year which includes the most days. This means that Dec 31 could be in week 1 of the following year, and Jan 1 could be in week 52 or 53 of the previous year. <function>ISOWEEKNUM</function> returns the week number.</para>
- <itemizedlist>
- <listitem>
- <para><function>ISOWEEKNUM</function> returns #NUM! if date is invalid.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>If A1 contains 12/21/00 then <function>ISOWEEKNUM</function>(A1)=51</para>
+ <para><function>ISOWEEKNUM</function> calculates the week number according to the ISE 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>See also</title>
- <para><link linkend="gnumeric-WEEKNUM"><function>WEEKNUM</function></link>,
- <link linkend="gnumeric-ISOYEAR"><function>ISOYEAR</function></link>.
+ <para><link linkend="gnumeric-ISOYEAR"><function>ISOYEAR</function></link>,
+ <link linkend="gnumeric-WEEKNUM"><function>WEEKNUM</function></link>.
</para>
</refsect1>
</refentry>
@@ -2785,26 +1892,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ISOYEAR</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>ISOYEAR</function>(<parameter>date</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ISOYEAR</function> returns the year of the ISO 8601 week number of <parameter>date</parameter>.</para>
- <para>An ISO 8601 week starts on Monday. Weeks are numbered from 1. A week including days from two different years is assigned to the year which includes the most days. This means that Dec 31 could be in week 1 of the following year, and Jan 1 could be in week 52 or 53 of the previous year. <function>ISOYEAR</function> returns the year the week is assigned to.</para>
- <itemizedlist>
- <listitem>
- <para><function>ISOYEAR</function> returns #NUM! if date is invalid.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>If A1 contains 12/31/2001 then <function>ISOYEAR</function>(A1)=2002</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>.
+ <para><link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>,
+ <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
</para>
</refsect1>
</refentry>
@@ -2821,30 +1919,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MINUTE</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>MINUTE</function>(<parameter>time</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MINUTE</function> converts a serial number to a minute. The minute is returned as an integer in the range 0 to 59.</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>MINUTE</function>(0.128472) equals 5.</para>
+ <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-HOUR"><function>HOUR</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
+ <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>
@@ -2862,31 +1947,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MONTH</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>MONTH</function>(<parameter>date</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MONTH</function> converts a serial number to a month.</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>MONTH</function>(DATE(2003, 4, 30)) equals 4.</para>
+ <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-DAY"><function>DAY</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
+ <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>
@@ -2903,24 +1975,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>NETWORKDAYS</function> (<parameter>start_date</parameter>,<parameter>end_date</parameter>[,<parameter>holidays</parameter>])</synopsis>
+ <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> returns the number of non-weekend non-holidays between <parameter>start_date</parameter> and <parameter>end_date</parameter> including these dates. Holidays are optionally supplied in <parameter>holidays</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><function>NETWORKDAYS</function> returns #NUM! if <parameter>start_date</parameter> or <parameter>end_date</parameter> are invalid.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NETWORKDAYS</function>(DATE(2001,1,2),DATE(2001,2,15)) equals 33.</para>
+ <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>
@@ -2941,27 +2003,15 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>NOW</function> (<parameter/>)</synopsis>
+ <synopsis><function>NOW</function>(<parameter/>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>NOW</function> returns the serial number for the date and time at the time it is evaluated.</para>
- <para>Serial Numbers in Gnumeric are represented as follows: The integral part is the number of days since the 1st of January of 1900. The decimal part represent the fraction of the day and is mapped into hour, minutes and seconds.</para>
- <para>For example: .0 represents the beginning of the day, and 0.5 represents noon.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NOW</function>().</para>
+ <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-TODAY"><function>TODAY</function></link>.
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -2978,31 +2028,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SECOND</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>SECOND</function>(<parameter>time</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SECOND</function> converts a serial number to a second. The second is returned as an integer in the range 0 to 59.</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SECOND</function>(0.600613) equals 53.</para>
+ <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-HOUR"><function>HOUR</function></link>,
- <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>.
+ <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>
@@ -3019,25 +2056,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>TIME</function> (<parameter>hours</parameter>,<parameter>minutes</parameter>,<parameter>seconds</parameter>)</synopsis>
+ <synopsis><function>TIME</function>(<parameter>hour</parameter>,<parameter>minute</parameter>,<parameter>second</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TIME</function> returns a fraction representing the time of day.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TIME</function>(3, 5, 23) equals 3:05AM.</para>
+ <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>.
+ <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>
@@ -3054,27 +2086,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>TIMEVALUE</function> (<parameter>timetext</parameter>)</synopsis>
+ <synopsis><function>TIMEVALUE</function>(<parameter>serial</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TIMEVALUE</function> returns a fraction representing the time of day, a number between 0 and 1.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TIMEVALUE</function>("3:05") equals 0.128472.</para>
- <para><function>TIMEVALUE</function>("2:24:53 PM") equals 0.600613.</para>
+ <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-HOUR"><function>HOUR</function></link>,
- <link linkend="gnumeric-MINUTE"><function>MINUTE</function></link>.
+ <para><link linkend="gnumeric-DATEVALUE"><function>DATEVALUE</function></link>,
+ <link linkend="gnumeric-TIME"><function>TIME</function></link>.
</para>
</refsect1>
</refentry>
@@ -3095,21 +2117,11 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TODAY</function> returns the serial number for today (the number of days elapsed since the 1st of January of 1900).</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TODAY</function>() returns 'Nov 6, 2001' on that particular day.</para>
+ <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-NOW"><function>NOW</function></link>.
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -3126,22 +2138,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>UNIX2DATE</function>(<parameter>unixtime</parameter>)</synopsis>
+ <synopsis><function>UNIX2DATE</function>(<parameter>t</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>UNIX2DATE</function> converts a unix time into a spreadsheet date and time.</para>
- <para>A unix time is the number of seconds since midnight January 1, 1970.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>,
- <link linkend="gnumeric-DATE2UNIX"><function>DATE2UNIX</function></link>.
+ <para><link linkend="gnumeric-DATE2UNIX"><function>DATE2UNIX</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -3158,37 +2165,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>WEEKDAY</function> (<parameter>date</parameter>[,<parameter/> method])</synopsis>
+ <synopsis><function>WEEKDAY</function>(<parameter>date</parameter>,<parameter>method</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>WEEKDAY</function> converts a serial number to a weekday.</para>
- <para>This function returns an integer indicating the day of week.</para>
- <para><parameter>METHOD</parameter> indicates the numbering system. It defaults to 1.</para>
- <para> For <parameter>METHOD</parameter>=1: Sunday is 1, Monday is 2, etc.</para>
- <para> For <parameter>METHOD</parameter>=2: Monday is 1, Tuesday is 2, etc.</para>
- <para> For <parameter>METHOD</parameter>=3: Monday is 0, Tuesday is 1, etc.</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>WEEKDAY</function>("10/24/1968") equals 5 (Thursday).</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-DAY"><function>DAY</function></link>,
- <link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>,
- <link linkend="gnumeric-YEAR"><function>YEAR</function></link>.
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
+ <link linkend="gnumeric-ISOWEEKNUM"><function>ISOWEEKNUM</function></link>.
</para>
</refsect1>
</refentry>
@@ -3205,28 +2193,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>WEEKNUM</function> (<parameter>date</parameter>[,<parameter>method</parameter>])</synopsis>
+ <synopsis><function>WEEKNUM</function>(<parameter>date</parameter>,<parameter>method</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>WEEKNUM</function> returns the week number of <parameter>date</parameter> according to the given <parameter>method</parameter>.</para>
- <para><parameter>method</parameter> defaults to 1.</para>
- <para> For <parameter>method</parameter>=1, week starts on Sunday, and days before first Sunday are in week 0.</para>
- <para> For <parameter>method</parameter>=2, week starts on Monday, and days before first Monday are in week 0.</para>
- <para> For <parameter>method</parameter>=150, the ISO 8601 week number is returned.</para>
- <itemizedlist>
- <listitem>
- <para><function>WEEKNUM</function> returns #NUM! if <parameter>date</parameter> or <parameter>method</parameter> is invalid.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible, except that Excel does not support ISO 8601 week numbers.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>If A1 contains 12/21/00 then <function>WEEKNUM</function>(A1,2)=51</para>
+ <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>See also</title>
@@ -3247,25 +2220,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>WORKDAY</function> (<parameter>start_date</parameter>,<parameter>days</parameter>[,<parameter>holidays</parameter>])</synopsis>
+ <synopsis><function>WORKDAY</function>(<parameter>date</parameter>,<parameter>days</parameter>,<parameter>holidays</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>WORKDAY</function> returns the date which is <parameter>days</parameter> working days from the <parameter>start_date</parameter>. Weekends and holidays optionally supplied in <parameter>holidays</parameter> are respected.</para>
- <itemizedlist>
- <listitem>
- <para><function>WORKDAY</function> returns #NUM! if <parameter>start_date</parameter> or <parameter>days</parameter> are invalid.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>DAY(<function>WORKDAY</function>(DATE(2001,1,5),30)) equals 16 and</para>
- <para>MONTH(<function>WORKDAY</function>(DATE(2001,1,5),30)) equals 2.</para>
+ <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>See also</title>
@@ -3286,31 +2248,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>YEAR</function> (<parameter>date</parameter>)</synopsis>
+ <synopsis><function>YEAR</function>(<parameter>date</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>YEAR</function> converts a serial number to a year.</para>
- <itemizedlist>
- <listitem>
- <para>Note that Gnumeric will perform regular string to serial number conversion for you, so you can enter a date as a string.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>YEAR</function>(DATE(2003, 4, 30)) equals 2003.</para>
+ <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-DAY"><function>DAY</function></link>,
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>,
<link linkend="gnumeric-MONTH"><function>MONTH</function></link>,
- <link linkend="gnumeric-TIME"><function>TIME</function></link>,
- <link linkend="gnumeric-NOW"><function>NOW</function></link>.
+ <link linkend="gnumeric-DAY"><function>DAY</function></link>.
</para>
</refsect1>
</refentry>
@@ -3327,19 +2276,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>YEARFRAC</function> (<parameter>start_date</parameter>,<parameter/> end_date [,<parameter>basis</parameter>])</synopsis>
+ <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> returns the number of full days between <parameter>start_date</parameter> and <parameter>end_date</parameter> according to the <parameter>basis</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
+ <para><link linkend="gnumeric-DATE"><function>DATE</function></link>.
</para>
</refsect1>
</refentry>
@@ -3359,27 +2307,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BASE</function>(<parameter>number</parameter>,<parameter>base</parameter>[,<parameter>length</parameter>])</synopsis>
+ <synopsis><function>BASE</function>(<parameter>n</parameter>,<parameter>b</parameter>,<parameter>length</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BASE</function> function converts a number to a string representing that number in base <parameter>base</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>base</parameter> must be an integer between 2 and 36.</para>
- </listitem>
- <listitem>
- <para>This function is OpenOffice.Org compatible.</para>
- </listitem>
- <listitem>
- <para>Optional argument <parameter>length</parameter> specifies the minimum result length. Leading zeroes will be added to reach this length.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BASE</function>(255,16,4) equals "00FF".</para>
+ <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 resutling string</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -3399,30 +2334,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>BESSELI</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BESSELI</function> function returns the Neumann, Weber or Bessel function.</para>
- <para><parameter>x</parameter> is where the function is evaluated. <parameter>y</parameter> is the order of the Bessel function.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> or <parameter>y</parameter> are not numeric a #VALUE! error is returned.</para>
- </listitem>
- <listitem>
- <para>If <parameter>y</parameter> < 0 a #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function extends the Excel function of the same name to non-integer orders.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BESSELI</function>(0.7,3) equals 0.007367374.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BESSELJ"><function>BESSELJ</function></link>,
@@ -3443,29 +2354,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>BESSELJ</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BESSELJ</function> function returns the Bessel function with <parameter>x</parameter> is where the function is evaluated. <parameter>y</parameter> is the order of the Bessel function, if non-integer it is truncated.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> or <parameter>y</parameter> are not numeric a #VALUE! error is returned.</para>
- </listitem>
- <listitem>
- <para>If <parameter>y</parameter> < 0 a #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BESSELJ</function>(0.89,3) equals 0.013974004.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
@@ -3486,29 +2374,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>BESSELK</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BESSELK</function> function returns the Neumann, Weber or Bessel function. <parameter>x</parameter> is where the function is evaluated. <parameter>y</parameter> is the order of the Bessel function.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> or <parameter>y</parameter> are not numeric a #VALUE! error is returned.</para>
- </listitem>
- <listitem>
- <para>If <parameter>y</parameter> < 0 a #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function extends the Excel function of the same name to non-integer orders.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BESSELK</function>(3,9) equals 397.95880.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
@@ -3529,30 +2394,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>BESSELY</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BESSELY</function> function returns the Neumann, Weber or Bessel function.</para>
- <para><parameter>x</parameter> is where the function is evaluated. <parameter>y</parameter> is the order of the Bessel function, if non-integer it is truncated.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> or <parameter>y</parameter> are not numeric a #VALUE! error is returned.</para>
- </listitem>
- <listitem>
- <para>If <parameter>y</parameter> < 0 a #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BESSELY</function>(4,2) equals 0.215903595.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BESSELI"><function>BESSELI</function></link>,
@@ -3573,23 +2414,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>BIN2DEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BIN2DEC</function> function converts a binary number in string or number to its decimal equivalent.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BIN2DEC</function>(101) equals 5.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-DEC2BIN"><function>DEC2BIN</function></link>,
@@ -3611,24 +2435,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BIN2HEX</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>BIN2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BIN2HEX</function> function converts a binary number to a hexadecimal number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BIN2HEX</function>(100111) equals 27.</para>
+ <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>
@@ -3651,24 +2464,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BIN2OCT</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>BIN2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>BIN2OCT</function> function converts a binary number to an octal number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BIN2OCT</function>(110111) equals 67.</para>
+ <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>
@@ -3691,111 +2493,114 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>CONVERT</function>(<parameter>number</parameter>,<parameter>from_unit</parameter>,<parameter>to_unit</parameter>)</synopsis>
+ <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. For example, you can convert a weight in pounds to a weight in grams. <parameter>number</parameter> is the value you want to convert, <parameter>from_unit</parameter> specifies the unit of the <parameter>number</parameter>, and <parameter>to_unit</parameter> is the unit for the result.</para>
- <para><parameter>from_unit</parameter> and <parameter>to_unit</parameter> can be any of the following:</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>CONVERT</function>(<parameter>x</parameter>,<parameter>from</parameter>,<parameter>to</parameter>))</synopsis>
+ </refsynopsisdiv>
+ <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> 'g' Gram</para>
+ <para> 'sg' Slug</para>
<para> 'lbm' Pound</para>
- <para> 'u' U (atomic mass)</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> '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> 'yr' Year</para>
<para> 'day' Day</para>
- <para> 'hr' Hour</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> 'mmHg' mm of Mercury</para>
+ <para/>
<para>Force:</para>
- <para> 'N' Newton</para>
+ <para> 'N' Newton</para>
<para> 'dyn' Dyne</para>
- <para> 'lbf' Pound force</para>
+ <para> 'lbf' Pound force</para>
+ <para/>
<para>Energy:</para>
- <para> 'J' Joule</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> 'eV' Electron volt</para>
+ <para> 'HPh' Horsepower-hour</para>
+ <para> 'Wh' Watt-hour</para>
<para> 'flb' Foot-pound</para>
- <para> 'BTU' BTU</para>
+ <para> 'BTU' BTU</para>
+ <para/>
<para>Power:</para>
- <para> 'HP' Horsepower</para>
- <para> 'W' Watt</para>
+ <para> 'HP' Horsepower</para>
+ <para> 'W' Watt</para>
+ <para/>
<para>Magnetism:</para>
<para> 'T' Tesla</para>
- <para> 'ga' Gauss</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> 'cup' Cup</para>
<para> 'pt' Pint</para>
<para> 'qt' Quart</para>
<para> 'gal' Gallon</para>
- <para> 'l' Liter</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> '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> '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' deka 1E+01</para>
- <para> 'd' deci 1E-01</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> '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>
- <itemizedlist>
- <listitem>
- <para>If <parameter>from_unit</parameter> and <parameter>to_unit</parameter> are different types, <function>CONVERT</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CONVERT</function>(3,"lbm","g") equals 1360.7769.</para>
- <para><function>CONVERT</function>(5.8,"m","in") equals 228.3465.</para>
- <para><function>CONVERT</function>(7.9,"cal","J") equals 33.07567.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <para><parameter>x</parameter>: number</para>
+ <para><parameter>from</parameter>: unit (string)</para>
+ <para><parameter>to</parameter>: unit (string)</para>
</refsect1>
</refentry>
<refentry id="gnumeric-DEC2BIN">
@@ -3811,24 +2616,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DEC2BIN</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>DEC2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DEC2BIN</function> function converts a decimal number to a binary number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DEC2BIN</function>(42) equals 101010.</para>
+ <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>
@@ -3851,24 +2645,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DEC2HEX</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>DEC2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DEC2HEX</function> function converts a decimal number to a hexadecimal number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DEC2HEX</function>(42) equals 2A.</para>
+ <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>
@@ -3891,24 +2674,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DEC2OCT</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>DEC2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DEC2OCT</function> function converts a decimal number to an octal number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DEC2OCT</function>(42) equals 52.</para>
+ <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>
@@ -3930,26 +2702,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>DECIMAL</function>(<parameter>text</parameter>,<parameter>base</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DECIMAL</function> function converts a number in base <parameter>base</parameter> to decimal.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>base</parameter> must be an integer between 2 and 36.</para>
- </listitem>
- <listitem>
- <para>This function is OpenOffice.Org compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DECIMAL</function>("A1",16) equals 161.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BASE"><function>BASE</function></link>.
@@ -3969,27 +2721,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DELTA</function>(<parameter>x</parameter>[,<parameter>y</parameter>])</synopsis>
+ <synopsis><function>DELTA</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DELTA</function> function tests for numerical equivalence of two arguments, returning 1 in case of equality.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>y</parameter> is optional, and defaults to 0.</para>
- </listitem>
- <listitem>
- <para>If either argument is non-numeric returns a #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DELTA</function>(42.99,43) equals 0.</para>
+ <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>See also</title>
@@ -4011,28 +2749,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ERF</function>(<parameter/>[lower limit,<parameter/>]upper_limit)</synopsis>
+ <synopsis><function>ERF</function>(<parameter>lower</parameter>,<parameter>upper</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ERF</function> returns the error function. With a single argument <function>ERF</function> returns the error function, defined as</para>
- <para> erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(-t*t) dt.</para>
- <para>If two arguments are supplied, they are the lower and upper limits of the integral.</para>
- <itemizedlist>
- <listitem>
- <para>If either <parameter>lower_limit</parameter> or <parameter>upper_limit</parameter> is not numeric a #VALUE! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is upward-compatible with that in Excel. (If two arguments are supplied, Excel will not allow either to be negative.)</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ERF</function>(0.4) equals 0.428392355.</para>
- <para><function>ERF</function>(1.6448536269515/SQRT(2)) equals 0.90.</para>
- <para>The second example shows that a random variable with a normal distribution has a 90 percent chance of falling within approximately 1.645 standard deviations of the mean.</para>
+ <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>
@@ -4057,19 +2780,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ERFC</function> function returns the complementary error function, defined as</para>
- <para> 1 - erf(x).</para>
- <para>erfc(x) is calculated more accurately than 1 - erf(x) for arguments larger than about 0.5.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is not numeric a #VALUE! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ERFC</function>(6) equals 2.15197367e-17.</para>
+ <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>
@@ -4090,24 +2802,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>GESTEP</function>(<parameter>x</parameter>[,<parameter>y</parameter>])</synopsis>
+ <synopsis><function>GESTEP</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>GESTEP</function> function tests if <parameter>x</parameter> is >= <parameter>y</parameter>, returning 1 if it is so, and 0 otherwise. <parameter>y</parameter> is optional, and defaults to 0.</para>
- <itemizedlist>
- <listitem>
- <para>If either argument is non-numeric returns a #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>GESTEP</function>(5,4) equals 1.</para>
+ <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>See also</title>
@@ -4128,24 +2829,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>HEX2BIN</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>HEX2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>HEX2BIN</function> function converts a hexadecimal number to a binary number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HEX2BIN</function>("2A") equals 101010.</para>
+ <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>
@@ -4167,23 +2857,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>HEX2DEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>HEX2DEC</function> function converts a hexadecimal number to its decimal equivalent.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HEX2DEC</function>("2A") equals 42.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-DEC2HEX"><function>DEC2HEX</function></link>,
@@ -4205,24 +2878,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>HEX2OCT</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>HEX2OCT</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>HEX2OCT</function> function converts a hexadecimal number to an octal number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HEX2OCT</function>("2A") equals 52.</para>
+ <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>
@@ -4245,25 +2907,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>INVSUMINV</function>(<parameter>x1</parameter>,<parameter>x2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>INVSUMINV</function>(<parameter>x0</parameter>,<parameter>x1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>INVSUMINV</function> sum calculates the inverse of the sum of inverses.</para>
- <para>The primary use of this is for calculating equivalent resistance for parallel resistors or equivalent capacitance of a series of capacitors.</para>
- <itemizedlist>
- <listitem>
- <para>All arguments must be non-negative, or else a #VALUE! result is returned.</para>
- </listitem>
- <listitem>
- <para>If any argument is zero, the result is zero.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>INVSUMINV</function>(2000,2000) equals 1000.</para>
+ <para><function>INVSUMINV</function> sum calculates the reciprocal (the inverse) of the sum of reciprovals (inverses) of all its arguments.</para>
+ <para><parameter>x0</parameter>: non-negative number</para>
+ <para><parameter>x1</parameter>: non-negative number</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -4284,24 +2934,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>OCT2BIN</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>OCT2BIN</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OCT2BIN</function> function converts an octal number to a binary number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>OCT2BIN</function>("213") equals 10001011.</para>
+ <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>
@@ -4323,23 +2962,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>OCT2DEC</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OCT2DEC</function> function converts an octal number in a string or number to its decimal equivalent.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>OCT2DEC</function>("124") equals 84.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-DEC2OCT"><function>DEC2OCT</function></link>,
@@ -4361,24 +2983,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>OCT2HEX</function>(<parameter>number</parameter>[,<parameter>places</parameter>])</synopsis>
+ <synopsis><function>OCT2HEX</function>(<parameter>x</parameter>,<parameter>places</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OCT2HEX</function> function converts an octal number to a hexadecimal number. <parameter>places</parameter> is an optional field, specifying to zero pad to that number of spaces.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>places</parameter> is too small or negative #NUM! error is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>OCT2HEX</function>(132) equals 5A.</para>
+ <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>
@@ -4408,12 +3019,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DIMCIRC</function> returns a number of circuits required from a number of <parameter>traffic</parameter> loads with <parameter>gos</parameter> grade of service.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DIMCIRC</function>(24,1%) returns 35.</para>
+ <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>
@@ -4440,12 +3048,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OFFCAP</function> returns a number of traffic capacity given by a number of <parameter>circuits</parameter> with <parameter>gos</parameter> grade of service.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>OFFCAP</function>(30,1%) returns 20.337.</para>
+ <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>
@@ -4472,17 +3077,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OFFTRAF</function> returns a predicted number of offered traffic from a number of carried <parameter>traffic</parameter> (taken from measurements) on a number of <parameter>circuits</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>traffic</parameter> cannot exceed <parameter>circuits</parameter></para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>OFFTRAF</function>(24,30) returns 25.527.</para>
+ <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>See also</title>
@@ -4509,17 +3106,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>PROBBLOCK</function> returns probability of blocking when a number of <parameter>traffic</parameter> loads into a number of <parameter>circuits</parameter> (servers).</para>
- <itemizedlist>
- <listitem>
- <para><parameter>traffic</parameter> cannot exceed <parameter>circuits</parameter></para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>PROBBLOCK</function>(24,30) returns 0.4012.</para>
+ <para><function>PROBBLOCK</function> returns probability of blocking when <parameter>traffic</parameter> calls load into <parameter>ccicuits</parameter> circuits.</para>
+ <para><parameter>traffic</parameter>: number of calls</para>
+ <para><parameter>circuits</parameter>: number of circuits</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -4545,46 +3134,18 @@
<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>
+ <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> is the issue date of the security. <parameter>first_interest</parameter> is the first interest date of the security. <parameter>settlement</parameter> is the settlement date of the security. The settlement date is always after the issue date (the date when the security is bought). <parameter>rate</parameter> is the annual rate of the security and <parameter>par</parameter> is the par value of the security. <parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para>Allowed frequencies are:</para>
- <para> 1 = annual,</para>
- <para> 2 = semi,</para>
- <para> 4 = quarterly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>issue</parameter> date, <parameter>first_interest</parameter> date, or <parameter>settlement</parameter> date is not valid, <function>ACCRINT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>The dates must be <parameter>issue</parameter> < <parameter>first_interest</parameter> < <parameter>settlement</parameter>, or <function>ACCRINT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>rate</parameter> <= 0 or <parameter>par</parameter> <= 0 , <function>ACCRINT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>ACCRINT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>issue</parameter> date is after <parameter>settlement</parameter> date or they are the same, <function>ACCRINT</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>See also</title>
@@ -4605,38 +3166,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ACCRINTM</function>(<parameter>issue</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>[,<parameter>par</parameter>,<parameter>basis</parameter>])</synopsis>
+ <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><function>ACCRINTM</function> calculates and returns the accrued interest for a security from <parameter>issue</parameter> to <parameter>maturity</parameter> date.</para>
- <para><parameter>issue</parameter> is the issue date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>rate</parameter> is the annual rate of the security and <parameter>par</parameter> is the par value of the security. If you omit <parameter>par</parameter>, <function>ACCRINTM</function> applies $1,000 instead. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>issue</parameter> date or <parameter>maturity</parameter> date is not valid, <function>ACCRINTM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>rate</parameter> <= 0 or <parameter>par</parameter> <= 0, <function>ACCRINTM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>ACCRINTM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>issue</parameter> date is after <parameter>maturity</parameter> date or they are the same, <function>ACCRINTM</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -4657,37 +3196,18 @@
<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>
+ <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 depreciation for each accounting period 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>Named for AMORtissement DEGRessif Comptabilite</para>
- <para><parameter>cost</parameter> The value of the asset.</para>
- <para><parameter>purchase_date</parameter> The date the asset was purchased.</para>
- <para><parameter>first_period</parameter> The end of the first period.</para>
- <para><parameter>salvage</parameter> Asset value at maturity.</para>
- <para><parameter>period</parameter> The length of accounting periods.</para>
- <para><parameter>rate</parameter> rate of depreciation as a percentage.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>AMORDEGRC</function>(2400,DATE(1998,8,19),DATE(1998,12,30),300,1,0.14,1) = 733</para>
+ <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>See also</title>
@@ -4708,37 +3228,18 @@
<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>
+ <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 depreciation for each accounting period using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account.</para>
- <para>Named for AMORtissement LINeaire Comptabilite.</para>
- <para><parameter>cost</parameter> The value of the asset.</para>
- <para><parameter>purchase_date</parameter> The date the asset was purchased.</para>
- <para><parameter>first_period</parameter> The end of the first period.</para>
- <para><parameter>salvage</parameter> Asset value at maturity.</para>
- <para><parameter>period</parameter> The length of accounting periods.</para>
- <para><parameter>rate</parameter> rate of depreciation as a percentage.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>AMORLINC</function>(2400,DATE(1998,8,19),DATE(1998,12,31),300,1,0.15,1) = 360</para>
+ <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>See also</title>
@@ -4746,41 +3247,6 @@
</para>
</refsect1>
</refentry>
- <refentry id="gnumeric-atl_last">
- <refmeta>
- <refentrytitle>
- <function>atl_last</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>atl_last</function>
- </refname>
- <refpurpose/>
- </refnamediv>
- <refsynopsisdiv>
- <synopsis>ATL_LAST (<parameter>tag</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>ATL_LAST is a sample implemention of a real time data source. It takes a string tag and monitors the named pipe /tmp/atl for changes to the value of that tag.</para>
- <itemizedlist>
- <listitem>
- <para>This is not intended to be generally enabled and is OFF by default.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>ATL_LAST("IBM")</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
- </refentry>
<refentry id="gnumeric-COUPDAYBS">
<refmeta>
<refentrytitle>
@@ -4794,45 +3260,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COUPDAYBS</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>,<parameter>eom</parameter>])</synopsis>
+ <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> returns the number of days from the beginning of the coupon period to the settlement date.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para><parameter>eom</parameter> = TRUE handles end of month maturity dates special.</para>
- <para>Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly, 6 = bimonthly, 12 = monthly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <para>(See the gnumeric manual for a detailed description of these bases).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is invalid, <function>COUPDAYBS</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is invalid, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUPDAYBS</function> (DATE(2002,11,29),DATE(2004,2,29),4,0) = 89</para>
- <para><function>COUPDAYBS</function> (DATE(2002,11,29),DATE(2004,2,29),4,0,FALSE) = 0</para>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>.
</para>
</refsect1>
</refentry>
@@ -4849,46 +3290,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COUPDAYS</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>,<parameter>eom</parameter>])</synopsis>
+ <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> returns the number of days in the coupon period of the settlement date.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para><parameter>eom</parameter> = TRUE handles end of month maturity dates special.</para>
- <para>Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly, 6 = bimonthly, 12 = monthly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <para>(See the gnumeric manual for a detailed description of these bases).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is invalid, <function>COUPDAYS</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is invalid, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUPDAYS</function> (DATE(2002,11,29),DATE(2004,2,29),4,0) = 90</para>
- <para><function>COUPDAYS</function> (DATE(2002,11,29),DATE(2004,2,29),4,0,FALSE) = 90</para>
- <para><function>COUPDAYS</function> (DATE(2002,11,29),DATE(2004,2,29),4,1,FALSE) = 91</para>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>,
+ <link linkend="gnumeric-COUPDAYSNC"><function>COUPDAYSNC</function></link>.
</para>
</refsect1>
</refentry>
@@ -4905,45 +3321,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COUPDAYSNC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>,<parameter>eom</parameter>])</synopsis>
+ <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> returns the number of days from the settlement date to the next coupon date.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para><parameter>eom</parameter> = TRUE handles end of month maturity dates special.</para>
- <para>Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly, 6 = bimonthly, 12 = monthly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <para>(See the gnumeric manual for a detailed description of these bases).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is invalid, <function>COUPDAYSNC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is invalid, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUPDAYSNC</function> (DATE(2002,11,29),DATE(2004,2,29),4,0) = 1</para>
- <para><function>COUPDAYSNC</function> (DATE(2002,11,29),DATE(2004,2,29),4,0,FALSE) = 89</para>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-COUPDAYS"><function>COUPDAYS</function></link>,
+ <link linkend="gnumeric-COUPDAYBS"><function>COUPDAYBS</function></link>.
</para>
</refsect1>
</refentry>
@@ -4960,45 +3352,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COUPNCD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>,<parameter>eom</parameter>])</synopsis>
+ <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> returns the coupon date following settlement.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para><parameter>eom</parameter> = TRUE handles end of month maturity dates special.</para>
- <para>Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly, 6 = bimonthly, 12 = monthly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <para>(See the gnumeric manual for a detailed description of these bases).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is invalid, <function>COUPNCD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is invalid, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUPNCD</function> (DATE(2002,11,29),DATE(2004,2,29),4,0) = 30-Nov-2002</para>
- <para><function>COUPNCD</function> (DATE(2002,11,29),DATE(2004,2,29),4,0,FALSE) = 28-Feb-2003</para>
+ <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>See also</title>
- <para>
+ <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>
@@ -5015,44 +3384,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COUPNUM</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>,<parameter>eom</parameter>])</synopsis>
+ <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> returns the numbers of coupons to be paid between the settlement and maturity dates, rounded up.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para><parameter>eom</parameter> = TRUE handles end of month maturity dates special.</para>
- <para>Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. 6 = bimonthly, 12 = monthly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, 4, 6 or 12, <function>COUPNUM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 5, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUPNUM</function> (DATE(2002,11,29),DATE(2004,2,29),4,0) = 6</para>
- <para><function>COUPNUM</function> (DATE(2002,11,29),DATE(2004,2,29),4,0,FALSE) = 5</para>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-COUPNCD"><function>COUPNCD</function></link>,
+ <link linkend="gnumeric-COUPPCD"><function>COUPPCD</function></link>.
</para>
</refsect1>
</refentry>
@@ -5069,45 +3415,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COUPPCD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>,<parameter>eom</parameter>])</synopsis>
+ <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> returns the coupon date preceding settlement.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year.</para>
- <para><parameter>eom</parameter> = TRUE handles end of month maturity dates special.</para>
- <para>Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly, 6 = bimonthly, 12 = monthly.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <para>(See the gnumeric manual for a detailed description of these bases).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is invalid, <function>COUPPCD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is invalid, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUPPCD</function> (DATE(2002,11,29),DATE(2004,2,29),4,0) = 31-Aug-2002</para>
- <para><function>COUPPCD</function> (DATE(2002,11,29),DATE(2004,2,29),4,0,FALSE) = 29-Nov-2002</para>
+ <para><function>COUPPCD</function> calculates the coupon date preceeding 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>See also</title>
- <para>
+ <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>
@@ -5128,19 +3451,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CUM_BIV_NORM_DIST</function> calculates the cumulative bivariate normal distribution from parameters a, b & rho.</para>
- <para>The return value is the probability that two random variables with correlation <parameter>rho</parameter> are respectively each less than <parameter>a</parameter> and <parameter>b</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>.
- </para>
+ <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">
@@ -5160,38 +3474,17 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CUMIPMT</function> returns the cumulative interest paid on a loan between <parameter>start_period</parameter> and <parameter>end_period</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>rate</parameter> <= 0, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>nper</parameter> <= 0, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>pv</parameter> <= 0, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>start_period</parameter> < 1, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>end_period</parameter> < <parameter>start_period</parameter>, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>end_period</parameter> > <parameter>nper</parameter>, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> <> 0 and <parameter>type</parameter> <> 1, <function>CUMIPMT</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>.
</para>
</refsect1>
</refentry>
@@ -5212,38 +3505,17 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CUMPRINC</function> returns the cumulative principal paid on a loan between <parameter>start_period</parameter> and <parameter>end_period</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>rate</parameter> <= 0, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>nper</parameter> <= 0, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>pv</parameter> <= 0, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>start_period</parameter> < 1, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>end_period</parameter> < <parameter>start_period</parameter>, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>end_period</parameter> > <parameter>nper</parameter>, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> <> 0 and <parameter>type</parameter> <> 1, <function>CUMPRINC</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
</para>
</refsect1>
</refentry>
@@ -5260,30 +3532,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>[,<parameter>month</parameter>])</synopsis>
+ <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. <parameter>cost</parameter> is the initial value of the asset. <parameter>salvage</parameter> is the value after the depreciation.</para>
- <para><parameter>life</parameter> is the number of periods overall. <parameter>period</parameter> is the period for which you want the depreciation to be calculated. <parameter>month</parameter> is the number of months in the first year of depreciation.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>month</parameter> is omitted, it is assumed to be 12.</para>
- </listitem>
- <listitem>
- <para>If <parameter>cost</parameter> = 0, <function>DB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>life</parameter> <= 0, <function>DB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>salvage</parameter> / <parameter>cost</parameter> < 0, <function>DB</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -5306,28 +3564,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DDB</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>,<parameter>period</parameter>[,<parameter>factor</parameter>])</synopsis>
+ <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> returns the depreciation of an asset for a given period using the double-declining balance method or some other similar method you specify.</para>
- <para><parameter>cost</parameter> is the initial value of the asset, <parameter>salvage</parameter> is the value after the last period, <parameter>life</parameter> is the number of periods, <parameter>period</parameter> is the period for which you want the depreciation to be calculated, and <parameter>factor</parameter> is the factor at which the balance declines.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>factor</parameter> is omitted, it is assumed to be two (double-declining balance method).</para>
- </listitem>
- <listitem>
- <para>If <parameter>life</parameter> <= 0, <function>DDB</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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-SLN"><function>SLN</function></link>,
+ <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>
@@ -5345,40 +3596,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>par</parameter>,<parameter>redemption</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 and returns the discount rate for a security. <parameter>settlement</parameter> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security. <parameter>par</parameter> is the price per $100 face value of the security. <parameter>redemption</parameter> is the redemption value per $100 face value of the security.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> date or <parameter>maturity</parameter> date is not valid, <function>DISC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>DISC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>settlement</parameter> date is after <parameter>maturity</parameter> date or they are the same, <function>DISC</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-PRICEMAT"><function>PRICEMAT</function></link>.
</para>
</refsect1>
</refentry>
@@ -5399,20 +3630,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DOLLARDE</function> converts a dollar price expressed as a fraction into a dollar price expressed as a decimal number.</para>
- <para><parameter>fractional_dollar</parameter> is the fractional number to be converted. <parameter>fraction</parameter> is the denominator of the fraction.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>fraction</parameter> is non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>fraction</parameter> <= 0, <function>DOLLARDE</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -5437,19 +3657,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DOLLARFR</function> converts a decimal dollar price into a dollar price expressed as a fraction.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>fraction</parameter> is non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>fraction</parameter> <= 0, <function>DOLLARFR</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -5470,41 +3680,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DURATION</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>coup</parameter>,<parameter>yield</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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> is the settlement date of the security.</para>
- <para><parameter>maturity</parameter> is the maturity date of the security.</para>
- <para><parameter>coup</parameter> The annual coupon rate as a percentage.</para>
- <para><parameter>yield</parameter> The annualized yield of the security as a percentage.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>DURATION</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>See also</title>
- <para><link linkend="gnumeric-G_DURATION"><function>G_DURATION</function></link>,
- <link linkend="gnumeric-MDURATION"><function>MDURATION</function></link>.
+ <para><link linkend="gnumeric-MDURATION"><function>MDURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -5521,31 +3711,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>EFFECT</function>(<parameter>r</parameter>,<parameter>nper</parameter>)</synopsis>
+ <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 from a given nominal rate.</para>
- <para>Effective interest rate is calculated using this formula:</para>
- <para> (1 + <parameter>r</parameter> / <parameter>nper</parameter>) ^ <parameter>nper</parameter> - 1</para>
- <para>where:</para>
- <para><parameter>r</parameter> = nominal interest rate (stated in yearly terms)</para>
- <para><parameter>nper</parameter> = number of periods used for compounding</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>rate</parameter> < 0, <function>EFFECT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>nper</parameter> <= 0, <function>EFFECT</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>For example credit cards will list an APR (annual percentage rate) which is a nominal interest rate.</para>
- <para>For example if you wanted to find out how much you are actually paying interest on your credit card that states an APR of 19% that is compounded monthly you would type in:</para>
- <para>=<function>EFFECT</function>(.19,12) and you would get .2075 or 20.75%. That is the effective percentage you will pay on your loan.</para>
+ <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>
@@ -5570,35 +3742,12 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>EURO</function> converts one Euro to a given national currency in the European monetary union.</para>
- <para><parameter>currency</parameter> is one of the following:</para>
- <para> ATS (Austria)</para>
- <para> BEF (Belgium)</para>
- <para> DEM (Germany)</para>
- <para> ESP (Spain)</para>
- <para> EUR (Euro)</para>
- <para> FIM (Finland)</para>
- <para> FRF (France)</para>
- <para> GRD (Greek)</para>
- <para> IEP (Ireland)</para>
- <para> ITL (Italy)</para>
- <para> LUF (Luxembourg)</para>
- <para> NLG (Netherlands)</para>
- <para> PTE (Portugal)</para>
- <itemizedlist>
- <listitem>
- <para>If the given <parameter>currency</parameter> is other than one of the above, <function>EURO</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EURO</function>("DEM") returns 1.95583.</para>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-EUROCONVERT"><function>EUROCONVERT</function></link>.
</para>
</refsect1>
</refentry>
@@ -5619,30 +3768,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>EUROCONVERT</function> converts the currency value <parameter>n</parameter> of <parameter>source</parameter> currency to a target currency <parameter>target</parameter>. Both currencies are given as three-letter strings using the ISO code system names. The following currencies are available:</para>
- <para> ATS (Austria)</para>
- <para> BEF (Belgium)</para>
- <para> DEM (Germany)</para>
- <para> ESP (Spain)</para>
- <para> EUR (Euro)</para>
- <para> FIM (Finland)</para>
- <para> FRF (France)</para>
- <para> GRD (Greek)</para>
- <para> IEP (Ireland)</para>
- <para> ITL (Italy)</para>
- <para> LUF (Luxembourg)</para>
- <para> NLG (Netherlands)</para>
- <para> PTE (Portugal)</para>
- <itemizedlist>
- <listitem>
- <para>If the given <parameter>source</parameter> or <parameter>target</parameter> is other than one of the above, <function>EUROCONVERT</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EUROCONVERT</function>(2.1,"DEM","EUR") returns 1.07.</para>
+ <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>
</refsect1>
<refsect1>
<title>See also</title>
@@ -5663,29 +3792,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>FV</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pmt</parameter>[,<parameter>pv</parameter>,<parameter>type</parameter>])</synopsis>
+ <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> computes the future value of an investment. This is based on periodic, constant payments and a constant interest rate. The interest rate per period is <parameter>rate</parameter>, <parameter>nper</parameter> is the number of periods in an annuity, <parameter>pmt</parameter> is the payment made each period, <parameter>pv</parameter> is the present value and <parameter>type</parameter> is when the payment is made.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>type</parameter> = 1 then the payment is made at the beginning of the period.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> = 0 it is made at the end of each period.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-PMT"><function>PMT</function></link>,
- <link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>.
</para>
</refsect1>
</refentry>
@@ -5706,18 +3826,13 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FVSCHEDULE</function> returns the future value of given initial value after applying a series of compound periodic interest rates. The argument <parameter>principal</parameter> is the present value; <parameter>schedule</parameter> is an array of interest rates to apply. The <parameter>schedule</parameter> argument must be a range of cells.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain interest rates 0.11, 0.13, 0.09, 0.17, and 0.03. Then</para>
- <para><function>FVSCHEDULE</function>(3000,A1:A5) equals 4942.7911611.</para>
+ <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>: intial value</para>
+ <para><parameter>schedule</parameter>: range of interest rates</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><link linkend="gnumeric-FV"><function>FV</function></link>.
</para>
</refsect1>
</refentry>
@@ -5738,30 +3853,15 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>G_DURATION</function> calculates number of periods needed for an investment to attain a desired value. This function is similar to FV and PV with a difference that we do not need give the direction of cash flows e.g. -100 for a cash outflow and +100 for a cash inflow.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>rate</parameter> <= 0, <function>G_DURATION</function> returns #DIV0 error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>fv</parameter> = 0 or <parameter>pv</parameter> = 0, <function>G_DURATION</function> returns #DIV0 error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>fv</parameter> / <parameter>pv</parameter> < 0, <function>G_DURATION</function> returns #VALUE error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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-PPMT"><function>PPMT</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>,
- <link linkend="gnumeric-DURATION"><function>DURATION</function></link>,
- <link linkend="gnumeric-MDURATION"><function>MDURATION</function></link>.
+ <para><link linkend="gnumeric-FV"><function>FV</function></link>,
+ <link linkend="gnumeric-PV"><function>PV</function></link>.
</para>
</refsect1>
</refentry>
@@ -5778,43 +3878,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>INTRATE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>investment</parameter>,<parameter>redemption</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 and returns the interest rate of a fully vested security.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>investment</parameter> is the price of the security paid at <parameter>settlement</parameter> date and <parameter>redemption</parameter> is the amount to be received at <parameter>maturity</parameter> date.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> date or <parameter>maturity</parameter> date is not valid, <function>INTRATE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>INTRATE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>settlement</parameter> date is after <parameter>maturity</parameter> date or they are the same, <function>INTRATE</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>If you had a bond with a settlement date of April 15, 2000, maturity date September 30, 2000, investment of $100,000, redemption value $103,525, using the actual/actual basis, the bond discount rate is:</para>
- <para>=<function>INTRATE</function>(36631, 36799, 100000, 103525, 1) which equals 0.0648 or 6.48%</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-RECEIVED"><function>RECEIVED</function></link>,
- <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ <para><link linkend="gnumeric-RECEIVED"><function>RECEIVED</function></link>.
</para>
</refsect1>
</refentry>
@@ -5831,33 +3908,21 @@
<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>
+ <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 amount of a payment of an annuity going towards interest.</para>
- <para>Formula for <function>IPMT</function> is:</para>
- <para><function>IPMT</function>(PER) = -PRINCIPAL(PER-1) * INTEREST_RATE</para>
- <para>where:</para>
- <para>PRINCIPAL(PER-1) = amount of the remaining principal from last period</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>fv</parameter> is omitted, it is assumed to be 0.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> is omitted, it is assumed to be 0.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>.
+ <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>.
</para>
</refsect1>
</refentry>
@@ -5874,29 +3939,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IRR</function>(<parameter>values</parameter>[,<parameter>guess</parameter>])</synopsis>
+ <synopsis><function>IRR</function>(<parameter>values</parameter>,<parameter>guess</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IRR</function> calculates and returns the internal rate of return of an investment. This function is closely related to the net present value function (NPV). The <function>IRR</function> is the interest rate for a series of cash flows where the net preset value is zero.</para>
- <para><parameter>values</parameter> contains the series of cash flows generated by the investment. The payments should occur at regular intervals. The optional <parameter>guess</parameter> is the initial value used in calculating the <function>IRR</function>. You do not have to use that, it is only provided for the Excel compatibility.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1:A8 contain the numbers -32432, 5324, 7432, 9332, 12324, 4334, 1235, -3422. Then</para>
- <para><function>IRR</function>(A1:A8) returns 0.04375.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-FV"><function>FV</function></link>,
- <link linkend="gnumeric-NPV"><function>NPV</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>.
+ <para><link linkend="gnumeric-XIRR"><function>XIRR</function></link>.
</para>
</refsect1>
</refentry>
@@ -5917,16 +3970,11 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ISPMT</function> function returns the interest paid on a given period.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>per</parameter> < 1 or <parameter>per</parameter> > <parameter>nper</parameter>, <function>ISPMT</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -5947,41 +3995,21 @@
<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>
+ <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> returns the Macauley duration for a security with par value 100.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 MSRB 30/360 (MSRB Rule G33 (e))</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <para> 5 European+ 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> or <parameter>maturity</parameter> are not valid dates, <function>MDURATION</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>MDURATION</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, MSRB 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is invalid, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-DURATION"><function>DURATION</function></link>,
- <link linkend="gnumeric-G_DURATION"><function>G_DURATION</function></link>.
+ <para><link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -6002,15 +4030,15 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MIRR</function> function returns the modified internal rate of return for a given periodic cash flow.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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-NPV"><function>NPV</function></link>.
+ <para><link linkend="gnumeric-IRR"><function>IRR</function></link>,
+ <link linkend="gnumeric-XIRR"><function>XIRR</function></link>.
</para>
</refsect1>
</refentry>
@@ -6027,28 +4055,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>NOMINAL</function>(<parameter>r</parameter>,<parameter>nper</parameter>)</synopsis>
+ <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 a given effective rate.</para>
- <para>Nominal interest rate is given by a formula:</para>
- <para><parameter>nper</parameter> * (( 1 + <parameter>r</parameter> ) ^ (1 / <parameter>nper</parameter>) - 1 )</para>
- <para>where:</para>
- <para><parameter>r</parameter> = effective interest rate</para>
- <para><parameter>nper</parameter> = number of periods used for compounding</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>rate</parameter> < 0, <function>NOMINAL</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>nper</parameter> <= 0, <function>NOMINAL</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -6069,28 +4082,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>NPER</function>(<parameter>rate</parameter>,<parameter>pmt</parameter>,<parameter>pv</parameter>[,<parameter>fv</parameter>,<parameter>type</parameter>])</synopsis>
+ <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 number of periods of an investment based on periodic constant payments and a constant interest rate.</para>
- <para>The interest rate per period is <parameter>rate</parameter>, <parameter>pmt</parameter> is the payment made each period, <parameter>pv</parameter> is the present value, <parameter>fv</parameter> is the future value and <parameter>type</parameter> is when the payments are due. If <parameter>type</parameter> = 1, payments are due at the beginning of the period, if <parameter>type</parameter> = 0, payments are due at the end of the period.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>rate</parameter> <= 0, <function>NPER</function> returns #DIV0 error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>For example, if you deposit $10,000 in a savings account that earns an interest rate of 6%. To calculate how many years it will take to double your investment use <function>NPER</function> as follows:</para>
- <para>=<function>NPER</function>(0.06, 0, -10000, 20000,0)returns 11.895661046 which indicates that you can double your money just before the end of the 12th year.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>,
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>,
<link linkend="gnumeric-FV"><function>FV</function></link>.
</para>
</refsect1>
@@ -6108,21 +4113,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>NPV</function>(<parameter>rate</parameter>,<parameter>v1</parameter>,<parameter>v2</parameter>,<parameter/>...)</synopsis>
+ <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 an investment generating periodic payments. <parameter>rate</parameter> is the periodic interest rate and <parameter>v1</parameter>, <parameter>v2</parameter>, ... are the periodic payments. If the schedule of the cash flows are not periodic use the XNPV function.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NPV</function>(0.17,-10000,3340,2941,2493,3233,1732,2932) equals 186.30673.</para>
+ <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>,
- <link linkend="gnumeric-XNPV"><function>XNPV</function></link>.
+ <para><link linkend="gnumeric-PV"><function>PV</function></link>.
</para>
</refsect1>
</refentry>
@@ -6139,36 +4141,25 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ODDFPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>first_coupon</parameter>,<parameter>rate</parameter>,<parameter>yld</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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> returns the price per $100 face value of a security. The security should have an odd short or long first period.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>issue</parameter> is the issue date of the security. <parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>ODDFPRICE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-ODDLPRICE"><function>ODDLPRICE</function></link>,
+ <link linkend="gnumeric-ODDFYIELD"><function>ODDFYIELD</function></link>.
</para>
</refsect1>
</refentry>
@@ -6185,36 +4176,25 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ODDFYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>first_coupon</parameter>,<parameter>rate</parameter>,<parameter>pr</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 having an odd first period.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>ODDFYIELD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-ODDFPRICE"><function>ODDFPRICE</function></link>,
+ <link linkend="gnumeric-ODDLYIELD"><function>ODDLYIELD</function></link>.
</para>
</refsect1>
</refentry>
@@ -6231,36 +4211,24 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ODDLPRICE</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>last_interest</parameter>,<parameter>rate</parameter>,<parameter>yld</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 has an odd last coupon period.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>ODDLPRICE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -6277,36 +4245,24 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ODDLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>last_interest</parameter>,<parameter>rate</parameter>,<parameter>pr</parameter>,<parameter>redemption</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 having an odd last period.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>ODDLYIELD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -6323,24 +4279,23 @@
<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>strike2</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>
+ <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>.</para>
- <para>The payoff for a call is max(<parameter>spot2</parameter> - <parameter>strike2</parameter>,0) if <parameter>spot1</parameter> > <parameter>strike1</parameter> or 0 otherwise.</para>
- <para>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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot1</parameter> & <parameter>spot2</parameter> are the spot prices of the underlying assets.</para>
- <para><parameter>strike1</parameter> & <parameter>strike2</parameter> are the strike prices at which the option is struck.</para>
- <para><parameter>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry1</parameter> & <parameter>cost_of_carry2</parameter> are the leakage in value of the underlying assets, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility1</parameter> & <parameter>volatility2</parameter> are the annualized volatility in price of the underlying assets.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -6365,20 +4320,22 @@
<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/> rho)</synopsis>
+ <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>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry1</parameter> & <parameter>cost_of_carry2</parameter> are the leakage in value of the underlying assets, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility1</parameter> & <parameter>volatility2</parameter> are the annualized volatility in price of the underlying assets.</para>
- <para><parameter>rho</parameter> is the correlation between the two assets.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -6403,24 +4360,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <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><function>OPT_BAW_AMER</function> models the theoretical price of an option according to the Barone Adesie & Whaley approximation.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>time</parameter> is the number of days to maturity of the option.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -6443,26 +4382,6 @@
</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/> strike,<parameter/> time,<parameter/> rate,<parameter/> volatility,<parameter/> cost_of_carry)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>OPT_ models the theoretical price of either an American or European style option using a binomial tree.</para>
- <para><parameter>amer_euro_flag</parameter> is either 'a' or 'e' to indicate whether the option being valued is an American or European style option respectively.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>num_time_steps</parameter> is the number of time steps used in the valuation, a greater number of time steps yields greater accuracy however is slower to calculate.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -6485,24 +4404,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <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><function>OPT_BJER_STENS</function> models the theoretical price of American options according to the Bjerksund & Stensland approximation technique.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>time</parameter> is the number of days to maturity of the option.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -6526,24 +4427,18 @@
<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>
+ <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 using call_put_flag, <parameter>call_put_flag</parameter>, 'c' or 'p' struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para><parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate.</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed in the same units as <parameter>strike</parameter> and <parameter>spot</parameter>.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -6568,25 +4463,32 @@
<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>
+ <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>.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para>(The elasticity of an option is the rate of change of its price with respect to its cost of carry.)</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date. <parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate to the exercise date, in percent.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed as the rate of change of option value, per 100% volatility.</para>
- </listitem>
- </itemizedlist>
+ <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>
+ <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>Examples</title>
+ <title>Description</title>
<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>See also</title>
@@ -6611,24 +4513,18 @@
<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>
+ <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 with call_put_flag, <parameter>call_put_flag</parameter>, 'c' or 'p' struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para>Where <parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate.</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed in the same units as <parameter>strike</parameter> and <parameter>spot</parameter>.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -6653,25 +4549,17 @@
<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>
+ <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><function>OPT_BS_GAMMA</function> 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>.</para>
- <para>(The gamma of an option is the second derivative of its price with respect to the price of the underlying asset, and is the same for calls and puts.)</para>
- <para><parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate to the exercise date, in percent.</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed as the rate of change of delta per unit change in <parameter>spot</parameter>.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -6696,25 +4584,18 @@
<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>
+ <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><function>OPT_BS_RHO</function> uses the Black-Scholes model to calculate the 'rho' of a European option with call_put_flag, <parameter>call_put_flag</parameter> struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para>(The rho of an option is the rate of change of its price with respect to the risk free interest rate.)</para>
- <para><parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate to the exercise date, in percent.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed as the rate of change of option value, per 100% change in <parameter>rate</parameter>.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -6739,25 +4620,18 @@
<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>
+ <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><function>OPT_BS_THETA</function> uses the Black-Scholes model to calculate the 'theta' of a European option with call_put_flag, <parameter>call_put_flag</parameter> struck at <parameter>strike</parameter> on an asset with spot price <parameter>spot</parameter>.</para>
- <para>(The theta of an option is the rate of change of its price with respect to time to expiry.)</para>
- <para><parameter>time</parameter> is the time to maturity of the option expressed in years</para>
- <para>and <parameter>rate</parameter> is the risk-free interest rate to the exercise date, in percent.</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed as minus the rate of change of option value, per 365.25 days.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -6782,25 +4656,17 @@
<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>
+ <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><function>OPT_BS_VEGA</function> 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>.</para>
- <para>(The vega of an option is the rate of change of its price with respect to volatility, and is the same for calls and puts.)</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate to the exercise date, in percent.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed as the rate of change of option value, per 100% volatility.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -6824,27 +4690,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>OPT_COMPLEX_CHOOSER</function>(<parameter>call_put_flag</parameter>,<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><function>OPT_COMPLEX_CHOOSER</function> models the theoretical price of complex chooser options.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike_call</parameter> is the strike price at which the option is struck, applicable if exercised as a call option.</para>
- <para><parameter>strike_put</parameter> is the strike price at which the option is struck, applicable if exercised as a put option.</para>
- <para><parameter>time</parameter> is the time in years until the holder chooses a put or a call option.</para>
- <para><parameter>time_call</parameter> is the time in years to maturity of the call option if chosen.</para>
- <para><parameter>time_put</parameter> is the time in years to maturity of the put option if chosen.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -6872,16 +4717,18 @@
</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>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry1</parameter> & <parameter>cost_of_carry2</parameter> are the leakage in value of the underlying assets, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility1</parameter> & <parameter>volatility2</parameter> are the annualized volatility in price of the underlying assets.</para>
- <para><parameter>rho</parameter> is the correlation between the two assets.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -6906,25 +4753,6 @@
</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><function>OPT_EXEC</function> models the theoretical price of executive stock options <parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para>One would expect this to always be a call option.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>time</parameter> is the number of days to maturity of the option.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <para><parameter>lambda</parameter> is the jump rate for executives. The model assumes executives forfeit their options if they leave the company.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -6952,20 +4780,16 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OPT_EXTENDIBLE_WRITER</function> models the theoretical price of extendible writer options. These are options that can be exercised at an initial period, <parameter>time1</parameter>, or 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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike1</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>strike2</parameter> is the strike price at which the option is re-struck if out of the money at <parameter>time1</parameter>.</para>
- <para><parameter>time1</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>time2</parameter> is the is the extended maturity in years if chosen.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -6994,20 +4818,16 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OPT_FIXED_STRK_LKBK</function> models the theoretical price of an 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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>spot_min</parameter> is the minimum spot price of the underlying asset so far observed.</para>
- <para><parameter>spot_max</parameter> is the maximum spot price of the underlying asset so far observed.</para>
- <para><parameter>strike</parameter> is the strike prices at which the option is struck.</para>
- <para><parameter>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -7036,19 +4856,15 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OPT_FLOAT_STRK_LKBK</function> models the theoretical price of an 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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>spot_min</parameter> is the minimum spot price of the underlying asset so far observed.</para>
- <para><parameter>spot_max</parameter> is the maximum spot price of the underlying asset so far observed.</para>
- <para><parameter>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -7072,25 +4888,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>OPT_FORWARD_START</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>alpha</parameter>,<parameter>time1</parameter>,<parameter>time</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>,<parameter>cost_of_carry</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_FORWARD_START</function> models the theoretical price of forward start options</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>alpha</parameter> is a fraction that set the strike price the future date <parameter>time1</parameter>.</para>
- <para><parameter>time1</parameter> is the number of days until the option starts.</para>
- <para><parameter>time</parameter> is the number of days to maturity of the option.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -7114,22 +4911,19 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>OPT_FRENCH</function>(<parameter>call_put_flag</parameter>,<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>time</parameter>,<parameter>t2</parameter>,<parameter>rate</parameter>,<parameter>volatility</parameter>[,<parameter>cost_of_carry</parameter>])</synopsis>
+ <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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>time</parameter> the number of calendar days to exercise divided by calendar days in the year.</para>
- <para><parameter>t2</parameter> is the number of trading days to exercise divided by trading days in the year.</para>
- <para><parameter>rate</parameter> is the risk-free interest rate.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, to the exercise date, in percent.</para>
- <para>For common stocks, this would be the dividend yield.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>
@@ -7154,26 +4948,18 @@
<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>[,<parameter>cost_of_carry</parameter>])</synopsis>
+ <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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>volatility</parameter> is the annualized volatility, in percent, of the asset for the period through to the exercise date.</para>
- <para><parameter>time</parameter> the number of days to exercise.</para>
- <para><parameter>domestic_rate</parameter> is the domestic risk-free interest rate to the exercise date.</para>
- <para><parameter>foreign_rate</parameter> is the foreign risk-free interest rate to the exercise date, in percent.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- <itemizedlist>
- <listitem>
- <para>The returned value will be expressed as the rate of change of option value, per 100% volatility.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>
@@ -7203,18 +4989,14 @@
<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> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price of the option.</para>
- <para><parameter>time</parameter> is the time to maturity of the option expressed in years.</para>
- <para><parameter>rate</parameter> is the annualized rate of interest.</para>
- <para><parameter>volatility</parameter> is the annualized volatility of the underlying asset.</para>
- <para><parameter>lambda</parameter> is expected number of 'jumps' per year.</para>
- <para><parameter>gamma</parameter> is proportion of volatility explained by the 'jumps.'</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>
@@ -7238,31 +5020,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>OPT_MILTERSEN_SCHWARTZ</function>(<parameter>call_put_flag</parameter>,<parameter>p_t</parameter>,<parameter>f_t</parameter>,<parameter>x</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><function>OPT_MILTERSEN_SCHWARTZ</function> models the theoretical price of options on commodities futures according to Miltersen & Schwartz.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>p_t</parameter> is a zero coupon bond with expiry at option maturity.</para>
- <para><parameter>f_t</parameter> is the futures price.</para>
- <para><parameter>x</parameter> is the strike price.</para>
- <para><parameter>t1</parameter> is the time to maturity of the option.</para>
- <para><parameter>t2</parameter> is the time to maturity of the underlying commodity futures contract.</para>
- <para><parameter>v_s</parameter> is the volatility of the spot commodity price.</para>
- <para><parameter>v_e</parameter> is the volatility of the future convenience yield.</para>
- <para><parameter>v_f</parameter> is the volatility of the forward rate of interest.</para>
- <para><parameter>rho_se</parameter> is correlation between the spot commodity price and the convenience yield.</para>
- <para><parameter>rho_sf</parameter> is correlation between the spot commodity price and the forward interest rate.</para>
- <para><parameter>rho_ef</parameter> is correlation between the forward interest rate and the convenience yield.</para>
- <para><parameter>kappa_e</parameter> is the speed of mean reversion of the convenience yield.</para>
- <para><parameter>kappa_f</parameter> is the speed of mean reversion of the forward interest rate.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -7285,27 +5042,6 @@
</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><function>OPT_ON_OPTIONS</function> models the theoretical price of options on options.</para>
- <para><parameter>type_flag</parameter> is 'cc' for calls on calls, 'cp' for calls on puts, and so on for 'pc', and 'pp'.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike1</parameter> is the strike price at which the option being valued is struck.</para>
- <para><parameter>strike2</parameter> is the strike price at which the underlying option is struck.</para>
- <para><parameter>time1</parameter> is the time in years to maturity of the option.</para>
- <para><parameter>time2</parameter> is the time in years to the maturity of the underlying option.</para>
- <para>(<parameter>time2</parameter> >= <parameter>time1</parameter>).</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset of the underlying option.for common stocks, this would be the dividend yield.</para>
- <para><parameter>volatility</parameter> is the annualized volatility in price of the underlying asset of the underlying option.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -7328,24 +5064,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>OPT_RGW</function>(<parameter>spot</parameter>,<parameter>strike</parameter>,<parameter>t1</parameter>,<parameter>t2</parameter>,<parameter>rate</parameter>,<parameter>d</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_RGW</function> models the theoretical price of an American option according to the Roll-Geske-Whaley approximation where:</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>t1</parameter> is the time to the dividend payout.</para>
- <para><parameter>t2</parameter> is the time to option expiration.</para>
- <para><parameter>rate</parameter> is the annualized rate of interest.</para>
- <para><parameter>d</parameter> is the amount of the dividend to be paid expressed in currency.</para>
- <para><parameter>volatility</parameter> is the annualized rate of volatility of the underlying asset.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -7368,24 +5086,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <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>rate</parameter>,<parameter>cost_of_carry</parameter>,<parameter>volatility</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_SIMPLE_CHOOSER</function> models the theoretical price of simple chooser options.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>time1</parameter> is the time in years until the holder chooses a put or a call option.</para>
- <para><parameter>time2</parameter> is the time in years until the chosen option expires.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -7408,24 +5108,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <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>volatility1</parameter>,<parameter>volatility2</parameter>,<parameter>rho</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>OPT_SPREAD_APPROX</function> models the theoretical price of a European option on the spread between two futures contracts.</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>fut_price1</parameter> & <parameter>fut_price2</parameter> are the prices of the two futures contracts.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck</para>
- <para><parameter>time</parameter> is the initial maturity of the option in years.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>volatility1</parameter> & <parameter>volatility2</parameter> are the annualized volatility in price of the underlying futures contracts.</para>
- <para><parameter>rho</parameter> is the correlation between the two futures contracts.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-OPT_BS"><function>OPT_BS</function></link>,
@@ -7453,21 +5135,17 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OPT_TIME_SWITCH</function> models the theoretical price of time switch options. (Pechtl 1995)</para>
- <para>The holder receives <parameter>a</parameter> * <parameter>dt</parameter> for each period dt that the asset price was greater than the strike price (for a call) or below it (for a put).</para>
- <para><parameter>call_put_flag</parameter> is 'c' or 'p' to indicate whether the option is a call or a put.</para>
- <para><parameter>spot</parameter> is the spot price of the underlying asset.</para>
- <para><parameter>strike</parameter> is the strike price at which the option is struck.</para>
- <para><parameter>a</parameter> is the amount received for each time period as discussed above.</para>
- <para><parameter>time</parameter> is the maturity of the option in years.</para>
- <para><parameter>m</parameter> is the number of time units the option has already met the condition.</para>
- <para><parameter>dt</parameter> is the agreed upon discrete time period (often a day) expressed as a fraction of a year.</para>
- <para><parameter>rate</parameter> is the annualized risk-free rate of interest.</para>
- <para><parameter>cost_of_carry</parameter> is the leakage in value of the underlying asset, for common stocks, this would be the dividend yield.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -7492,34 +5170,23 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>PMT</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pv</parameter>[,<parameter>fv</parameter>,<parameter>type</parameter>])</synopsis>
+ <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> returns the amount of payment for a loan based on a constant interest rate and constant payments (each payment is equal amount).</para>
- <para><parameter>rate</parameter> is the constant interest rate.</para>
- <para><parameter>nper</parameter> is the overall number of payments.</para>
- <para><parameter>pv</parameter> is the present value.</para>
- <para><parameter>fv</parameter> is the future value.</para>
- <para><parameter>type</parameter> is the type of the payment: 0 means at the end of the period and 1 means at the beginning of the period.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>fv</parameter> is omitted, Gnumeric assumes it to be zero.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> is omitted, Gnumeric assumes it to be zero.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-PPMT"><function>PPMT</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>.
+ <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>
@@ -7536,34 +5203,21 @@
<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>
+ <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 amount of a payment of an annuity going towards principal.</para>
- <para>Formula for it is:</para>
- <para><function>PPMT</function>(per) = PMT - IPMT(per)</para>
- <para>where:</para>
- <para>PMT = Payment received on annuity</para>
- <para>IPMT(per) = amount of interest for period <parameter>per</parameter></para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>fv</parameter> is omitted, it is assumed to be 0.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> is omitted, it is assumed to be 0.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>,
- <link linkend="gnumeric-FV"><function>FV</function></link>.
+ <para><link linkend="gnumeric-IPMT"><function>IPMT</function></link>.
</para>
</refsect1>
</refentry>
@@ -7580,36 +5234,23 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>PRICE</function>(<parameter>settle</parameter>,<parameter>mat</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>,<parameter>redemption_price</parameter>,<parameter/>[frequency,<parameter>basis</parameter>])</synopsis>
+ <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> returns price per $100 face value of a security. This method can only be used if the security pays periodic interest.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>PRICE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-YIELD"><function>YIELD</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -7626,36 +5267,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>PRICEDISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>discount</parameter>,<parameter>redemption</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 and returns the price per $100 face value of a security bond. The security does not pay interest at maturity.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>discount</parameter> is the rate for which the security is discounted. <parameter>redemption</parameter> is the amount to be received on <parameter>maturity</parameter> date.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> date or <parameter>maturity</parameter> date is not valid, <function>PRICEDISC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>PRICEDISC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>settlement</parameter> date is after <parameter>maturity</parameter> date or they are the same, <function>PRICEDISC</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -7676,35 +5297,17 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>PRICEMAT</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>rate</parameter>,<parameter>yield</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 and returns the price per $100 face value of a security. The security pays interest at maturity.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>issue</parameter> is the issue date of the security. <parameter>rate</parameter> is the discount rate of the security. <parameter>yield</parameter> is the annual yield of the security. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> date or <parameter>maturity</parameter> date is not valid, <function>PRICEMAT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>PRICEMAT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>settlement</parameter> date is after <parameter>maturity</parameter> date or they are the same, <function>PRICEMAT</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -7725,23 +5328,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>PV</function>(<parameter>rate</parameter>,<parameter>nper</parameter>,<parameter>pmt</parameter>[,<parameter>fv</parameter>,<parameter>type</parameter>])</synopsis>
+ <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 an investment. <parameter>rate</parameter> is the periodic interest rate, <parameter>nper</parameter> is the number of periods used for compounding. <parameter>pmt</parameter> is the payment made each period, <parameter>fv</parameter> is the future value and <parameter>type</parameter> is when the payment is made.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>type</parameter> = 1 then the payment is made at the beginning of the period.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> = 0 (or omitted) it is made at the end of each period.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -7762,26 +5358,17 @@
<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>
+ <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 an investment.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>pmt</parameter> is omitted it defaults to 0</para>
- </listitem>
- <listitem>
- <para>If <parameter>nper</parameter> <= 0, <function>RATE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> != 0 and <parameter>type</parameter> != 1, <function>RATE</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -7803,36 +5390,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>RECEIVED</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>investment</parameter>,<parameter>rate</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 and returns the amount to be received at maturity date for a security bond.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. The amount of investment is specified in <parameter>investment</parameter>. <parameter>rate</parameter> is the security's discount rate.</para>
- <para><parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> date or <parameter>maturity</parameter> date is not valid, <function>RECEIVED</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> < 0 or <parameter>basis</parameter> > 4, <function>RECEIVED</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>settlement</parameter> date is after <parameter>maturity</parameter> date or they are the same, <function>RECEIVED</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -7853,32 +5420,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SLN</function>(<parameter>cost</parameter>,<parameter>salvage_value</parameter>,<parameter>life</parameter>)</synopsis>
+ <synopsis><function>SLN</function>(<parameter>cost</parameter>,<parameter>salvage</parameter>,<parameter>life</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SLN</function> function will determine the straight line depreciation of an asset for a single period.</para>
- <para>The formula is:</para>
- <para>Depreciation expense = ( <parameter>cost</parameter> - <parameter>salvage_value</parameter> ) / <parameter>life</parameter></para>
- <para><parameter>cost</parameter> is the cost of an asset when acquired (market value).</para>
- <para><parameter>salvage_value</parameter> is the amount you get when asset is sold at the end of the asset's useful life.</para>
- <para><parameter>life</parameter> is the anticipated life of an asset.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>life</parameter> <= 0, <function>SLN</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>For example, lets suppose your company purchases a new machine for $10,000, which has a salvage value of $700 and will have a useful life of 10 years. The <function>SLN</function> yearly depreciation is computed as follows:</para>
- <para>=<function>SLN</function>(10000, 700, 10)</para>
- <para>This will return the yearly depreciation figure of $930.</para>
+ <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-SYD"><function>SYD</function></link>.
+ <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>
@@ -7895,33 +5450,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SYD</function>(<parameter>cost</parameter>,<parameter>salvage_value</parameter>,<parameter>life</parameter>,<parameter>period</parameter>)</synopsis>
+ <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> function calculates the sum-of-years digits depreciation for an asset based on its cost, salvage value, anticipated life and a particular period. This method accelerates the rate of the depreciation, so that more depreciation expense occurs in earlier periods than in later ones. The depreciable cost is the actual cost minus the salvage value. The useful life is the number of periods (typically years) over which the asset is depreciated.</para>
- <para>The Formula used for sum-of-years digits depreciation is:</para>
- <para>Depreciation expense =</para>
- <para> ( <parameter>cost</parameter> - <parameter>salvage_value</parameter> ) * (<parameter>life</parameter> - <parameter>period</parameter> + 1) * 2 / <parameter>life</parameter> * (<parameter>life</parameter> + 1).</para>
- <para><parameter>cost</parameter> is the cost of an asset when acquired (market value).</para>
- <para><parameter>salvage_value</parameter> is the amount you get when asset sold at the end of its useful life.</para>
- <para><parameter>life</parameter> is the anticipated life of an asset.</para>
- <para><parameter>period</parameter> is the period for which we need the expense.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>life</parameter> <= 0, <function>SYD</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>For example say a company purchases a new computer for $5000 which has a salvage value of $200, and a useful life of five years. We would use the following to calculate the second year's depreciation using the <function>SYD</function> method:</para>
- <para>=<function>SYD</function>(5000, 200, 5, 2) which returns 1,280.00.</para>
+ <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-SLN"><function>SLN</function></link>.
+ <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>
@@ -7942,21 +5485,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TBILLEQ</function> function returns the bond-yield equivalent (BEY) for a treasury bill. <function>TBILLEQ</function> is equivalent to</para>
- <para> (365 * <parameter>discount</parameter>) / (360 - <parameter>discount</parameter> * DSM),</para>
- <para>where DSM is the days between <parameter>settlement</parameter> and <parameter>maturity</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> is after <parameter>maturity</parameter> or the <parameter>maturity</parameter> is set to over one year later than the <parameter>settlement</parameter>, <function>TBILLEQ</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>discount</parameter> is negative, <function>TBILLEQ</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -7982,19 +5514,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TBILLPRICE</function> function returns the price per $100 value for a treasury bill where <parameter>settlement</parameter> is the settlement date and <parameter>maturity</parameter> is the maturity date of the bill. <parameter>discount</parameter> is the treasury bill's discount rate.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> is after <parameter>maturity</parameter> or the <parameter>maturity</parameter> is set to over one year later than the <parameter>settlement</parameter>, <function>TBILLPRICE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>discount</parameter> is negative, <function>TBILLPRICE</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -8016,23 +5539,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>TBILLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>pr</parameter>)</synopsis>
+ <synopsis><function>TBILLYIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>price</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TBILLYIELD</function> function returns the yield for a treasury bill. <parameter>settlement</parameter> is the settlement date and <parameter>maturity</parameter> is the maturity date of the bill. <parameter>discount</parameter> is the treasury bill's discount rate.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>settlement</parameter> is after <parameter>maturity</parameter> or the <parameter>maturity</parameter> is set to over one year later than the <parameter>settlement</parameter>, <function>TBILLYIELD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>pr</parameter> is negative, <function>TBILLYIELD</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -8054,39 +5568,23 @@
<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>switch</parameter>])</synopsis>
+ <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 or partial period using the double-declining balance method.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>start_period</parameter> < 0, <function>VDB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>start_period</parameter> > <parameter>end_period</parameter>, <function>VDB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>end_period</parameter> > <parameter>life</parameter>, <function>VDB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>cost</parameter> < 0, <function>VDB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>salvage</parameter> > <parameter>cost</parameter>, <function>VDB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>factor</parameter> <= 0, <function>VDB</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-DB"><function>DB</function></link>.
+ <para><link linkend="gnumeric-DB"><function>DB</function></link>,
+ <link linkend="gnumeric-DDB"><function>DDB</function></link>.
</para>
</refsect1>
</refentry>
@@ -8103,28 +5601,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>XIRR</function>(<parameter>values</parameter>,<parameter>dates</parameter>[,<parameter>guess</parameter>])</synopsis>
+ <synopsis><function>XIRR</function>(<parameter>values</parameter>,<parameter>dates</parameter>,<parameter>guess</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>XIRR</function> calculates and returns the internal rate of return of an investment that has not necessarily periodic payments. This function is closely related to the net present value function (NPV and XNPV). The <function>XIRR</function> is the interest rate for a series of cash flows where the XNPV is zero.</para>
- <para><parameter>values</parameter> contains the series of cash flows generated by the investment. <parameter>dates</parameter> contains the dates of the payments. The first date describes the payment day of the initial payment and thus all the other dates should be after this date. The optional <parameter>guess</parameter> is the initial value used in calculating the <function>XIRR</function>. You do not have to use that, it is only provided for the Excel compatibility.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1:A5 contain the numbers -6000, 2134, 1422, 1933, and 1422, and the cells B1:B5 contain the dates "1999-01-15", "1999-04-04", "1999-05-09", "2000-03-12", and "2000-05-1". Then</para>
- <para><function>XIRR</function>(A1:A5,B1:B5) returns 0.224838.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-IRR"><function>IRR</function></link>,
- <link linkend="gnumeric-XNPV"><function>XNPV</function></link>.
+ <para><link linkend="gnumeric-IRR"><function>IRR</function></link>.
</para>
</refsect1>
</refentry>
@@ -8145,21 +5633,14 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>XNPV</function> calculates the net present value of an investment. The schedule of the cash flows is given in <parameter>dates</parameter> array. The first date indicates the beginning of the payment schedule. <parameter>rate</parameter> is the interest rate and <parameter>values</parameter> are the payments.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>values</parameter> and <parameter>dates</parameter> contain unequal number of values, <function>XNPV</function> returns the #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para><link linkend="gnumeric-NPV"><function>NPV</function></link>,
- <link linkend="gnumeric-PV"><function>PV</function></link>.
+ <para><link linkend="gnumeric-NPV"><function>NPV</function></link>.
</para>
</refsect1>
</refentry>
@@ -8176,36 +5657,23 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>YIELD</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>rate</parameter>,<parameter>price</parameter>,<parameter>redemption_price</parameter>,<parameter>frequency</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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> returns the yield on a security that pays periodic interest.</para>
- <para><parameter>frequency</parameter> is the number of coupon payments per year. Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>YIELD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-PRICE"><function>PRICE</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -8222,36 +5690,21 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>YIELDDISC</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>pr</parameter>,<parameter>redemption</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 annual yield of a security that is discounted.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>pr</parameter> is the price per $100 face value of the security. <parameter>redemption</parameter> is the redemption value per $100 face value. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>frequency</parameter> is other than 1, 2, or 4, <function>YIELDDISC</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-PRICE"><function>PRICE</function></link>,
+ <link linkend="gnumeric-DURATION"><function>DURATION</function></link>.
</para>
</refsect1>
</refentry>
@@ -8268,33 +5721,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>YIELDMAT</function>(<parameter>settlement</parameter>,<parameter>maturity</parameter>,<parameter>issue</parameter>,<parameter>rate</parameter>,<parameter>pr</parameter>[,<parameter>basis</parameter>])</synopsis>
+ <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 annual yield of a security for which the interest is paid at maturity date.</para>
- <para><parameter>settlement</parameter> is the settlement date of the security. <parameter>maturity</parameter> is the maturity date of the security. <parameter>issue</parameter> is the issue date of the security. <parameter>rate</parameter> is the interest rate set to the security. <parameter>pr</parameter> is the price per $100 face value of the security. <parameter>basis</parameter> is the type of day counting system you want to use:</para>
- <para> 0 US 30/360</para>
- <para> 1 actual days/actual days</para>
- <para> 2 actual days/360</para>
- <para> 3 actual days/365</para>
- <para> 4 European 30/360</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>basis</parameter> is omitted, US 30/360 is applied.</para>
- </listitem>
- <listitem>
- <para>If <parameter>basis</parameter> is not in between 0 and 4, #NUM! error is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
- <para>
+ <para><link linkend="gnumeric-YIELDDISC"><function>YIELDDISC</function></link>,
+ <link linkend="gnumeric-YIELD"><function>YIELD</function></link>.
</para>
</refsect1>
</refentry>
@@ -8321,9 +5763,9 @@
<para><function>GNUMERIC_VERSION</function> returns the version of gnumeric as a string.</para>
</refsect1>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>GNUMERIC_VERSION</function>().</para>
+ <title>See also</title>
+ <para>
+ </para>
</refsect1>
</refentry>
</sect1>
@@ -8342,30 +5784,38 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>CELL</function>(<parameter>type</parameter>,<parameter>ref</parameter>)</synopsis>
+ <synopsis><function>CELL</function>(<parameter>type</parameter>,<parameter>cell</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CELL</function> returns information about the formatting, location, or contents of a cell.</para>
<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>ref</parameter>.</para>
- <para> contents Returns the contents of the cell in <parameter>ref</parameter>.</para>
- <para> format Returns the code of the format of the cell.</para>
- <para> parentheses Returns 1 if <parameter>ref</parameter> contains a negative value</para>
- <para> and its format displays it with parentheses.</para>
- <para> row Returns the number of the row in <parameter>ref</parameter>.</para>
- <para> width Returns the column width.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Cell("format",A1) returns the code of the format of the cell A1.</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>
@@ -8385,23 +5835,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COUNTBLANK</function>(<parameter>range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUNTBLANK</function> returns the number of blank cells in a <parameter>range</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COUNTBLANK</function>(A1:A20) returns the number of blank cell in A1:A20.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
@@ -8420,18 +5853,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ERROR</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ERROR</function> return the specified error.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ERROR</function>("#OWN <function>ERROR</function>").</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
@@ -8451,27 +5872,19 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ERROR.TYPE</function>(<parameter>value</parameter>)</synopsis>
+ <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> #NUM! 6</para>
<para> #N/A 7</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ERROR.TYPE</function>(NA()) equals 7.</para>
+ <para><parameter>error</parameter>: an error</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -8491,19 +5904,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>EXPRESSION</function>(<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EXPRESSION</function> returns expression in <parameter>cell</parameter> as a string, or empty if the cell is not an expression.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>entering '=<function>EXPRESSION</function>(A3)' in A2 = empty (assuming there is nothing in A3).</para>
- <para>entering '=<function>EXPRESSION</function>(A2)' in A1 = '<function>EXPRESSION</function>(A3)'.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-TEXT"><function>TEXT</function></link>.
@@ -8522,19 +5922,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GET.FORMULA</function>(<parameter>cell</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>EXPRESSION returns expression in <parameter>cell</parameter> as a string, or empty if the cell is not an expression.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>entering '=<function>GET.FORMULA</function>(A3)' in A2 = empty (assuming there is nothing in A3).</para>
- <para>entering '=<function>GET.FORMULA</function>(A2)' in A1 = '=<function>GET.FORMULA</function>(A3)'.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXPRESSION"><function>EXPRESSION</function></link>.
@@ -8553,27 +5940,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GETENV</function>(<parameter>string</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GETENV</function> retrieves a value from the execution environment.</para>
- <itemizedlist>
- <listitem>
- <para>If the variable specified by <parameter>string</parameter> does not exist, #N/A! will be returned. Note, that variable names are case sensitive.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-INFO">
<refmeta>
@@ -8592,30 +5958,20 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>INFO</function> returns information about the current operating environment.</para>
- <para><parameter>type</parameter> is the type of information you want to obtain:</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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible, except that types directory and origin are not implemented.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>INFO</function>("system") returns "Linux" on a Linux system.</para>
+ <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>
+ <para><link linkend="gnumeric-CELL"><function>CELL</function></link>.
</para>
</refsect1>
</refentry>
@@ -8631,28 +5987,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISBLANK</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISBLANK</function> returns TRUE if the value is blank.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISBLANK</function>(A1).</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-ISERR">
<refmeta>
@@ -8666,23 +6000,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISERR</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISERR</function> returns TRUE if the value is any error value except #N/A.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISERR</function>(NA()) return FALSE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
@@ -8701,26 +6018,10 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISERROR</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISERROR</function> returns a TRUE value if the expression has an error.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISERROR</function>(NA()) equals TRUE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-ERROR"><function>ERROR</function></link>.
+ <para><link linkend="gnumeric-ISERR"><function>ISERR</function></link>,
+ <link linkend="gnumeric-ISNA"><function>ISNA</function></link>.
</para>
</refsect1>
</refentry>
@@ -8736,23 +6037,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISEVEN</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISEVEN</function> returns TRUE if the number is even.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISEVEN</function>(4) equals TRUE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISODD"><function>ISODD</function></link>.
@@ -8771,28 +6055,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISLOGICAL</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISLOGICAL</function> returns TRUE if the value is a logical value.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISLOGICAL</function>(A1).</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-ISNA">
<refmeta>
@@ -8806,23 +6068,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISNA</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISNA</function> returns TRUE if the value is the #N/A error value.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISNA</function>(NA()) equals TRUE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NA"><function>NA</function></link>.
@@ -8841,23 +6086,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISNONTEXT</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISNONTEXT</function> Returns TRUE if the value is not text.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISNONTEXT</function>("text") equals FALSE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISTEXT"><function>ISTEXT</function></link>.
@@ -8876,28 +6104,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISNUMBER</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISNUMBER</function> returns TRUE if the value is a number.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISNUMBER</function>("text") equals FALSE.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-ISODD">
<refmeta>
@@ -8911,23 +6117,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISODD</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISODD</function> returns TRUE if the number is odd.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISODD</function>(3) equals TRUE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISEVEN"><function>ISEVEN</function></link>.
@@ -8946,28 +6135,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISREF</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISREF</function> returns TRUE if the value is a reference.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISREF</function>(A1) equals TRUE.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-ISTEXT">
<refmeta>
@@ -8981,23 +6148,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ISTEXT</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ISTEXT</function> returns TRUE if the value is text.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ISTEXT</function>("text") equals TRUE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISNONTEXT"><function>ISNONTEXT</function></link>.
@@ -9016,28 +6166,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>N</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>N</function> returns a value converted to a number. Strings containing text are converted to the zero value.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>N</function>("42") equals 42.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-NA">
<refmeta>
@@ -9051,23 +6179,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>NA</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NA</function> returns the error value #N/A.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NA</function>() equals #N/A error.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ISNA"><function>ISNA</function></link>.
@@ -9091,28 +6202,13 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TYPE</function> returns a number indicating the data type of a value.</para>
- <para>1 == number</para>
- <para>2 == text</para>
- <para>4 == boolean</para>
- <para>16 == error</para>
- <para>64 == array</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TYPE</function>(3) equals 1.</para>
- <para><function>TYPE</function>("text") equals 2.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <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>
@@ -9131,36 +6227,19 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>AND</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>AND</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>AND</function> implements the logical <function>AND</function> function: the result is TRUE if all of the expressions evaluate to TRUE, otherwise it returns FALSE.</para>
- <para><parameter>b1</parameter> through <parameter>bN</parameter> are expressions that should evaluate to TRUE or FALSE. If an integer or floating point value is provided, zero is considered FALSE and anything else is TRUE.</para>
- <itemizedlist>
- <listitem>
- <para>If the values contain strings or empty cells those values are ignored.</para>
- </listitem>
- <listitem>
- <para>If no logical values are provided, then the error #VALUE! is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>AND</function>(TRUE,TRUE) equals TRUE.</para>
- <para><function>AND</function>(TRUE,FALSE) equals FALSE.</para>
- <para>Let us assume that A1 holds number five and A2 number one. Then</para>
- <para><function>AND</function>(A1>3,A2<2) equals TRUE.</para>
+ <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>See also</title>
<para><link linkend="gnumeric-OR"><function>OR</function></link>,
- <link linkend="gnumeric-NOT"><function>NOT</function></link>.
+ <link linkend="gnumeric-NOT"><function>NOT</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
</para>
</refsect1>
</refentry>
@@ -9181,21 +6260,12 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FALSE</function> returns boolean value false.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FALSE</function>() equals <function>FALSE</function>.</para>
+ <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>.
+ <para><link linkend="gnumeric-TRUE"><function>TRUE</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
</para>
</refsect1>
</refentry>
@@ -9212,28 +6282,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>IF</function>(<parameter>condition</parameter>[,<parameter>if</parameter>-true,<parameter>if</parameter>-false])</synopsis>
+ <synopsis><function>IF</function>(<parameter>cond</parameter>,<parameter>trueval</parameter>,<parameter>falseval</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>IF</function> function can be used to evaluate conditionally other expressions. <function>IF</function> evaluates <parameter>condition</parameter>. If <parameter>condition</parameter> returns a non-zero value the result of the <function>IF</function> expression is the <parameter>if</parameter>-true expression, otherwise <function>IF</function> evaluates to the value of <parameter>if</parameter>-false.</para>
- <itemizedlist>
- <listitem>
- <para>If omitted <parameter>if</parameter>-true defaults to TRUE and <parameter>if</parameter>-false to FALSE.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>IF</function>(FALSE,TRUE,FALSE) equals FALSE.</para>
+ <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>
+ <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>
@@ -9278,27 +6342,18 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>NOT</function>(<parameter>number</parameter>)</synopsis>
+ <synopsis><function>NOT</function>(<parameter>b</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>NOT</function> implements the logical <function>NOT</function> function: the result is TRUE if the <parameter>number</parameter> is zero; otherwise the result is FALSE.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NOT</function>(0) equals TRUE.</para>
- <para><function>NOT</function>(TRUE) equals FALSE.</para>
+ <para><function>NOT</function> calculates the logical negation of its argument.</para>
+ <para><parameter>b</parameter>: logical value</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-OR"><function>OR</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
</para>
</refsect1>
</refentry>
@@ -9315,34 +6370,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>OR</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>OR</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>OR</function> implements the logical <function>OR</function> function: the result is TRUE if any of the values evaluated to TRUE.</para>
- <para><parameter>b1</parameter> through <parameter>bN</parameter> are expressions that should evaluate to TRUE or FALSE. If an integer or floating point value is provided, zero is considered FALSE and anything else is TRUE.</para>
- <itemizedlist>
- <listitem>
- <para>If the values contain strings or empty cells those values are ignored.</para>
- </listitem>
- <listitem>
- <para>If no logical values are provided, then the error #VALUE! is returned.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>OR</function>(TRUE,FALSE) equals TRUE.</para>
- <para><function>OR</function>(3>4,4<3) equals FALSE.</para>
+ <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>See also</title>
<para><link linkend="gnumeric-AND"><function>AND</function></link>,
- <link linkend="gnumeric-NOT"><function>NOT</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>
@@ -9363,21 +6404,12 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TRUE</function> returns boolean value true.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TRUE</function>() equals <function>TRUE</function>.</para>
+ <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>.
+ <para><link linkend="gnumeric-FALSE"><function>FALSE</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
</para>
</refsect1>
</refentry>
@@ -9394,32 +6426,20 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>XOR</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>XOR</function>(<parameter>b0</parameter>,<parameter>b1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>XOR</function> implements the logical exclusive OR function: the result is TRUE if an odd number of the values evaluated to TRUE.</para>
- <para><parameter>b1</parameter> through <parameter>bN</parameter> are expressions that should evaluate to TRUE or FALSE. If an integer or floating point value is provided, zero is considered FALSE and anything else is TRUE.</para>
- <itemizedlist>
- <listitem>
- <para>If the values contain strings or empty cells those values are ignored.</para>
- </listitem>
- <listitem>
- <para>If no logical values are provided, then the error #VALUE! is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>XOR</function>(TRUE,FALSE) equals TRUE.</para>
- <para><function>XOR</function>(3>4,4<3) equals FALSE.</para>
+ <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>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-NOT"><function>NOT</function></link>,
+ <link linkend="gnumeric-IF"><function>IF</function></link>.
</para>
</refsect1>
</refentry>
@@ -9438,42 +6458,6 @@
</refname>
<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><function>ADDRESS</function> returns a cell address as text for specified row and column numbers.</para>
- <para><parameter>a1</parameter> is a logical value that specifies the reference style. If <parameter>a1</parameter> is TRUE or omitted, <function>ADDRESS</function> returns an A1-style reference, i.e. $D$4. Otherwise <function>ADDRESS</function> returns an R1C1-style reference, i.e. R4C4.</para>
- <para><parameter>text</parameter> specifies the name of the worksheet to be used as the external reference.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>abs_num</parameter> is 1 or omitted, <function>ADDRESS</function> returns absolute reference.</para>
- </listitem>
- <listitem>
- <para>If <parameter>abs_num</parameter> is 2 <function>ADDRESS</function> returns absolute row and relative column.</para>
- </listitem>
- <listitem>
- <para>If <parameter>abs_num</parameter> is 3 <function>ADDRESS</function> returns relative row and absolute column.</para>
- </listitem>
- <listitem>
- <para>If <parameter>abs_num</parameter> is 4 <function>ADDRESS</function> returns relative reference.</para>
- </listitem>
- <listitem>
- <para>If <parameter>abs_num</parameter> is greater than 4 <function>ADDRESS</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>row_num</parameter> or <parameter>col_num</parameter> is less than one, <function>ADDRESS</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ADDRESS</function>(5,4) equals "$D$5".</para>
- <para><function>ADDRESS</function>(5,4,4) equals "D5".</para>
- <para><function>ADDRESS</function>(5,4,3,FALSE) equals "R[5]C4".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COLUMNNUMBER"><function>COLUMNNUMBER</function></link>.
@@ -9492,18 +6476,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>AREAS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>AREAS</function> returns the number of areas in <parameter>reference</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>AREAS</function>((A1,B2,C3)) equals 3.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>,
@@ -9526,21 +6498,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>CHOOSE</function>(<parameter>index</parameter>[,<parameter>value1</parameter>][,<parameter>value2</parameter>]...)</synopsis>
+ <synopsis><function>CHOOSE</function>(<parameter>index</parameter>,<parameter>value1</parameter>,<parameter>value2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CHOOSE</function> returns the value of index <parameter>index</parameter>. <parameter>index</parameter> is rounded to an integer if it is not.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>index</parameter> < 1 or <parameter>index</parameter> > number of values, <function>CHOOSE</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CHOOSE</function>(3,"Apple","Orange","Grape","Perry") equals "Grape".</para>
+ <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>See also</title>
@@ -9561,19 +6526,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>COLUMN</function>(<parameter/>[reference].)</synopsis>
+ <synopsis><function>COLUMN</function>(<parameter>x</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>COLUMN</function> function returns a Nx1 array containing the series of integers from the first column to the last column of <parameter>reference</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>reference</parameter> defaults to the position of the current expression.</para>
- </listitem>
- <listitem>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
+ <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>See also</title>
@@ -9595,23 +6553,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COLUMNNUMBER</function>(<parameter>name</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COLUMNNUMBER</function> function returns an integer corresponding to the column name supplied as a string.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>name</parameter> is invalid, <function>COLUMNNUMBER</function> returns the #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COLUMNNUMBER</function>("E") equals 5.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ADDRESS"><function>ADDRESS</function></link>.
@@ -9630,23 +6571,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COLUMNS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COLUMNS</function> function returns the number of columns in area or array reference.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>COLUMNS</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COLUMNS</function>(H2:J3) equals 3.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
@@ -9668,23 +6592,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>HLOOKUP</function>(<parameter>value</parameter>,<parameter>range</parameter>,<parameter>row</parameter>[,<parameter>approximate</parameter>,<parameter>as_index</parameter>])</synopsis>
+ <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 col in range that has a first row cell similar to <parameter>value</parameter>. If <parameter>approximate</parameter> is not true it finds the col with an exact equivalence. If <parameter>approximate</parameter> is true, then the values must be sorted in order of ascending value for correct function; in this case it finds the col with value less than <parameter>value</parameter> it returns the value in the col found at a 1-based offset in <parameter>row</parameter> rows into the <parameter>range</parameter>. <parameter>as_index</parameter> returns the 0-based offset that matched rather than the value.</para>
- <itemizedlist>
- <listitem>
- <para><function>HLOOKUP</function> returns #NUM! if <parameter>row</parameter> < 0.</para>
- </listitem>
- <listitem>
- <para><function>HLOOKUP</function> returns #REF! if <parameter>row</parameter> falls outside <parameter>range</parameter>.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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 FALSE</para>
+ <para><parameter>as_index</parameter>: if true, the 0-based row offset is returned; defaults to FALSE</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -9705,21 +6622,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>HYPERLINK</function>(<parameter>link_location</parameter>[,<parameter>optional_label</parameter>])</synopsis>
+ <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>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HYPERLINK</function>("www.gnome.org","GNOME").</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <para><parameter>link_location</parameter>: string</para>
+ <para><parameter>label</parameter>: string, optional</para>
</refsect1>
</refentry>
<refentry id="gnumeric-INDEX">
@@ -9735,28 +6644,15 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>INDEX</function>(<parameter>array</parameter>[,<parameter>row</parameter>,<parameter/> col,<parameter/> area])</synopsis>
+ <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 pointed out by <parameter>row</parameter> and <parameter>col</parameter>, which count the rows and columns in the array.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>row</parameter> and <parameter>col</parameter> are omitted the are assumed to be 1.</para>
- </listitem>
- <listitem>
- <para>If the reference falls outside the range of the <parameter>array</parameter>, <function>INDEX</function> returns a #REF! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then <function>INDEX</function>(A1:A5,4,1,1) equals 25.9</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <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>
</refentry>
<refentry id="gnumeric-INDIRECT">
@@ -9771,26 +6667,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>INDIRECT</function>(<parameter>ref_text</parameter>[,<parameter>format</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>INDIRECT</function> function returns the contents of the cell pointed to by the <parameter>ref_text</parameter> string. The string specifies a single cell reference the format of which is either A1 or R1C1 style. The boolean <parameter>format</parameter> controls how <parameter>ref_text</parameter> is to be interpreted: TRUE (the default) for A1 style and FALSE for R1C1 style.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>ref_text</parameter> is not a valid reference in the style controlled by <parameter>format</parameter>, returns #REF!</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>If A1 contains 3.14 and A2 contains "A1", then</para>
- <para><function>INDIRECT</function>(A2) equals 3.14.</para>
- <para>If B1 contains 23 and A1 contains "R1C2", then</para>
- <para><function>INDIRECT</function>(A1,FALSE) equals 23.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-AREAS"><function>AREAS</function></link>,
@@ -9812,26 +6688,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>LOOKUP</function>(<parameter>value</parameter>,<parameter>vector1</parameter>[,<parameter>vector2</parameter>])</synopsis>
+ <synopsis><function>LOOKUP</function>(<parameter>value</parameter>,<parameter>vector1</parameter>,<parameter>vector2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>LOOKUP</function> function finds the row index of <parameter>value</parameter> in <parameter>vector1</parameter> and returns the contents of <parameter>vector2</parameter> at that row index. Alternatively a single array can be used for <parameter>vector1</parameter>. If the area is longer than it is wide then the sense of the search is rotated.</para>
- <itemizedlist>
- <listitem>
- <para>If <function>LOOKUP</function> can't find <parameter>value</parameter> it uses the largest value less than <parameter>value</parameter>.</para>
- </listitem>
- <listitem>
- <para>The data must be sorted.</para>
- </listitem>
- <listitem>
- <para>If <parameter>value</parameter> is smaller than the first value it returns #N/A.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -9853,36 +6717,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MATCH</function>(<parameter>seek</parameter>,<parameter>vector</parameter>[,<parameter>type</parameter>])</synopsis>
+ <synopsis><function>MATCH</function>(<parameter>seek</parameter>,<parameter>vector</parameter>,<parameter>type</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MATCH</function> function finds the row index of <parameter>seek</parameter> in <parameter>vector</parameter> and returns it.</para>
- <para>If the area is longer than it is wide then the sense of the search is rotated. Alternatively a single array can be used.</para>
- <itemizedlist>
- <listitem>
- <para>The <parameter>type</parameter> parameter, which defaults to +1, controls the search:</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> = 1, <function>MATCH</function> finds largest value <= <parameter>seek</parameter>.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> = 0, <function>MATCH</function> finds first value == <parameter>seek</parameter>.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> = -1, <function>MATCH</function> finds smallest value >= <parameter>seek</parameter>.</para>
- </listitem>
- <listitem>
- <para>For <parameter>type</parameter> = 0, the data can be in any order. * For <parameter>type</parameter> = -1 and <parameter>type</parameter> = +1, the data must be sorted. (And in these cases, <function>MATCH</function> uses a binary search to locate the index.)</para>
- </listitem>
- <listitem>
- <para>If <parameter>seek</parameter> could not be found, #N/A is returned.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -9903,23 +6745,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>OFFSET</function>(<parameter>range</parameter>,<parameter>row</parameter>,<parameter>col</parameter>[,<parameter>height</parameter>[,<parameter>width</parameter>]])</synopsis>
+ <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> function returns a cell range. The cell range starts at offset (<parameter>row</parameter>,<parameter>col</parameter>) from <parameter>range</parameter>, and is of height <parameter>height</parameter> and width <parameter>width</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>range</parameter> is neither a reference nor a range, <function>OFFSET</function> returns #VALUE!.</para>
- </listitem>
- <listitem>
- <para>If either <parameter>height</parameter> or <parameter>width</parameter> is omitted, the height or width of the reference is used.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>See also</title>
@@ -9945,19 +6780,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ROW</function>(<parameter/>[reference].)</synopsis>
+ <synopsis><function>ROW</function>(<parameter>x</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ROW</function> function returns a 1xN array containing the series of integers from the first row to the last row of <parameter>reference</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>reference</parameter> defaults to the position of the current expression.</para>
- </listitem>
- <listitem>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
+ <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>See also</title>
@@ -9979,23 +6807,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ROWS</function>(<parameter>reference</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ROWS</function> function returns the number of rows in area or array reference.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>ROWS</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ROWS</function>(H7:I13) equals 7.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COLUMN"><function>COLUMN</function></link>,
@@ -10016,17 +6827,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>TRANSPOSE</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TRANSPOSE</function> function returns the transpose of the input <parameter>matrix</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>.
@@ -10046,23 +6846,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>VLOOKUP</function>(<parameter>value</parameter>,<parameter>range</parameter>,<parameter>column</parameter>[,<parameter>approximate</parameter>,<parameter>as_index</parameter>])</synopsis>
+ <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 range that has a first column similar to <parameter>value</parameter>. If <parameter>approximate</parameter> is not true it finds the row with an exact equivalence. If <parameter>approximate</parameter> is true, then the values must be sorted in order of ascending value for correct function; in this case it finds the row with value less than <parameter>value</parameter>. It returns the value in the row found at a 1-based offset in <parameter>column</parameter> columns into the <parameter>range</parameter>. <parameter>as_index</parameter> returns the 0-based offset that matched rather than the value.</para>
- <itemizedlist>
- <listitem>
- <para><function>VLOOKUP</function> returns #NUM! if <parameter>column</parameter> < 0.</para>
- </listitem>
- <listitem>
- <para><function>VLOOKUP</function> returns #REF! if <parameter>column</parameter> falls outside <parameter>range</parameter>.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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 FALSE</para>
+ <para><parameter>as_index</parameter>: if true, the 0-based row offset is returned; defaults to FALSE</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -10086,22 +6879,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ABS</function>(<parameter>b1</parameter>)</synopsis>
+ <synopsis><function>ABS</function>(<parameter>x</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ABS</function> implements the Absolute Value function: the result is to drop the negative sign (if present). This can be done for integers and floating point numbers.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ABS</function>(7) equals 7.</para>
- <para><function>ABS</function>(-3.14) equals 3.14.</para>
+ <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>
@@ -10125,30 +6908,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ACOS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ACOS</function> function calculates the arc cosine of <parameter>x</parameter>; that is the value whose cosine is <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>The value it returns is in radians.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> falls outside the range -1 to 1, <function>ACOS</function> returns the #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ACOS</function>(0.1) equals 1.470629.</para>
- <para><function>ACOS</function>(-0.1) equals 1.670964.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COS"><function>COS</function></link>,
@@ -10170,27 +6929,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ACOSH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ACOSH</function> function calculates the inverse hyperbolic cosine of <parameter>x</parameter>; that is the value whose hyperbolic cosine is <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is less than 1.0, <function>ACOSH</function>() returns the #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ACOSH</function>(2) equals 1.31696.</para>
- <para><function>ACOSH</function>(5.3) equals 2.35183.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ACOS"><function>ACOS</function></link>,
@@ -10200,6 +6938,44 @@
</para>
</refsect1>
</refentry>
+ <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-COT"><function>COT</function></link>,
+ <link linkend="gnumeric-TAN"><function>TAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <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-COTH"><function>COTH</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-ASIN">
<refmeta>
<refentrytitle>
@@ -10217,26 +6993,12 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ASIN</function> function calculates the arc sine of <parameter>x</parameter>; that is the value whose sine is <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> falls outside the range -1 to 1, <function>ASIN</function> returns the #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ASIN</function>(0.5) equals 0.523599.</para>
- <para><function>ASIN</function>(1) equals 1.570797.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-COS"><function>COS</function></link>,
+ <para><link linkend="gnumeric-SINCOS"><function>SINCOS</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>.
@@ -10260,18 +7022,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ASINH</function> function calculates the inverse hyperbolic sine of <parameter>x</parameter>; that is the value whose hyperbolic sine is <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ASINH</function>(0.5) equals 0.481212.</para>
- <para><function>ASINH</function>(1.0) equals 0.881374.</para>
+ <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>
@@ -10301,21 +7053,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ATAN</function> function calculates the arc tangent of <parameter>x</parameter>; that is the value whose tangent is <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>Return value is in radians.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ATAN</function>(0.5) equals 0,463648.</para>
- <para><function>ATAN</function>(1) equals 0,785398.</para>
+ <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>
@@ -10344,21 +7083,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ATAN2</function> function calculates the arc tangent of the two variables <parameter>b1</parameter> and <parameter>b2</parameter>. It is similar to calculating the arc tangent of <parameter>b2</parameter> / <parameter>b1</parameter>, except that the signs of both arguments are used to determine the quadrant of the result.</para>
- <itemizedlist>
- <listitem>
- <para>The result is in radians.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ATAN2</function>(0.5,1.0) equals 1.107149.</para>
- <para><function>ATAN2</function>(-0.5,2.0) equals 1.815775.</para>
+ <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>
@@ -10388,33 +7115,38 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ATANH</function> function calculates the inverse hyperbolic tangent of <parameter>x</parameter>; that is the value whose hyperbolic tangent is <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If the absolute value of <parameter>x</parameter> is greater than 1.0, <function>ATANH</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ATANH</function>(0.5) equals 0.549306.</para>
- <para><function>ATANH</function>(0.8) equals 1.098612.</para>
+ <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>See also</title>
<para><link linkend="gnumeric-ATAN"><function>ATAN</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</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/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>,
+ <link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-BETA">
<refmeta>
<refentrytitle>
@@ -10428,22 +7160,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BETA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ <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 mathematical beta function extended to all real numbers except 0 and negative integers.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter>, <parameter>b</parameter>, or (<parameter>a</parameter> + <parameter>b</parameter>) are non-positive integers, <function>BETA</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BETA</function>(2,3) equals 0.083333.</para>
- <para><function>BETA</function>(-0.5,0.5) equals #NUM!.</para>
+ <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>See also</title>
@@ -10465,22 +7188,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>BETALN</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
+ <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 beta function.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter>, <parameter>b</parameter>, or (<parameter>a</parameter> + <parameter>b</parameter>) are non-positive integers, <function>BETALN</function> returns #NUM!</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BETALN</function>(2,3) equals -2.48.</para>
- <para><function>BETALN</function>(-0.5,0.5) equals #NUM!.</para>
+ <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>See also</title>
@@ -10506,14 +7220,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CEIL</function> function rounds <parameter>x</parameter> up to the next nearest integer.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CEIL</function>(0.4) equals 1.</para>
- <para><function>CEIL</function>(-1.1) equals -1.</para>
- <para><function>CEIL</function>(-2.9) equals -2.</para>
+ <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>
@@ -10538,28 +7246,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>CEILING</function>(<parameter>x</parameter>[,<parameter>significance</parameter>])</synopsis>
+ <synopsis><function>CEILING</function>(<parameter>x</parameter>,<parameter>significance</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CEILING</function> function rounds <parameter>x</parameter> up to the nearest multiple of <parameter>significance</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> or <parameter>significance</parameter> is non-numeric <function>CEILING</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> and <parameter>significance</parameter> have different signs <function>CEILING</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CEILING</function>(2.43,1) equals 3.</para>
- <para><function>CEILING</function>(123.123,3) equals 126.</para>
+ <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>See also</title>
@@ -10588,29 +7281,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>COMBIN</function> computes the number of combinations.</para>
- <itemizedlist>
- <listitem>
- <para>Performing this function on a non-integer or a negative number returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>n</parameter> is less than <parameter>k</parameter> <function>COMBIN</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COMBIN</function>(8,6) equals 28.</para>
- <para><function>COMBIN</function>(6,2) equals 15.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <para><function>COMBIN</function> returns the binomial coefficient "<parameter>n</parameter> choose <parameter>k</parameter>"</para>
+ <para><parameter>n</parameter>: non-negative integer</para>
+ <para><parameter>k</parameter>: non-negative integer</para>
</refsect1>
</refentry>
<refentry id="gnumeric-COS">
@@ -10625,34 +7298,24 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COS</function> function returns the cosine of <parameter>x</parameter>, where <parameter>x</parameter> is given in radians.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COS</function>(0.5) equals 0.877583.</para>
- <para><function>COS</function>(1) equals 0.540302.</para>
- </refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
+ <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>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>
</refentry>
<refentry id="gnumeric-COSH">
@@ -10667,38 +7330,53 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COSH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
<refsect1>
- <title>Description</title>
- <para><function>COSH</function> function returns the hyperbolic cosine of <parameter>x</parameter>, which is defined mathematically as</para>
- <para> (exp(<parameter>x</parameter>) + exp(-<parameter>x</parameter>)) / 2.</para>
- <itemizedlist>
- <listitem>
- <para><parameter>x</parameter> is in radians.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <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-COT">
+ <refmeta>
+ <refentrytitle>
+ <function>COT</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>COT</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>COSH</function>(0.5) equals 1.127626.</para>
- <para><function>COSH</function>(1) equals 1.543081.</para>
+ <title>See also</title>
+ <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-ACOT"><function>ACOT</function></link>.
+ </para>
</refsect1>
+ </refentry>
+ <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-COS"><function>COS</function></link>,
- <link linkend="gnumeric-SIN"><function>SIN</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</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>,
- <link linkend="gnumeric-EXP"><function>EXP</function></link>.
+ <para><link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <link linkend="gnumeric-ACOTH"><function>ACOTH</function></link>.
</para>
</refsect1>
</refentry>
@@ -10714,31 +7392,63 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COUNTIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>)</synopsis>
- </refsynopsisdiv>
<refsect1>
- <title>Description</title>
- <para><function>COUNTIF</function> function counts the number of cells in the given <parameter>range</parameter> that meet the given <parameter>criteria</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
+ <link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>.
+ </para>
</refsect1>
+ </refentry>
+ <refentry id="gnumeric-CSC">
+ <refmeta>
+ <refentrytitle>
+ <function>CSC</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>CSC</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 23, 27, 28, 33, and 39. Then</para>
- <para><function>COUNTIF</function>(A1:A5,"<=28") equals 3.</para>
- <para><function>COUNTIF</function>(A1:A5,"<28") equals 2.</para>
- <para><function>COUNTIF</function>(A1:A5,"28") equals 1.</para>
- <para><function>COUNTIF</function>(A1:A5,">28") equals 2.</para>
+ <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>
</refsect1>
+ </refentry>
+ <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-COUNT"><function>COUNT</function></link>,
- <link linkend="gnumeric-SUMIF"><function>SUMIF</function></link>.
+ <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>
</refsect1>
</refentry>
@@ -10754,23 +7464,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>DEGREES</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DEGREES</function> computes the number of degrees equivalent to <parameter>x</parameter> radians.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DEGREES</function>(2.5) equals 143.2394.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>,
@@ -10790,24 +7483,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>EVEN</function>(<parameter>number</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EVEN</function> function returns the number rounded up to the nearest even integer. Negative numbers are rounded down.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EVEN</function>(5.4) equals 6.</para>
- <para><function>EVEN</function>(-5.4) equals -6.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ODD"><function>ODD</function></link>.
@@ -10826,23 +7501,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>EXP</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EXP</function> computes the value of e (the base of natural logarithms) raised to the power of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EXP</function>(2) equals 7.389056.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LOG"><function>LOG</function></link>,
@@ -10863,18 +7521,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>EXPM1</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EXPM1</function> computes EXP(<parameter>x</parameter>)-1 with higher resulting precision than the direct formula.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EXPM1</function>(0.01) equals 0.01005.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
@@ -10894,29 +7540,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>FACT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FACT</function> computes the factorial of <parameter>x</parameter>. ie, <parameter>x</parameter>!</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FACT</function>(3) equals 6.</para>
- <para><function>FACT</function>(9) equals 362880.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-FACTDOUBLE">
<refmeta>
@@ -10931,27 +7554,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>FACTDOUBLE</function>(<parameter>number</parameter>)</synopsis>
+ <synopsis><function>FACTDOUBLE</function>(<parameter>area0</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FACTDOUBLE</function> function returns the double factorial of a <parameter>number</parameter>, i.e., x!!.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>number</parameter> is not an integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>number</parameter> is negative <function>FACTDOUBLE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FACTDOUBLE</function>(5) equals 15.</para>
+ <para><function>FACTDOUBLE</function> function returns the double factorial <parameter>x</parameter>!!</para>
+ <para><parameter>area0</parameter>: first cell areax:non-negative integer</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -10972,29 +7580,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>FIB</function>(<parameter>number</parameter>)</synopsis>
+ <synopsis><function>FIB</function>(<parameter>n</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FIB</function> function computes Fibonacci numbers.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>number</parameter> is not an integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>number</parameter> is negative or zero <function>FIB</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FIB</function>(12) equals 144.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <para><function>FIB</function>(<parameter>n</parameter>) is the <parameter>n</parameter>th Fibonacci number.</para>
+ <para><parameter>n</parameter>: positive integer</para>
</refsect1>
</refentry>
<refentry id="gnumeric-FLOOR">
@@ -11014,8 +7605,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FLOOR</function> function rounds <parameter>x</parameter> down to the next nearest multiple of <parameter>significance</parameter>.</para>
- <para><parameter>x</parameter>: value.</para>
+ <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>
@@ -11040,27 +7631,46 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>G_PRODUCT</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
<refsect1>
- <title>Description</title>
- <para><function>G_PRODUCT</function> returns the product of all the values and cells referenced in the argument list.</para>
- <itemizedlist>
- <listitem>
- <para>Empty cells are ignored and the empty product is 1.</para>
- </listitem>
- </itemizedlist>
+ <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/>
+ </refnamediv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>G_PRODUCT</function>(2,5,9) equals 90.</para>
+ <title>See also</title>
+ <para><link linkend="gnumeric-LNGAMMA"><function>LNGAMMA</function></link>.
+ </para>
</refsect1>
+ </refentry>
+ <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-SUM"><function>SUM</function></link>,
- <link linkend="gnumeric-COUNT"><function>COUNT</function></link>.
+ <para><link linkend="gnumeric-GAMMA"><function>GAMMA</function></link>.
</para>
</refsect1>
</refentry>
@@ -11077,32 +7687,36 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>GCD</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>GCD</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>GCD</function> returns the greatest common divisor of given numbers.</para>
- <itemizedlist>
- <listitem>
- <para>If any of the arguments is less than one, <function>GCD</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If any of the arguments is non-integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <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>Examples</title>
- <para/>
- <para><function>GCD</function>(470,770) equals 10.</para>
- <para><function>GCD</function>(470,770,1495) equals 5.</para>
+ <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/>
+ </refnamediv>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-LCM"><function>LCM</function></link>.
+ <para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
</para>
</refsect1>
</refentry>
@@ -11118,18 +7732,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>HYPOT</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>HYPOT</function> returns the square root of the sum of the squares of the arguments.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HYPOT</function>(3,4) equals 5.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
@@ -11149,24 +7751,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>INT</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>INT</function> function returns the largest integer that is not bigger than its argument.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>INT</function>(7.2) equals 7.</para>
- <para><function>INT</function>(-5.5) equals -6.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CEIL"><function>CEIL</function></link>,
@@ -11190,28 +7774,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>LCM</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>LCM</function>(<parameter>n0</parameter>,<parameter>n1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>LCM</function> returns the least common multiple of integers. The least common multiple is the smallest positive number that is a multiple of all integer arguments given.</para>
- <itemizedlist>
- <listitem>
- <para>If any of the arguments is less than one, <function>LCM</function> returns #NUM!.</para>
- </listitem>
- <listitem>
- <para>If any of the arguments is non-integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LCM</function>(2,13) equals 26.</para>
- <para><function>LCM</function>(4,7,5) equals 140.</para>
+ <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 argment.</para>
+ <para><parameter>n0</parameter>: positive integer</para>
+ <para><parameter>n1</parameter>: positive integer</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -11231,26 +7800,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LN</function> returns the natural logarithm of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> <= 0, <function>LN</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LN</function>(7) equals 1.94591.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
@@ -11276,21 +7825,13 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>LN1P</function> computes LN(1+<parameter>x</parameter>) with higher resulting precision than the direct formula.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> <= -1, <function>LN1P</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LN1P</function>(0.01) equals 0.00995.</para>
+ <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>See also</title>
- <para><link linkend="gnumeric-LN"><function>LN</function></link>,
+ <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>
@@ -11307,24 +7848,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOG</function>(<parameter>x</parameter>[,<parameter>base</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOG</function> computes the logarithm of <parameter>x</parameter> in the given base <parameter>base</parameter>. If no <parameter>base</parameter> is given <function>LOG</function> returns the logarithm in base 10. <parameter>base</parameter> must be > 0. and cannot equal 1.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOG</function>(2) equals 0.30103.</para>
- <para><function>LOG</function>(8192,2) equals 13.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LN"><function>LN</function></link>,
@@ -11345,26 +7868,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOG10</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOG10</function> computes the base-10 logarithm of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> <= 0, <function>LOG10</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOG10</function>(7) equals 0.845098.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
@@ -11385,23 +7888,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOG2</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOG2</function> computes the base-2 logarithm of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> <= 0, <function>LOG2</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOG2</function>(1024) equals 10.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
@@ -11422,27 +7908,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MDETERM</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MDETERM</function> function returns the determinant of a given matrix.</para>
- <itemizedlist>
- <listitem>
- <para>If the <parameter>matrix</parameter> does not contain equal number of columns and rows, <function>MDETERM</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that A1, ..., A4 contain numbers 2, 3, 7, and 3, B1, ..., B4 4, 2, 4, and 1, C1, ..., C4 9, 4, 3, and 2, and D1, ..., D4 7, 3, 6, and 5. Then</para>
- <para><function>MDETERM</function>(A1:D4) equals 148.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
@@ -11462,28 +7927,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MINVERSE</function>(<parameter>matrix</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MINVERSE</function> function returns the inverse matrix of <parameter>matrix</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>matrix</parameter> cannot be inverted, <function>MINVERSE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>matrix</parameter> does not contain equal number of columns and rows, <function>MINVERSE</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MMULT"><function>MMULT</function></link>,
@@ -11503,22 +7946,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MMULT</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MMULT</function> function returns the matrix product of two arrays. The result is an array with the same number of rows as <parameter>array1</parameter> and the same number of columns as <parameter>array2</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-TRANSPOSE"><function>TRANSPOSE</function></link>,
@@ -11539,24 +7966,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MOD</function>(<parameter>number</parameter>,<parameter>divisor</parameter>)</synopsis>
+ <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>divisor</parameter> is divided into <parameter>number</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para><function>MOD</function> returns #DIV/0! if <parameter>divisor</parameter> is zero.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>MOD</function>(23,7) equals 2.</para>
+ <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>See also</title>
@@ -11581,28 +7997,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MROUND</function>(<parameter>number</parameter>,<parameter>multiple</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MROUND</function> function rounds a given number to the desired multiple.</para>
- <para><parameter>number</parameter> is the number you want rounded and <parameter>multiple</parameter> is the the multiple to which you want to round the number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>number</parameter> and <parameter>multiple</parameter> have different sign, <function>MROUND</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>MROUND</function>(1.7,0.2) equals 1.8.</para>
- <para><function>MROUND</function>(321.123,0.12) equals 321.12.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
@@ -11623,26 +8017,10 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MULTINOMIAL</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MULTINOMIAL</function> returns the ratio of the factorial of a sum of values to the product of factorials.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>MULTINOMIAL</function>(2,3,4) equals 1260.</para>
- </refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ <para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>,
+ <link linkend="gnumeric-SUM"><function>SUM</function></link>.
</para>
</refsect1>
</refentry>
@@ -11658,24 +8036,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ODD</function>(<parameter>number</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ODD</function> function returns the <parameter>number</parameter> rounded up to the nearest odd integer. Negative numbers are rounded down.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ODD</function>(4.4) equals 5.</para>
- <para><function>ODD</function>(-4.4) equals -5.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EVEN"><function>EVEN</function></link>.
@@ -11694,26 +8054,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PI</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PI</function> functions returns the value of pi.</para>
- <itemizedlist>
- <listitem>
- <para>This function is called with no arguments.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible, except that it returns pi with a better precision.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>PI</function>() equals about 3.141593.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-SQRTPI"><function>SQRTPI</function></link>.
@@ -11732,33 +8072,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>POWER</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>POWER</function> returns the value of <parameter>x</parameter> raised to the power <parameter>y</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If both <parameter>x</parameter> and <parameter>y</parameter> equal 0, <function>POWER</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> = 0 and <parameter>y</parameter> < 0, <function>POWER</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> < 0 and <parameter>y</parameter> is non-integer, <function>POWER</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>POWER</function>(2,7) equals 128.</para>
- <para><function>POWER</function>(3,3.141) equals 31.523749.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXP"><function>EXP</function></link>.
@@ -11778,21 +8091,12 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>PRODUCT</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/> ...)</synopsis>
+ <synopsis><function>PRODUCT</function>(<parameter>values</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>PRODUCT</function> returns the product of all the values and cells referenced in the argument list.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible. In particular, this means that if all cells are empty, the result will be 0.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>PRODUCT</function>(2,5,9) equals 90.</para>
+ <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>See also</title>
@@ -11819,17 +8123,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>QUOTIENT</function> function returns the integer portion of a division. <parameter>numerator</parameter> is the divided number and <parameter>denominator</parameter> is the divisor.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>QUOTIENT</function>(23,5) equals 4.</para>
+ <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>
@@ -11849,23 +8146,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RADIANS</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RADIANS</function> computes the number of radians equivalent to <parameter>x</parameter> degrees.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RADIANS</function>(180) equals 3.14159.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-PI"><function>PI</function></link>,
@@ -11886,39 +8166,15 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ROMAN</function>(<parameter>number</parameter>[,<parameter>type</parameter>])</synopsis>
+ <synopsis><function>ROMAN</function>(<parameter>n</parameter>,<parameter>type</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ROMAN</function> function returns an arabic number in the roman numeral style, as text. <parameter>number</parameter> is the number you want to convert and <parameter>type</parameter> is the type of roman numeral you want.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>type</parameter> is 0 or it is omitted, <function>ROMAN</function> returns classic roman numbers.</para>
- </listitem>
- <listitem>
- <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 simplified type.</para>
- </listitem>
- <listitem>
- <para>If <parameter>number</parameter> is negative or greater than 3999, <function>ROMAN</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ROMAN</function>(999) equals CMXCIX.</para>
- <para><function>ROMAN</function>(999,1) equals LMVLIV.</para>
- <para><function>ROMAN</function>(999,2) equals XMIX.</para>
- <para><function>ROMAN</function>(999,3) equals VMIV.</para>
- <para><function>ROMAN</function>(999,4) equals IM.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <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">
@@ -11934,34 +8190,15 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ROUND</function>(<parameter>number</parameter>[,<parameter>digits</parameter>])</synopsis>
+ <synopsis><function>ROUND</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ROUND</function> function rounds a given number.</para>
- <para><parameter>number</parameter> is the number you want rounded and <parameter>digits</parameter> is the number of digits to which you want to round that number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>digits</parameter> is greater than zero, <parameter>number</parameter> is rounded to the given number of digits.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is zero or omitted, <parameter>number</parameter> is rounded to the nearest integer.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is less than zero, <parameter>number</parameter> is rounded to the left of the decimal point.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ROUND</function>(5.5) equals 6.</para>
- <para><function>ROUND</function>(-3.3) equals -3.</para>
- <para><function>ROUND</function>(1501.15,1) equals 1501.2.</para>
- <para><function>ROUND</function>(1501.15,-2) equals 1500.0.</para>
+ <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>
@@ -11983,34 +8220,15 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ROUNDDOWN</function>(<parameter>number</parameter>[,<parameter>digits</parameter>])</synopsis>
+ <synopsis><function>ROUNDDOWN</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ROUNDDOWN</function> function rounds a given <parameter>number</parameter> towards 0.</para>
- <para><parameter>number</parameter> is the number you want rounded toward 0 and <parameter>digits</parameter> is the number of digits to which you want to round that number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>digits</parameter> is greater than zero, <parameter>number</parameter> is rounded toward 0 to the given number of digits.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is zero or omitted, <parameter>number</parameter> is rounded toward 0 to the next integer.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is less than zero, <parameter>number</parameter> is rounded toward 0 to the left of the decimal point.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ROUNDDOWN</function>(5.5) equals 5.</para>
- <para><function>ROUNDDOWN</function>(-3.3) equals -3.</para>
- <para><function>ROUNDDOWN</function>(1501.15,1) equals 1501.1.</para>
- <para><function>ROUNDDOWN</function>(1501.15,-2) equals 1500.0.</para>
+ <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>
@@ -12032,72 +8250,89 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ROUNDUP</function>(<parameter>number</parameter>[,<parameter>digits</parameter>])</synopsis>
+ <synopsis><function>ROUNDUP</function>(<parameter>x</parameter>,<parameter>d</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ROUNDUP</function> function rounds a given number away from 0.</para>
- <para><parameter>number</parameter> is the number you want rounded away from 0 and <parameter>digits</parameter> is the number of digits to which you want to round that number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>digits</parameter> is greater than zero, <parameter>number</parameter> is rounded away from 0 to the given number of digits.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is zero or omitted, <parameter>number</parameter> is rounded away from 0 to the next integer.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is less than zero, <parameter>number</parameter> is rounded away from 0 to the left of the decimal point.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>ROUNDUP</function>(5.5) equals 6.</para>
- <para><function>ROUNDUP</function>(-3.3) equals -4.</para>
- <para><function>ROUNDUP</function>(1501.15,1) equals 1501.2.</para>
- <para><function>ROUNDUP</function>(1501.15,-2) equals 1600.0.</para>
+ <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-ROUNDDOWN"><function>ROUNDDOWN</function></link>,
+ <link linkend="gnumeric-INT"><function>INT</function></link>.
</para>
</refsect1>
</refentry>
- <refentry id="gnumeric-SERIESSUM">
+ <refentry id="gnumeric-SEC">
<refmeta>
<refentrytitle>
- <function>SERIESSUM</function>
+ <function>SEC</function>
</refentrytitle>
</refmeta>
<refnamediv>
<refname>
- <function>SERIESSUM</function>
+ <function>SEC</function>
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SERIESSUM</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>m</parameter>,<parameter>coefficients</parameter>)</synopsis>
- </refsynopsisdiv>
<refsect1>
- <title>Description</title>
- <para><function>SERIESSUM</function> function returns the sum of a power series. <parameter>x</parameter> is the base of the power series, <parameter>n</parameter> is the initial power to raise <parameter>x</parameter>, <parameter>m</parameter> is the increment to the power for each term in the series, and <parameter>coefficients</parameter> are the coefficients by which each successive power of <parameter>x</parameter> is multiplied.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <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>
</refsect1>
+ </refentry>
+ <refentry id="gnumeric-SECH">
+ <refmeta>
+ <refentrytitle>
+ <function>SECH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SECH</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 1.23, 2.32, 2.98, 3.42, and 4.33. Then</para>
- <para><function>SERIESSUM</function>(3,1,2.23,A1:A5) equals 251416.43018.</para>
+ <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>
</refsect1>
+ </refentry>
+ <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-COUNT"><function>COUNT</function></link>,
@@ -12118,27 +8353,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SIGN</function>(<parameter>number</parameter>)</synopsis>
+ <synopsis><function>SIGN</function>(<parameter>x</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SIGN</function> function returns 1 if the <parameter>number</parameter> is positive, zero if the <parameter>number</parameter> is 0, and -1 if the <parameter>number</parameter> is negative.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SIGN</function>(3) equals 1.</para>
- <para><function>SIGN</function>(-3) equals -1.</para>
- <para><function>SIGN</function>(0) equals 0.</para>
+ <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>
+ <para><link linkend="gnumeric-ABS"><function>ABS</function></link>.
</para>
</refsect1>
</refentry>
@@ -12154,29 +8378,14 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SIN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SIN</function> function returns the sine of <parameter>x</parameter>, where <parameter>x</parameter> is given in radians.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SIN</function>(0.5) equals 0.479426.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COS"><function>COS</function></link>,
- <link linkend="gnumeric-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-SINH"><function>SINH</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>.
@@ -12195,34 +8404,12 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SINH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SINH</function> function returns the hyperbolic sine of <parameter>x</parameter>, which is defined mathematically as</para>
- <para> (exp(<parameter>x</parameter>) - exp(-<parameter>x</parameter>)) / 2.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SINH</function>(0.5) equals 0.521095.</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-COSH"><function>COSH</function></link>,
- <link linkend="gnumeric-TAN"><function>TAN</function></link>,
- <link linkend="gnumeric-TANH"><function>TANH</function></link>,
+ <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>,
- <link linkend="gnumeric-EXP"><function>EXP</function></link>.
+ <link linkend="gnumeric-RADIANS"><function>RADIANS</function></link>.
</para>
</refsect1>
</refentry>
@@ -12238,26 +8425,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SQRT</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SQRT</function> function returns the square root of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is negative, <function>SQRT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SQRT</function>(2) equals 1.4142136.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-POWER"><function>POWER</function></link>.
@@ -12276,58 +8443,31 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SQRTPI</function>(<parameter>number</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SQRTPI</function> function returns the square root of a <parameter>number</parameter> multiplied by pi.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SQRTPI</function>(2) equals 2.506628275.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-PI"><function>PI</function></link>.
</para>
</refsect1>
</refentry>
- <refentry id="gnumeric-SUM">
+ <refentry id="gnumeric-Sum">
<refmeta>
<refentrytitle>
- <function>SUM</function>
+ <function>Sum</function>
</refentrytitle>
</refmeta>
<refnamediv>
<refname>
- <function>SUM</function>
+ <function>Sum</function>
</refname>
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SUM</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/> ...)</synopsis>
+ <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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11, 15, 17, 21, and 43. Then</para>
- <para><function>SUM</function>(A1:A5) equals 107.</para>
+ <para>SUM 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>
@@ -12349,17 +8489,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SUMA</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/> ...)</synopsis>
+ <synopsis><function>SUMA</function>(<parameter>area0</parameter>,<parameter>area1</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SUMA</function> computes the sum of all the values and cells referenced in the argument list. 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>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11, 15, 17, 21, and 43. Then</para>
- <para><function>SUMA</function>(A1:A5) equals 107.</para>
+ <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>
@@ -12381,31 +8517,10 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SUMIF</function>(<parameter>range</parameter>,<parameter>criteria</parameter>[,<parameter>actual_range</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUMIF</function> function sums the values in the given <parameter>range</parameter> that meet the given <parameter>criteria</parameter>. If <parameter>actual_range</parameter> is given, <function>SUMIF</function> sums the values in the <parameter>actual_range</parameter> whose corresponding components in <parameter>range</parameter> meet the given <parameter>criteria</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 23, 27, 28, 33, and 39. Then</para>
- <para><function>SUMIF</function>(A1:A5,"<=28") equals 78.</para>
- <para><function>SUMIF</function>(A1:A5,"<28") equals 50.</para>
- <para>In addition, if the cells B1, B2, ..., B5 hold numbers 5, 3, 2, 6, and 7 then:</para>
- <para><function>SUMIF</function>(A1:A5,"<=27",B1:B5) equals 8.</para>
- </refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>,
- <link linkend="gnumeric-SUM"><function>SUM</function></link>.
+ <para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
+ <link linkend="gnumeric-COUNTIF"><function>COUNTIF</function></link>.
</para>
</refsect1>
</refentry>
@@ -12448,24 +8563,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SUMSQ</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUMSQ</function> returns the sum of the squares of all the values and cells referenced in the argument list.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11, 15, 17, 21, and 43. Then</para>
- <para><function>SUMSQ</function>(A1:A5) equals 2925.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
@@ -12486,28 +8583,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SUMX2MY2</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ <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. <parameter>array1</parameter> is the first array or range of data points and <parameter>array2</parameter> is the second array or range of data points. The equation of <function>SUMX2MY2</function> is SUM (x^2-y^2).</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If <parameter>array1</parameter> and <parameter>array2</parameter> have different number of data points, <function>SUMX2MY2</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11, 15, 17, 21, and 43 and the cells B1, B2, ..., B5 hold numbers 13, 22, 31, 33, and 39. Then</para>
- <para><function>SUMX2MY2</function>(A1:A5,B1:B5) equals -1299.</para>
+ <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>
@@ -12529,28 +8611,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SUMX2PY2</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ <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. <parameter>array1</parameter> is the first array or range of data points and <parameter>array2</parameter> is the second array or range of data points. The equation of <function>SUMX2PY2</function> is SUM (x^2+y^2).</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If <parameter>array1</parameter> and <parameter>array2</parameter> have different number of data points, <function>SUMX2PY2</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11, 15, 17, 21, and 43 and the cells B1, B2, ..., B5 hold numbers 13, 22, 31, 33, and 39. Then</para>
- <para><function>SUMX2PY2</function>(A1:A5,B1:B5) equals 7149.</para>
+ <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>See also</title>
@@ -12572,28 +8639,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SUMXMY2</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
+ <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 squares of differences of corresponding values in two arrays. <parameter>array1</parameter> is the first array or range of data points and <parameter>array2</parameter> is the second array or range of data points. The equation of <function>SUMXMY2</function> is SUM (x-y)^2.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If <parameter>array1</parameter> and <parameter>array2</parameter> have different number of data points, <function>SUMXMY2</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11, 15, 17, 21, and 43 and the cells B1, B2, ..., B5 hold numbers 13, 22, 31, 33, and 39. Then</para>
- <para><function>SUMXMY2</function>(A1:A5,B1:B5) equals 409.</para>
+ <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>See also</title>
@@ -12615,23 +8667,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>TAN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TAN</function> function returns the tangent of <parameter>x</parameter>, where <parameter>x</parameter> is given in radians.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TAN</function>(3) equals -0.1425465.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-TANH"><function>TANH</function></link>,
@@ -12656,24 +8691,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>TANH</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TANH</function> function returns the hyperbolic tangent of <parameter>x</parameter>, which is defined mathematically as</para>
- <para> sinh(<parameter>x</parameter>) / cosh(<parameter>x</parameter>).</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TANH</function>(2) equals 0.96402758.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-TAN"><function>TAN</function></link>,
@@ -12698,30 +8715,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>TRUNC</function>(<parameter>number</parameter>[,<parameter>digits</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TRUNC</function> function returns the value of <parameter>number</parameter> truncated to the number of digits specified.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>digits</parameter> is omitted or negative then <parameter>digits</parameter> defaults to zero.</para>
- </listitem>
- <listitem>
- <para>If <parameter>digits</parameter> is not an integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TRUNC</function>(3.12) equals 3.</para>
- <para><function>TRUNC</function>(4.15,1) equals 4.1.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-INT"><function>INT</function></link>.
@@ -12744,20 +8737,16 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ISPRIME</function>(<parameter>i</parameter>)</synopsis>
+ <synopsis><function>ISPRIME</function>(<parameter>n</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ISPRIME</function> function returns TRUE if <parameter>i</parameter> is prime and FALSE otherwise.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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-ITHPRIME"><function>ITHPRIME</function></link>,
- <link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
+ <para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
<link linkend="gnumeric-NT_SIGMA"><function>NT_SIGMA</function></link>.
</para>
</refsect1>
@@ -12779,11 +8768,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ITHPRIME</function> function returns the <parameter>ith</parameter> prime.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -12809,11 +8795,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>NT_D</function> function calculates the number of divisors of <parameter>n</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -12840,26 +8823,15 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>NT_MU</function> function (Möbius mu function) returns</para>
- <para>0 if <parameter>n</parameter> is divisible by the square of a prime .</para>
- <para>Otherwise it returns:</para>
- <para> -1 if <parameter>n</parameter> has an odd number of different prime factors .</para>
- <para> 1 if <parameter>n</parameter> has an even number of different prime factors .</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>n</parameter> = 1 <function>NT_MU</function> returns 1.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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-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><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>
@@ -12875,17 +8847,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>NT_PHI</function>(<parameter>n</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NT_PHI</function> function calculates the number of integers less than or equal to <parameter>n</parameter> that are relatively prime to <parameter>n</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NT_D"><function>NT_D</function></link>,
@@ -12911,11 +8872,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>NT_PI</function> function returns the number of primes less than or equal to <parameter>n</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -12943,11 +8901,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>NT_SIGMA</function> function calculates the sum of the divisors of <parameter>n</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -12974,12 +8929,8 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>PFACTOR</function> function returns the smallest prime factor of its argument.</para>
- <para>The argument must be at least 2, or else a #VALUE! error is returned.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <para><function>PFACTOR</function> finds the smallest prime factor of its argument.</para>
+ <para><parameter>n</parameter>: positive integer</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -13002,23 +8953,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RAND</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RAND</function> returns a random number between zero and one.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RAND</function>() returns a random number greater than zero but less than one.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>.
@@ -13037,23 +8971,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDBERNOULLI</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDBERNOULLI</function> returns a Bernoulli-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDBERNOULLI</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDBERNOULLI</function>(0.5).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13073,18 +8990,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDBETA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDBETA</function> returns a Beta-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDBETA</function>(1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13104,32 +9009,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDBETWEEN</function>(<parameter>bottom</parameter>,<parameter>top</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDBETWEEN</function> function returns a random integer number between and including <parameter>bottom</parameter> and <parameter>top</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>bottom</parameter> is non-integer, it is rounded up.</para>
- </listitem>
- <listitem>
- <para>If <parameter>top</parameter> is non-integer, it is rounded down.</para>
- </listitem>
- <listitem>
- <para>If <parameter>bottom</parameter> > <parameter>top</parameter>, <function>RANDBETWEEN</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDBETWEEN</function>(3,7).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13149,26 +9028,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDBINOM</function>(<parameter>p</parameter>,<parameter>trials</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDBINOM</function> returns a binomially-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDBINOM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>trials</parameter> < 0 <function>RANDBINOM</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDBINOM</function>(0.5,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13188,23 +9047,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDCAUCHY</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDCAUCHY</function> returns a Cauchy-distributed random number with scale parameter a. The Cauchy distribution is also known as the Lorentz distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter> < 0 <function>RANDCAUCHY</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDCAUCHY</function>(1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13223,18 +9065,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDCHISQ</function>(<parameter>nu</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDCHISQ</function> returns a Chi-Square-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDCHISQ</function>(0.5).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13255,30 +9085,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>RANDDISCRETE</function>(<parameter>val_range</parameter>[,<parameter>prob_range</parameter>])</synopsis>
+ <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>
- <itemizedlist>
- <listitem>
- <para>If <parameter>prob_range</parameter> is omitted, the uniform discrete distribution is assumed.</para>
- </listitem>
- <listitem>
- <para>If the sum of all values in <parameter>prob_range</parameter> is other than one, <function>RANDDISCRETE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>val_range</parameter> and <parameter>prob_range</parameter> are not the same size, <function>RANDDISCRETE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>val_range</parameter> or <parameter>prob_range</parameter> is not a range, <function>RANDDISCRETE</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDDISCRETE</function>(A1:A6) returns one of the values in the range A1:A6.</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>See also</title>
@@ -13299,18 +9112,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDEXP</function>(<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDEXP</function> returns a exponentially-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDEXP</function>(0.5).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13335,21 +9136,18 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>RANDEXPPOW</function> returns a random variate from the exponential power distribution with scale parameter <parameter>a</parameter> and exponent <parameter>b</parameter>. The distribution is,</para>
- <para> p(x) dx = {1 over 2 a Gamma(1+1/b)} exp(-|x/a|^b) dx, for x >= 0.</para>
- <itemizedlist>
- <listitem>
- <para>For <parameter>b</parameter> = 1 this reduces to the Laplace distribution.</para>
- </listitem>
- <listitem>
- <para>For <parameter>b</parameter> = 2 it has the same form as a normal distribution with sigma = a/sqrt(2).</para>
- </listitem>
- </itemizedlist>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>RANDEXPPOW</function>(<parameter>a</parameter>,<parameter>b</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDEXPPOW</function>(0.5,0.1).</para>
+ <title>Description</title>
+ <para>For <parameter>b</parameter> = 2 the exponential power distribution reduces to the normal distribution with Ï? = a/sqrt(2)</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>See also</title>
@@ -13369,18 +9167,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDFDIST</function>(<parameter>nu1</parameter>,<parameter>nu2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDFDIST</function> returns a F-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDFDIST</function>(1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13400,23 +9186,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDGAMMA</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDGAMMA</function> returns a Gamma-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter> <= 0 <function>RANDGAMMA</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDGAMMA</function>(1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13435,24 +9204,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDGEOM</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDGEOM</function> returns a geometric-distributed random number. The number of independent trials with probability <parameter>p</parameter> until the first success. The probability distribution for geometric variates is,</para>
- <para> p(k) = p (1-p)^(k-1), for k >= 1.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDGEOM</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDGEOM</function>(0.4).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13471,26 +9222,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDGUMBEL</function>(<parameter>a</parameter>,<parameter>b</parameter>[,<parameter>type</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDGUMBEL</function> returns a Type I or Type II Gumbel-distributed random number. <parameter>type</parameter> is either 1 or 2 and specifies the type of the distribution (Type I or Type II).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>type</parameter> is neither 1 nor 2, <function>RANDGUMBEL</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> is omitted, Type I is assumed.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDGUMBEL</function>(0.5,1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13509,21 +9240,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDHYPERG</function>(<parameter>n1</parameter>,<parameter>n2</parameter>,<parameter>t</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDHYPERG</function> returns a hypergeometric-distributed random number. The probability distribution for hypergeometric random variates is,</para>
- <para> p(k) = C(n_1,k) C(n_2, t-k) / C(n_1 + n_2,k),</para>
- <para>where C(a,b) = a!/(b!(a-b)!).</para>
- <para>The domain of k is max(0,t-n_2), ..., max(t,n_1).</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDHYPERG</function>(21,1,9).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13542,21 +9258,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDLANDAU</function>(<parameter/>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDLANDAU</function> returns a random variate from the Landau distribution. The probability distribution for Landau random variates is defined analytically by the complex integral,</para>
- <para> p(x) = (1/(2 pi i)) int_{c-i infty}^{c+i infty} ds exp(s log(s) + x s).</para>
- <para>For numerical purposes it is more convenient to use the following equivalent form of the integral,</para>
- <para> p(x) = (1/pi) int_0^ infty dt exp(-t log(t) - x t) sin(pi t).</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDLANDAU</function>().</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13575,18 +9276,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDLAPLACE</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDLAPLACE</function> returns a Laplace-distributed random number. Laplace distribution is also known as two-sided exponential probability distribution.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDLAPLACE</function>(1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13606,30 +9295,24 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>RANDLEVY</function>(<parameter>c</parameter>,<parameter>alpha</parameter>[,<parameter>beta</parameter>])</synopsis>
+ <synopsis><function>RANDLEVY</function>(<parameter>c</parameter>,<parameter/>α,<parameter/>β)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>RANDLEVY</function> returns a Levy-distributed random number. If <parameter>beta</parameter> is omitted, it is assumed to be 0.</para>
- <itemizedlist>
- <listitem>
- <para>For <parameter>alpha</parameter> = 1, <parameter>beta</parameter>=0, we get the Lorentz distribution.</para>
- </listitem>
- <listitem>
- <para>For <parameter>alpha</parameter> = 2, <parameter>beta</parameter>=0, we get the normal distribution.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>alpha</parameter> > 2, <function>RANDLEVY</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>beta</parameter> < -1 or <parameter>beta</parameter> > 1, <function>RANDLEVY</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>RANDLEVY</function>(<parameter>c</parameter>,<parameter/>α,<parameter/>β))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDLEVY</function>(0.5,0.1,1).</para>
+ <title>Description</title>
+ <para>For @{α} = 2, @{β}=0, the Lévy distribution reduces to the normal 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>See also</title>
@@ -13649,23 +9332,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDLOG</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDLOG</function> returns a logarithmic-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>RANDLOG</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDLOG</function>(0.72).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13684,19 +9350,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDLOGISTIC</function>(<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDLOGISTIC</function> returns a logistic-distributed random number. The distribution function is,</para>
- <para> p(x) dx = { exp(-x/a) over a (1 + exp(-x/a))^2 } dx for -infty < x < +infty.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDLOGISTIC</function>(1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13715,18 +9368,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDLOGNORM</function>(<parameter>zeta</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDLOGNORM</function> returns a lognormal-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDLOGNORM</function>(1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13745,26 +9386,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDNEGBINOM</function>(<parameter>p</parameter>,<parameter>failures</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDNEGBINOM</function> returns a negative binomially-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1, <function>RANDNEGBINOM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>failures</parameter> < 1, <function>RANDNEGBINOM</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDNEGBINOM</function>(0.5,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13784,23 +9405,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDNORM</function>(<parameter>mean</parameter>,<parameter>stdev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDNORM</function> returns a normal-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>stdev</parameter> < 0 <function>RANDNORM</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDNORM</function>(0,1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13819,21 +9423,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDNORMTAIL</function>(<parameter>a</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDNORMTAIL</function> returns a random variates from the upper tail of a normal distribution with standard deviation <parameter>sigma</parameter>. The values returned are larger than the lower limit <parameter>a</parameter>, which must be positive. 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>
- <para>The probability distribution for normal tail random variates is,</para>
- <para> p(x) dx = {1 over N(a;sigma)} exp (- x^2/(2 sigma^2)) dx,</para>
- <para>for x > a where N(a;sigma) is the normalization constant, N(a;sigma) = (1/2) erfc(a / sqrt(2 sigma^2)).</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDNORMTAIL</function>(0.5,0.1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13852,18 +9441,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDPARETO</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDPARETO</function> returns a Pareto-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDPARETO</function>(1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13882,23 +9459,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDPOISSON</function>(<parameter>lambda</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDPOISSON</function> returns a Poisson-distributed random number.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>lambda</parameter> < 0 <function>RANDPOISSON</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDPOISSON</function>(3).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13918,18 +9478,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDRAYLEIGH</function>(<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDRAYLEIGH</function> returns a Rayleigh-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDRAYLEIGH</function>(1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -13948,20 +9496,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDRAYLEIGHTAIL</function>(<parameter>a</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDRAYLEIGHTAIL</function> returns a random variate from the tail of the Rayleigh distribution with scale parameter sigma and a lower limit of a. The distribution is,</para>
- <para> p(x) dx = {x over sigma^2} exp ((a^2 - x^2) /(2 sigma^2)) dx,</para>
- <para>for x > a.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDRAYLEIGHTAIL</function>(0.3,1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>,
@@ -13981,18 +9515,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDTDIST</function>(<parameter>nu</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDTDIST</function> returns a T-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDTDIST</function>(0.5).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -14011,25 +9533,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDUNIFORM</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDUNIFORM</function> returns a random variate from the uniform (flat) distribution from a to b. The distribution is,</para>
- <para> p(x) dx = {1 over (b-a)} dx : for a <= x < b.</para>
- <para>p(x) dx = 0 : for x < a or b <= x.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter> > <parameter>b</parameter> <function>RANDUNIFORM</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDUNIFORM</function>(1.4,4.2) returns a random number greater than or equal to 1.4 but less than 4.2.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDBETWEEN"><function>RANDBETWEEN</function></link>,
@@ -14049,18 +9552,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANDWEIBULL</function>(<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANDWEIBULL</function> returns a Weibull-distributed random number.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RANDWEIBULL</function>(1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RAND"><function>RAND</function></link>.
@@ -14080,24 +9571,15 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SIMTABLE</function>(<parameter>d1</parameter>,<parameter/> d2,<parameter/> ...,<parameter/> dN)</synopsis>
+ <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>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SIMTABLE</function>(TRUE,FALSE) returns TRUE on the first simulation round and FALSE on the second round.</para>
- <para><function>SIMTABLE</function>(223,225,227,229) returns 227 on the simulation round #3.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
+ <para><parameter>d1</parameter>: first value</para>
+ <para><parameter>d2</parameter>: second value</para>
</refsect1>
</refentry>
</sect1>
@@ -14115,24 +9597,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>AVEDEV</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>AVEDEV</function> returns the average of the absolute deviations of a data set from their mean.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>AVEDEV</function>(A1:A5) equals 7.84.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>.
@@ -14151,24 +9615,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>AVERAGE</function>(<parameter>value1</parameter>,<parameter/> value2,<parameter/>...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>AVERAGE</function> computes the average of all the values and cells referenced in the argument list. This is equivalent to the sum of the arguments divided by the count of the arguments.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>AVERAGE</function>(A1:A5) equals 23.2.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-SUM"><function>SUM</function></link>,
@@ -14189,22 +9635,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>AVERAGEA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>AVERAGEA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>AVERAGEA</function> returns the average of the given arguments. 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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>AVERAGEA</function>(A1:A5) equals 18.94.</para>
+ <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>
@@ -14224,26 +9661,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>BERNOULLI</function>(<parameter>k</parameter>,<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>BERNOULLI</function> returns the probability p(k) of obtaining <parameter>k</parameter> from a Bernoulli distribution with probability parameter <parameter>p</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>k</parameter> != 0 and <parameter>k</parameter> != 1 <function>BERNOULLI</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>BERNOULLI</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BERNOULLI</function>(0,0.5).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDBERNOULLI"><function>RANDBERNOULLI</function></link>.
@@ -14262,38 +9679,6 @@
</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><function>BETADIST</function> function returns the cumulative beta distribution. <parameter>a</parameter> is the optional lower bound of <parameter>x</parameter> and <parameter>b</parameter> is the optional upper bound of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter> is not given, <function>BETADIST</function> uses 0.</para>
- </listitem>
- <listitem>
- <para>If <parameter>b</parameter> is not given, <function>BETADIST</function> uses 1.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> < <parameter>a</parameter> or <parameter>x</parameter> > <parameter>b</parameter> <function>BETADIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, <function>BETADIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>a</parameter> >= <parameter>b</parameter> <function>BETADIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BETADIST</function>(0.12,2,3) equals 0.07319808.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BETAINV"><function>BETAINV</function></link>.
@@ -14312,38 +9697,6 @@
</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><function>BETAINV</function> function returns the inverse of cumulative beta distribution. <parameter>a</parameter> is the optional lower bound of <parameter>x</parameter> and <parameter>b</parameter> is the optional upper bound of <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter> is not given, <function>BETAINV</function> uses 0.</para>
- </listitem>
- <listitem>
- <para>If <parameter>b</parameter> is not given, <function>BETAINV</function> uses 1.</para>
- </listitem>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>BETAINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, <function>BETAINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>a</parameter> >= <parameter>b</parameter> <function>BETAINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BETAINV</function>(0.45,1.6,1) equals 0.607096629.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BETADIST"><function>BETADIST</function></link>.
@@ -14362,35 +9715,6 @@
</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><function>BINOMDIST</function> function returns the binomial distribution. <parameter>n</parameter> is the number of successes, <parameter>trials</parameter> is the total number of independent trials, <parameter>p</parameter> is the probability of success in trials, and <parameter>cumulative</parameter> describes whether to return the sum of the binomial function from 0 to <parameter>n</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>n</parameter> or <parameter>trials</parameter> are non-integer they are truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>n</parameter> < 0 or <parameter>trials</parameter> < 0 <function>BINOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>n</parameter> > <parameter>trials</parameter> <function>BINOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>BINOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>BINOMDIST</function>(3,5,0.8,0) equals 0.2048.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
@@ -14409,26 +9733,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CAUCHY</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>cum</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CAUCHY</function> returns the Cauchy distribution with scale parameter <parameter>a</parameter>. If <parameter>cum</parameter> is TRUE, <function>CAUCHY</function> returns the cumulative distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>a</parameter> < 0 <function>CAUCHY</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>cum</parameter> != TRUE and <parameter>cum</parameter> != FALSE <function>CAUCHY</function> returns #VALUE! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CAUCHY</function>(0.43,1,TRUE) returns 0.370735.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDCAUCHY"><function>RANDCAUCHY</function></link>.
@@ -14452,23 +9756,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CHIDIST</function> function returns the one-tailed probability of the chi-squared distribution. <parameter>dof</parameter> is the number of degrees of freedom.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>dof</parameter> is non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>dof</parameter> < 1 <function>CHIDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CHIDIST</function>(5.3,2) equals 0.070651213.</para>
+ <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>See also</title>
@@ -14494,20 +9784,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CHIINV</function> function returns the inverse of the one-tailed probability of the chi-squared distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>dof</parameter> < 1 <function>CHIINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CHIINV</function>(0.98,7) equals 1.564293004.</para>
+ <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>See also</title>
@@ -14528,23 +9807,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CHITEST</function>(<parameter>actual_range</parameter>,<parameter>theoretical_range</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CHITEST</function> function returns the test for independence of chi-squared distribution.</para>
- <para><parameter>actual_range</parameter> is a range that contains the observed data points. <parameter>theoretical_range</parameter> is a range that contains the expected values of the data points.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CHIDIST"><function>CHIDIST</function></link>,
@@ -14564,32 +9826,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CONFIDENCE</function>(<parameter>x</parameter>,<parameter>stddev</parameter>,<parameter>size</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CONFIDENCE</function> function returns the confidence interval for a mean. <parameter>x</parameter> is the significance level, <parameter>stddev</parameter> is the population standard deviation, and <parameter>size</parameter> is the size of the sample.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>size</parameter> is non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>size</parameter> < 0 <function>CONFIDENCE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>size</parameter> is 0 <function>CONFIDENCE</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CONFIDENCE</function>(0.05,1,33) equals 0.341185936.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
@@ -14613,21 +9849,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CORREL</function> returns the correlation coefficient of two data sets.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>CORREL</function>(A1:A5,B1:B5) equals 0.996124788.</para>
+ <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>
@@ -14649,24 +9873,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COUNT</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUNT</function> returns the total number of integer or floating point arguments passed.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>COUNT</function>(A1:A5) equals 5.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
@@ -14685,24 +9891,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>COUNTA</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>COUNTA</function> returns the number of arguments passed not including empty cells.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, "missing", "missing", 25.9, and 40.1. Then</para>
- <para><function>COUNTA</function>(A1:A5) equals 5.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>,
@@ -14731,21 +9919,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>COVAR</function> returns the covariance of two data sets.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>COVAR</function>(A1:A5,B1:B5) equals 65.858.</para>
+ <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>
@@ -14767,35 +9943,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CRITBINOM</function>(<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>alpha</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CRITBINOM</function> function returns the smallest value for which the cumulative is greater than or equal to a given value. <parameter>n</parameter> is the number of trials, <parameter>p</parameter> is the probability of success in trials, and <parameter>alpha</parameter> is the criterion value.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>trials</parameter> is a non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>trials</parameter> < 0 <function>CRITBINOM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>CRITBINOM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> < 0 or <parameter>alpha</parameter> > 1 <function>CRITBINOM</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CRITBINOM</function>(10,0.5,0.75) equals 6.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>.
@@ -14814,23 +9961,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CRONBACH</function>(<parameter>ref1</parameter>,<parameter>ref2</parameter>,<parameter/>...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CRONBACH</function> returns Cronbach's alpha for the given cases.</para>
- <para><parameter>ref1</parameter> is a data set, <parameter>ref2</parameter> the second data set, etc..</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-DEVSQ">
<refmeta>
@@ -14845,25 +9975,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>DEVSQ</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>DEVSQ</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>DEVSQ</function> returns the sum of squares of deviations of a data set from the sample mean.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>DEVSQ</function>(A1:A5) equals 470.56.</para>
+ <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>
@@ -14888,23 +10006,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>EXPONDIST</function> function returns the exponential distribution. If the <parameter>cumulative</parameter> boolean is false it will return:</para>
- <para><parameter>y</parameter> * exp (-<parameter>y</parameter>*<parameter>x</parameter>),</para>
- <para>otherwise it will return</para>
- <para> 1 - exp (-<parameter>y</parameter>*<parameter>x</parameter>).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> < 0 or <parameter>y</parameter> <= 0 this will return an error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EXPONDIST</function>(2,4,0) equals 0.001341851.</para>
+ <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>See also</title>
@@ -14929,13 +10034,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>EXPPOWDIST</function> returns the probability density p(x) at <parameter>x</parameter> for Exponential Power distribution with scale parameter <parameter>a</parameter> and exponent <parameter>b</parameter>.</para>
<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>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EXPPOWDIST</function>(0.4,1,2).</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>
@@ -14956,27 +10058,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>FDIST</function>(<parameter>x</parameter>,<parameter>dof1</parameter>,<parameter>dof2</parameter>)</synopsis>
+ <synopsis><function>FDIST</function>(<parameter>x</parameter>,<parameter>dof_of_num</parameter>,<parameter>dof_of_denom</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FDIST</function> function returns the F probability distribution. <parameter>dof1</parameter> is the numerator degrees of freedom and <parameter>dof2</parameter> is the denominator degrees of freedom.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> < 0 <function>FDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>dof1</parameter> < 1 or <parameter>dof2</parameter> < 1, <function>FDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FDIST</function>(2,5,5) equals 0.232511319.</para>
+ <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>See also</title>
@@ -14997,27 +10086,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>FINV</function>(<parameter>p</parameter>,<parameter>dof1</parameter>,<parameter>dof2</parameter>)</synopsis>
+ <synopsis><function>FINV</function>(<parameter>p</parameter>,<parameter>dof_of_num</parameter>,<parameter>dof_of_denom</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FINV</function> function returns the inverse of the F probability distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>FINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>dof1</parameter> < 1 or <parameter>dof2</parameter> < 1 <function>FINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FINV</function>(0.2,2,4) equals 2.472135955.</para>
+ <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>: denomiantor degrees of freedom</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -15037,32 +10113,10 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>FISHER</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FISHER</function> function returns the Fisher transformation at <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is not a number, <function>FISHER</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> <= -1 or <parameter>x</parameter> >= 1, <function>FISHER</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FISHER</function>(0.332) equals 0.345074339.</para>
- </refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-SKEW"><function>SKEW</function></link>.
+ <para><link linkend="gnumeric-FISHERINV"><function>FISHERINV</function></link>,
+ <link linkend="gnumeric-ATANH"><function>ATANH</function></link>.
</para>
</refsect1>
</refentry>
@@ -15078,29 +10132,10 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>FISHERINV</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FISHERINV</function> function returns the inverse of the Fisher transformation at <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is non-number <function>FISHERINV</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FISHERINV</function>(2) equals 0.96402758.</para>
- </refsect1>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-FISHER"><function>FISHER</function></link>.
+ <para><link linkend="gnumeric-FISHER"><function>FISHER</function></link>,
+ <link linkend="gnumeric-TANH"><function>TANH</function></link>.
</para>
</refsect1>
</refentry>
@@ -15121,24 +10156,10 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FORECAST</function> function estimates a future value according to existing values using simple linear regression. The estimated future value is a y-value for a given x-value (<parameter>x</parameter>).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, <function>FORECAST</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>If the variance of the <parameter>known_x</parameter> is zero, <function>FORECAST</function> returns #DIV/0 error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>FORECAST</function>(7,A1:A5,B1:B5) equals -10.859397661.</para>
+ <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>See also</title>
@@ -15164,22 +10185,18 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FREQUENCY</function> function counts how often given values occur within a range of values. The results are given as an array.</para>
- <para><parameter>data_array</parameter> is a data array for which you want to count the frequencies. <parameter>bin_array</parameter> is an array containing the intervals into which you want to group the values in data_array. If the <parameter>bin_array</parameter> is empty, <function>FREQUENCY</function> returns the number of data points in <parameter>data_array</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>FREQUENCY</function>(<parameter>data_array</parameter>,<parameter>bins_array</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>See also</title>
- <para>
- </para>
+ <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>
+ <para><parameter>data_array</parameter>: data values</para>
+ <para><parameter>bins_array</parameter>: array of cutoff values</para>
</refsect1>
</refentry>
<refentry id="gnumeric-FTEST">
@@ -15194,24 +10211,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>FTEST</function>(<parameter>array1</parameter>,<parameter>array2</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FTEST</function> function returns the two-tailed probability that the variances in the given two data sets are not significantly different.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>FTEST</function>(A1:A5,B1:B5) equals 0.510815017.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>,
@@ -15231,29 +10230,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GAMMADIST</function>(<parameter>x</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>,<parameter>cum</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GAMMADIST</function> function returns the gamma distribution. If <parameter>cum</parameter> is TRUE, <function>GAMMADIST</function> returns the incomplete gamma function, otherwise it returns the probability mass function.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> < 0 <function>GAMMADIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0, <function>GAMMADIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>GAMMADIST</function>(1,2,3,0) equals 0.07961459.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-GAMMAINV"><function>GAMMAINV</function></link>.
@@ -15272,76 +10248,12 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GAMMAINV</function>(<parameter>p</parameter>,<parameter>alpha</parameter>,<parameter>beta</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GAMMAINV</function> function returns the inverse of the cumulative gamma distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>GAMMAINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0 <function>GAMMAINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>GAMMAINV</function>(0.34,2,4) equals 4.829093908.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-GAMMADIST"><function>GAMMADIST</function></link>.
</para>
</refsect1>
</refentry>
- <refentry id="gnumeric-GAMMALN">
- <refmeta>
- <refentrytitle>
- <function>GAMMALN</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>GAMMALN</function>
- </refname>
- <refpurpose/>
- </refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GAMMALN</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GAMMALN</function> function returns the natural logarithm of the gamma function.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is non-number then <function>GAMMALN</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> <= 0 then <function>GAMMALN</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>GAMMALN</function>(23) equals 48.471181352.</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
- </para>
- </refsect1>
- </refentry>
<refentry id="gnumeric-GEOMDIST">
<refmeta>
<refentrytitle>
@@ -15354,29 +10266,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>GEOMDIST</function>(<parameter>k</parameter>,<parameter>p</parameter>,<parameter>cum</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>GEOMDIST</function> returns the probability p(k) of obtaining <parameter>k</parameter> from a geometric distribution with probability parameter <parameter>p</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>k</parameter> < 0 <function>GEOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>GEOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>cum</parameter> != TRUE and <parameter>cum</parameter> != FALSE <function>GEOMDIST</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>GEOMDIST</function>(2,10.4,TRUE).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDGEOM"><function>RANDGEOM</function></link>.
@@ -15396,22 +10285,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>GEOMEAN</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>GEOMEAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>GEOMEAN</function> returns the geometric mean of the given arguments. This is equal to the Nth root of the product of the terms.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>GEOMEAN</function>(A1:A5) equals 21.279182482.</para>
+ <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>
@@ -15436,30 +10316,26 @@
<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>
+ <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>
+ <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> returns an array having one column and a row for each data point in <parameter>new_x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
- </listitem>
- <listitem>
- <para>If <parameter>new_x</parameter>'s is omitted, it is assumed to be the same as <parameter>known_x</parameter>'s.</para>
- </listitem>
- <listitem>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, <function>GROWTH</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>const</parameter> is FALSE, the line will be forced to go through the origin, i.e., b will be zero. The default is TRUE.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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>See also</title>
@@ -15482,22 +10358,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>HARMEAN</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>HARMEAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>HARMEAN</function> returns the harmonic mean of the N data points (that is, N divided by the sum of the inverses of the data points).</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>HARMEAN</function>(A1:A5) equals 19.529814427.</para>
+ <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>
@@ -15521,33 +10388,6 @@
</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><function>HYPGEOMDIST</function> function returns the hypergeometric distribution. <parameter>x</parameter> is the number of successes in the sample, <parameter>n</parameter> is the number of trials, <parameter>M</parameter> is the number of successes overall, and <parameter>N</parameter> is the population size.</para>
- <para>If the optional argument <parameter>cumulative</parameter> is TRUE, the cumulative left tail will be returned.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter> or <parameter>N</parameter> is a non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter>,<parameter>n</parameter>,<parameter>M</parameter> or <parameter>N</parameter> < 0 <function>HYPGEOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> > <parameter>M</parameter> or <parameter>n</parameter> > <parameter>N</parameter> <function>HYPGEOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>HYPGEOMDIST</function>(1,2,3,10) equals 0.4666667.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
@@ -15567,30 +10407,6 @@
</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><function>INTERCEPT</function> function calculates the point where the linear regression line intersects the y-axis.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>known_x</parameter> or <parameter>known_y</parameter> contains no data entries or different number of data entries, <function>INTERCEPT</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>If the variance of the <parameter>known_x</parameter> is zero, <function>INTERCEPT</function> returns #DIV/0 error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>INTERCEPT</function>(A1:A5,B1:B5) equals -20.785117212.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-FORECAST"><function>FORECAST</function></link>,
@@ -15611,29 +10427,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>KURT</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>KURT</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>KURT</function> returns an unbiased estimate of the kurtosis of a data set.</para>
- <para>Note, that 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>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If fewer than four numbers are given or all of them are equal <function>KURT</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>KURT</function>(A1:A5) equals 1.234546305.</para>
+ <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>
@@ -15657,25 +10457,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>KURTP</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>KURTP</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>KURTP</function> returns the population kurtosis of a data set.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If fewer than two numbers are given or all of them are equal <function>KURTP</function> returns #DIV/0! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>KURTP</function>(A1:A5) equals -0.691363424.</para>
+ <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>
@@ -15698,18 +10486,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LANDAU</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LANDAU</function> returns the probability density p(x) at <parameter>x</parameter> for the Landau distribution using an approximation method.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LANDAU</function>(0.34).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDLANDAU"><function>RANDLANDAU</function></link>.
@@ -15728,18 +10504,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LAPLACE</function>(<parameter>x</parameter>,<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LAPLACE</function> returns the probability density p(x) at <parameter>x</parameter> for Laplace distribution with mean <parameter>a</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LAPLACE</function>(0.4,1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDLAPLACE"><function>RANDLAPLACE</function></link>.
@@ -15758,31 +10522,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LARGE</function>(<parameter>n</parameter>,<parameter/> k)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LARGE</function> returns the k-th largest value in a data set.</para>
- <itemizedlist>
- <listitem>
- <para>If data set is empty <function>LARGE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>k</parameter> <= 0 or <parameter>k</parameter> is greater than the number of data items given <function>LARGE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>LARGE</function>(A1:A5,2) equals 25.9.</para>
- <para><function>LARGE</function>(A1:A5,4) equals 17.3.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
@@ -15805,15 +10544,37 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>LINEST</function>(<parameter>y</parameter>,<parameter>x</parameter>,<parameter>affine</parameter>,<parameter>stats</parameter>)</synopsis>
+ <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><parameter>y</parameter>: vector of values of dependent variable.</para>
- <para><parameter>x</parameter>: array of values of independent variables, defaults to a single vector 1,...,n.</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 is provided, defaults to false</para>
+ <para><parameter>stats</parameter>: if true, some additional statistics are provided, defaults to false</para>
+ </refsect1>
+ <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>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>
+ <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>
+ <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>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>
+ <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>See also</title>
@@ -15835,31 +10596,26 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>LOGEST</function>(<parameter>known_y</parameter>'s[,<parameter>known_x</parameter>'s,<parameter>const</parameter>,<parameter>stat</parameter>])</synopsis>
+ <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</para>
- <para> y = b * m{1}^x{1} * m{2}^x{2}... to your data.</para>
- <para>If <parameter>stat</parameter> is TRUE, extra statistical information will be returned. 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>
- <itemizedlist>
- <listitem>
- <para>If <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used. <function>LOGEST</function> returns an array { m{n},m{n-1}, ...,m{1},b }.</para>
- </listitem>
- <listitem>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, <function>LOGEST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>const</parameter> is FALSE, the line will be forced to go through (0,1),i.e., b will be one. The default is TRUE.</para>
- </listitem>
- <listitem>
- <para>The default of <parameter>stat</parameter> is FALSE.</para>
- </listitem>
- </itemizedlist>
+ <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>
+ <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>Examples</title>
- <para/>
+ <title>Description</title>
+ <para><function>LOGEST</function> returns an array { m{n},m{n-1}, ...,m{1},b }.</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>See also</title>
@@ -15885,21 +10641,18 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>LOGFIT</function> function applies the ``least squares'' method to fit the logarithmic equation</para>
- <para>y = a + b * ln(sign * (x - c)) , sign = +1 or -1</para>
- <para>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><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>
- <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>
- <para>You can use the above formula</para>
- <para>= a + b * ln(sign * (x - c))</para>
- <para>or rearrange it to</para>
- <para>= (exp((y - a) / b)) / sign + c</para>
- <para>to compute unknown y's or x's, respectively.</para>
- <para>Technically, 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>
+ <para><function>LOGFIT</function> function applies the ``least squares'' method to fit the logarithmic equationy = 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>
+ <refsynopsisdiv>
+ <synopsis><function>LOGFIT</function>(<parameter>known_y</parameter>'s,<parameter>known_x</parameter>'s))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
+ <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>
+ <para>@{known_y's}: known y-values</para>
+ <para>@{known_x's}: known x-values</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -15921,26 +10674,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOGINV</function>(<parameter>p</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOGINV</function> function returns the inverse of the lognormal cumulative distribution. <parameter>p</parameter> is the given probability corresponding to the normal distribution, <parameter>mean</parameter> is the arithmetic mean of the distribution, and <parameter>stddev</parameter> is the standard deviation of the distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>stddev</parameter> <= 0 <function>LOGINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOGINV</function>(0.5,2,3) equals 7.389056099.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXP"><function>EXP</function></link>,
@@ -15963,18 +10696,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOGISTIC</function>(<parameter>x</parameter>,<parameter>a</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOGISTIC</function> returns the probability density p(x) at <parameter>x</parameter> for a logistic distribution with scale parameter <parameter>a</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOGISTIC</function>(0.4,1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDLOGISTIC"><function>RANDLOGISTIC</function></link>.
@@ -15993,29 +10714,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOGNORMDIST</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOGNORMDIST</function> function returns the lognormal distribution. <parameter>x</parameter> is the value for which you want the distribution, <parameter>mean</parameter> is the mean of the distribution, and <parameter>stddev</parameter> is the standard deviation of the distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>stddev</parameter> = 0 <function>LOGNORMDIST</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> <= 0, <parameter>mean</parameter> < 0 or <parameter>stddev</parameter> < 0 <function>LOGNORMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOGNORMDIST</function>(3,1,2) equals 0.519662338.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>.
@@ -16035,23 +10733,26 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>LOGREG</function>(<parameter>known_y</parameter>'s[,<parameter>known_x</parameter>'s[,<parameter>const</parameter>[,<parameter>stat</parameter>]]])</synopsis>
+ <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</para>
- <para>y = m * z + b</para>
- <para>to your y's and z's --- equivalent to fitting the equation</para>
- <para>y = m * ln(x) + b</para>
- <para>to y's and x's.</para>
- <para>If <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used. <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>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, <function>LOGREG</function> returns #NUM! error.</para>
- <para>If <parameter>const</parameter> is FALSE, the curve will be forced to go through [1; 0], i.e., b will be zero. The default is TRUE.</para>
- <para>If <parameter>stat</parameter> is TRUE, extra statistical information will be returned which applies to the state AFTER transformation to z. Extra statistical information is written below m and b in the result array. Extra statistical information consists of four rows of data. In the first row the standard error values for the coefficients m, 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.The default of <parameter>stat</parameter> is FALSE.</para>
+ <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>
+ <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>Examples</title>
- <para/>
+ <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>
+ <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>See also</title>
@@ -16073,24 +10774,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MAX</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MAX</function> returns the value of the element of the values passed that has the largest value, with negative numbers considered smaller than positive numbers.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>MAX</function>(A1:A5) equals 40.1.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MIN"><function>MIN</function></link>,
@@ -16111,22 +10794,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MAXA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>MAXA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MAXA</function> returns the largest value of the given arguments. 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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>MAXA</function>(A1:A5) equals 40.1.</para>
+ <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>
@@ -16148,28 +10822,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MEDIAN</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>MEDIAN</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MEDIAN</function> returns the median of the given data set.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If even numbers are given <function>MEDIAN</function> returns the average of the two numbers in the middle.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>MEDIAN</function>(A1:A5) equals 21.3.</para>
+ <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>
@@ -16195,24 +10854,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MIN</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>MIN</function> returns the value of the element of the values passed that has the smallest value, with negative numbers considered smaller than positive numbers.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>MIN</function>(A1:A5) equals 11.4.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MAX"><function>MAX</function></link>,
@@ -16233,22 +10874,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MINA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>MINA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MINA</function> returns the smallest value of the given arguments. 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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>MINA</function>(A1:A5) equals 0.</para>
+ <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>
@@ -16270,28 +10902,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>MODE</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>MODE</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>MODE</function> returns the most common number of the data set. If the data set has many most common numbers <function>MODE</function> returns the first one of them.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If the data set does not contain any duplicates <function>MODE</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para>Strings and empty cells are simply ignored.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>MODE</function>(<parameter>number1</parameter>,<parameter>number2</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 11.4, 25.9, and 40.1. Then</para>
- <para><function>MODE</function>(A1:A5) equals 11.4.</para>
+ <title>Description</title>
+ <para>If the data set does not contain any duplicates this function returns a #N/A error.</para>
+ <para><parameter>number1</parameter>: first value</para>
+ <para><parameter>number2</parameter>: second value</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -16312,32 +10938,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>NEGBINOMDIST</function>(<parameter>f</parameter>,<parameter>t</parameter>,<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NEGBINOMDIST</function> function returns the negative binomial distribution. <parameter>f</parameter> is the number of failures, <parameter>t</parameter> is the threshold number of successes, and <parameter>p</parameter> is the probability of a success.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>f</parameter> or <parameter>t</parameter> is a non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If (<parameter>f</parameter> + <parameter>t</parameter> -1) <= 0 <function>NEGBINOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>NEGBINOMDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NEGBINOMDIST</function>(2,5,0.55) equals 0.152872629.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
@@ -16360,26 +10960,6 @@
</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>The <function>NORMDIST</function> function returns the value of the probability density function or the cumulative distribution function for the normal distribution with the mean given by <parameter>mean</parameter>, and the standard deviation given by <parameter>stddev</parameter>. If <parameter>cumulative</parameter> is FALSE, <function>NORMDIST</function> returns the value of the probability density function at the value <parameter>x</parameter>. If <parameter>cumulative</parameter> is TRUE, <function>NORMDIST</function> returns the value of the cumulative distribution function at <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>stddev</parameter> is 0 <function>NORMDIST</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NORMDIST</function>(2,1,2,0) equals 0.176032663.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-POISSON"><function>POISSON</function></link>.
@@ -16398,26 +10978,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>NORMINV</function>(<parameter>p</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NORMINV</function> function returns the inverse of the normal cumulative distribution. <parameter>p</parameter> is the given probability corresponding to the normal distribution, <parameter>mean</parameter> is the arithmetic mean of the distribution, and <parameter>stddev</parameter> is the standard deviation of the distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>stddev</parameter> <= 0 <function>NORMINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NORMINV</function>(0.76,2,3) equals 4.118907689.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
@@ -16440,23 +11000,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>NORMSDIST</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NORMSDIST</function> function returns the standard normal cumulative distribution. <parameter>x</parameter> is the value for which you want the distribution.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NORMSDIST</function>(2) equals 0.977249868.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>.
@@ -16475,26 +11018,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>NORMSINV</function>(<parameter>p</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>NORMSINV</function> function returns the inverse of the standard normal cumulative distribution. <parameter>p</parameter> is the given probability corresponding to the normal distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 <function>NORMSINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>NORMSINV</function>(0.2) equals -0.841621234.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
@@ -16517,18 +11040,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PARETO</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>b</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PARETO</function> returns the probability density p(x) at <parameter>x</parameter> for a Pareto distribution with exponent <parameter>a</parameter> and scale <parameter>b</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>PARETO</function>(0.6,1,2).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDPARETO"><function>RANDPARETO</function></link>.
@@ -16552,19 +11063,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>PEARSON</function> returns the Pearson correlation coefficient of two data sets.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -16588,30 +11089,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PERCENTILE</function>(<parameter>array</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PERCENTILE</function> function returns the 100*<parameter>k</parameter>-th percentile of the given data points (that is, a number x such that a fraction <parameter>k</parameter> of the data points are less than x).</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>array</parameter> is empty, <function>PERCENTILE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>k</parameter> < 0 or <parameter>k</parameter> > 1, <function>PERCENTILE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>PERCENTILE</function>(A1:A5,0.42) equals 20.02.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-QUARTILE"><function>QUARTILE</function></link>.
@@ -16630,31 +11107,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PERCENTRANK</function>(<parameter>array</parameter>,<parameter>x</parameter>[,<parameter>significance</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PERCENTRANK</function> function returns the rank of a data point in a data set. <parameter>array</parameter> is the range of numeric values, <parameter>x</parameter> is the data point which you want to rank, and the optional <parameter>significance</parameter> specifies the number of significant digits for the returned value, truncating the remainder. If <parameter>significance</parameter> is omitted, <function>PERCENTRANK</function> uses three digits.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>array</parameter> contains no data points, <function>PERCENTRANK</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>significance</parameter> is less than one, <function>PERCENTRANK</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> exceeds the largest value or is less than the smallest value in <parameter>array</parameter>, <function>PERCENTRANK</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> does not match any of the values in <parameter>array</parameter> or <parameter>x</parameter> matches more than once, <function>PERCENTRANK</function> interpolates the returned value.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LARGE"><function>LARGE</function></link>,
@@ -16679,29 +11131,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PERMUT</function>(<parameter>n</parameter>,<parameter>k</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PERMUT</function> function returns the number of permutations. <parameter>n</parameter> is the number of objects, <parameter>k</parameter> is the number of objects in each permutation.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>n</parameter> = 0 <function>PERMUT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>n</parameter> < <parameter>k</parameter> <function>PERMUT</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>PERMUT</function>(7,3) equals 210.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COMBIN"><function>COMBIN</function></link>.
@@ -16720,32 +11149,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>POISSON</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>cumulative</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>POISSON</function> function returns the Poisson distribution. <parameter>x</parameter> is the number of events, <parameter>mean</parameter> is the expected numeric value <parameter>cumulative</parameter> describes whether to return the sum of the Poisson function from 0 to <parameter>x</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> is a non-integer it is truncated.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x</parameter> < 0 <function>POISSON</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>mean</parameter> <= 0 <function>POISSON</function> returns the #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>POISSON</function>(3,6,0) equals 0.089235078.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-NORMDIST"><function>NORMDIST</function></link>,
@@ -16765,31 +11168,6 @@
</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><function>PROB</function> function returns the probability that values in a range or an array are between two limits. If <parameter>upper_limit</parameter> is not given, <function>PROB</function> returns the probability that values in <parameter>x_range</parameter> are equal to <parameter>lower_limit</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If the sum of the probabilities in <parameter>prob_range</parameter> is not equal to 1 <function>PROB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If any value in <parameter>prob_range</parameter> is <=0 or > 1, <function>PROB</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>x_range</parameter> and <parameter>prob_range</parameter> contain a different number of data entries, <function>PROB</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
@@ -16809,39 +11187,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>QUARTILE</function>(<parameter>array</parameter>,<parameter>quart</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>QUARTILE</function> function returns the quartile of the given data points.</para>
- <para>If <parameter>quart</parameter> is equal to: <function>QUARTILE</function> returns:</para>
- <para>0 the smallest value of <parameter>array</parameter>.</para>
- <para>1 the first quartile</para>
- <para>2 the second quartile</para>
- <para>3 the third quartile</para>
- <para>4 the largest value of <parameter>array</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>array</parameter> is empty, <function>QUARTILE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>quart</parameter> < 0 or <parameter>quart</parameter> > 4, <function>QUARTILE</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>quart</parameter> is not an integer, it is truncated.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>QUARTILE</function>(A1:A5,1) equals 17.3.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LARGE"><function>LARGE</function></link>,
@@ -16871,10 +11216,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -16901,10 +11246,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -16931,10 +11276,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -16961,9 +11306,9 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -16990,9 +11335,9 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17019,10 +11364,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17049,10 +11394,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17079,9 +11424,9 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17108,11 +11453,11 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17139,10 +11484,10 @@
<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. This is useful if the result would otherwise underflow to 0. Defaults to false.</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>
@@ -17169,10 +11514,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17199,10 +11544,10 @@
<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. This is useful if the result would otherwise underflow to 0. Defaults to false.</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>
@@ -17229,9 +11574,9 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17258,9 +11603,9 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17287,10 +11632,10 @@
<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>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. This is useful if the result would otherwise underflow to 0. Defaults to false.</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -17317,11 +11662,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17348,11 +11693,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17379,11 +11724,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17410,10 +11755,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17440,10 +11785,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17470,11 +11815,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17501,11 +11846,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17532,10 +11877,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17562,12 +11907,12 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17594,11 +11939,11 @@
<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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17625,11 +11970,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17656,11 +12001,11 @@
<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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17687,10 +12032,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17717,10 +12062,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17747,11 +12092,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17778,11 +12123,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17809,11 +12154,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17840,11 +12185,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17871,10 +12216,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17901,10 +12246,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17931,11 +12276,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17962,11 +12307,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -17993,10 +12338,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18023,12 +12368,12 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18055,11 +12400,11 @@
<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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18086,11 +12431,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18117,11 +12462,11 @@
<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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18148,10 +12493,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18178,10 +12523,10 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18208,11 +12553,11 @@
<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>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. This is useful if the probability would otherwise underflow to 0. Defaults to false.</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>
@@ -18233,24 +12578,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RANK</function>(<parameter>x</parameter>,<parameter>ref</parameter>[,<parameter>order</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RANK</function> returns the rank of a number in a list of numbers. <parameter>x</parameter> is the number whose rank you want to find, <parameter>ref</parameter> is the list of numbers, and <parameter>order</parameter> specifies how to rank numbers. If <parameter>order</parameter> is 0, numbers are ranked in descending order, otherwise numbers are ranked in ascending order.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>RANK</function>(17.3,A1:A5) equals 4.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-PERCENTRANK"><function>PERCENTRANK</function></link>.
@@ -18269,18 +12596,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RAYLEIGH</function>(<parameter>x</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RAYLEIGH</function> returns the probability density p(x) at <parameter>x</parameter> for a Rayleigh distribution with scale parameter <parameter>sigma</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RAYLEIGH</function>(0.4,1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDRAYLEIGH"><function>RANDRAYLEIGH</function></link>.
@@ -18299,18 +12614,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RAYLEIGHTAIL</function>(<parameter>x</parameter>,<parameter>a</parameter>,<parameter>sigma</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RAYLEIGHTAIL</function> returns the probability density p(x) at <parameter>x</parameter> for a Rayleigh tail distribution with scale parameter <parameter>sigma</parameter> and lower limit <parameter>a</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RAYLEIGHTAIL</function>(0.6,0.3,1).</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-RANDRAYLEIGHTAIL"><function>RANDRAYLEIGHTAIL</function></link>.
@@ -18334,19 +12637,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>RSQ</function> returns the square of the Pearson correlation coefficient of two data sets.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
+ <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>
@@ -18375,29 +12668,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SKEW</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>SKEW</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SKEW</function> returns an unbiased estimate for skewness of a distribution.</para>
- <para>Note, that 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>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If less than three numbers are given, <function>SKEW</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>SKEW</function>(A1:A5) equals 0.976798268.</para>
+ <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>
@@ -18421,25 +12698,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SKEWP</function>(<parameter>n1</parameter>,<parameter/> n2,<parameter/> ...)</synopsis>
+ <synopsis><function>SKEWP</function>(<parameter>number1</parameter>,<parameter>number2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SKEWP</function> returns the population skewness of a data set.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells are simply ignored.</para>
- </listitem>
- <listitem>
- <para>If less than two numbers are given, <function>SKEWP</function> returns #DIV/0! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>SKEWP</function>(A1:A5) equals 0.655256198.</para>
+ <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>
@@ -18462,24 +12727,6 @@
</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><function>SLOPE</function> returns the slope of the linear regression line.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>SLOPE</function>(A1:A5,B1:B5) equals 1.417959936.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-STDEV"><function>STDEV</function></link>,
@@ -18499,31 +12746,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SMALL</function>(<parameter>n</parameter>,<parameter/> k)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SMALL</function> returns the k-th smallest value in a data set.</para>
- <itemizedlist>
- <listitem>
- <para>If data set is empty <function>SMALL</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>k</parameter> <= 0 or <parameter>k</parameter> is greater than the number of data items given <function>SMALL</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>SMALL</function>(A1:A5,2) equals 17.3.</para>
- <para><function>SMALL</function>(A1:A5,4) equals 25.9.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-PERCENTILE"><function>PERCENTILE</function></link>,
@@ -18546,31 +12768,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SSMEDIAN</function>(<parameter>array</parameter>[,<parameter>interval</parameter>)]</synopsis>
+ <synopsis><function>SSMEDIAN</function>(<parameter>array</parameter>,<parameter>interval</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>The <function>SSMEDIAN</function> function returns the median for grouped data as commonly determined in the social sciences. 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>
- <itemizedlist>
- <listitem>
- <para>If <parameter>interval</parameter> is not given, <function>SSMEDIAN</function> uses 1.</para>
- </listitem>
- <listitem>
- <para>If <parameter>array</parameter> is empty, <function>SSMEDIAN</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>interval</parameter> <= 0, <function>SSMEDIAN</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para><function>SSMEDIAN</function> does not check whether the data points are at least <parameter>interval</parameter> apart.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, A3 contain numbers 7, 8, 8. Then</para>
- <para><function>SSMEDIAN</function>(A1:A3, 1) equals 7.75.</para>
+ <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>See also</title>
@@ -18590,26 +12794,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>STANDARDIZE</function>(<parameter>x</parameter>,<parameter>mean</parameter>,<parameter>stddev</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>STANDARDIZE</function> function returns a normalized value. <parameter>x</parameter> is the number to be normalized, <parameter>mean</parameter> is the mean of the distribution, <parameter>stddev</parameter> is the standard deviation of the distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>stddev</parameter> is 0 <function>STANDARDIZE</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>STANDARDIZE</function>(3,2,4) equals 0.25.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-AVERAGE"><function>AVERAGE</function></link>.
@@ -18629,25 +12813,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>STDEV</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>STDEV</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>STDEV</function> returns the sample standard deviation of the given sample.</para>
- <para>To obtain the population standard deviation of a whole population use STDEVP.</para>
- <para><function>STDEV</function> is also known as the N-1-standard deviation.</para>
- <para>Under reasonable conditions, it is the maximum-likelihood estimator for the true population standard deviation.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para><function>STDEV</function> is also known as the N-1-standard deviation. Under reasonable conditions, it is the maximum-likelihood estimator for the true population standard deviation.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>STDEV</function>(<parameter>area1</parameter>,<parameter>area2</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>STDEV</function>(A1:A5) equals 10.84619749.</para>
+ <title>Description</title>
+ <para>To obtain the population standard deviation of a whole population use STDEVP.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -18673,26 +12854,31 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>STDEVA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <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. Under reasonable conditions, it is the maximum-likelihood estimator for the true population standard deviation.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>STDEVA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>))</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>STDEVA</function> returns the sample standard deviation of the given sample.</para>
<para>To obtain the population standard deviation of a whole population use STDEVPA.</para>
- <para><function>STDEVA</function> is also known as the N-1-standard deviation.</para>
- <para>Under reasonable conditions, it is the maximum-likelihood estimator for the true population standard deviation.</para>
- <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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>STDEVA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>STDEVA</function>(A1:A5) equals 15.119953704.</para>
+ <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>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -18714,23 +12900,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>STDEVP</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>STDEVP</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>STDEVP</function> returns the population standard deviation of the given population.</para>
<para>This is also known as the N-standard deviation</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>STDEVP</function>(A1:A5) equals 9.701133954.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -18753,24 +12929,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>STDEVPA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>STDEVPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>STDEVPA</function> returns the population standard deviation of an entire population.</para>
<para>This is also known as the N-standard deviation</para>
- <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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>STDEVPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>STDEVPA</function>(A1:A5) equals 13.523697719.</para>
+ <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>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -18791,27 +12965,6 @@
</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><function>STEYX</function> function returns the standard error of the predicted y-value for each x in the regression.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s are empty or have a different number of arguments then <function>STEYX</function> returns #N/A error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>STEYX</function>(A1:A5,B1:B5) equals 1.101509979.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-PEARSON"><function>PEARSON</function></link>,
@@ -18832,40 +12985,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SUBTOTAL</function>(<parameter>function_nbr</parameter>,<parameter>ref1</parameter>,<parameter>ref2</parameter>,<parameter/>...)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUBTOTAL</function> function returns a subtotal of given list of arguments. <parameter>function_nbr</parameter> is the number that specifies which function to use in calculating the subtotal.</para>
- <para>The following functions are available:</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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 23, 27, 28, 33, and 39. Then</para>
- <para><function>SUBTOTAL</function>(1,A1:A5) equals 30.</para>
- <para><function>SUBTOTAL</function>(6,A1:A5) equals 22378356.</para>
- <para><function>SUBTOTAL</function>(7,A1:A5) equals 6.164414003.</para>
- <para><function>SUBTOTAL</function>(9,A1:A5) equals 150.</para>
- <para><function>SUBTOTAL</function>(11,A1:A5) equals 30.4.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-COUNT"><function>COUNT</function></link>,
@@ -18890,27 +13009,20 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TDIST</function> function returns the Student's t-distribution. <parameter>dof</parameter> is the degree of freedom and <parameter>tails</parameter> is 1 or 2 depending on whether you want one-tailed or two-tailed distribution.</para>
- <para><parameter>tails</parameter> = 1 returns the size of the right tail.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>dof</parameter> < 1 <function>TDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>tails</parameter> is neither 1 or 2 <function>TDIST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible for non-negative <parameter>x</parameter>.</para>
- </listitem>
- </itemizedlist>
- <para>Warning: 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>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>TDIST</function>(<parameter>x</parameter>,<parameter>dof</parameter>,<parameter>tails</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TDIST</function>(2,5,1) equals 0.050969739.</para>
- <para><function>TDIST</function>(-2,5,1) equals 0.949030261.</para>
- <para><function>TDIST</function>(0,5,2) equals 1.</para>
+ <title>Description</title>
+ <para>This function is Excel compatible for non-negative <parameter>x</parameter>.</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>See also</title>
@@ -18936,21 +13048,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TINV</function> function returns the inverse of the two-tailed Student's t-distribution.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 or <parameter>dof</parameter> < 1 <function>TINV</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- <para>Warning: 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>Examples</title>
- <para/>
- <para><function>TINV</function>(0.4,32) equals 0.852998454.</para>
+ <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>See also</title>
@@ -18971,33 +13071,6 @@
</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><function>TREND</function> function estimates future values of a given data set using the ``least squares'' line that best fit to your data. <parameter>known_y</parameter>'s is the y-values where y=mx+b and <parameter>known_x</parameter>'s contains the corresponding x-values. <parameter>new_x</parameter>'s contains the x-values for which you want to estimate the y-values. If <parameter>const</parameter> is FALSE, the line will be forced to go through the origin, i.e., b will be zero.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>known_x</parameter>'s is omitted, an array {1, 2, 3, ...} is used.</para>
- </listitem>
- <listitem>
- <para>If <parameter>new_x</parameter>'s is omitted, it is assumed to be the same as <parameter>known_x</parameter>'s.</para>
- </listitem>
- <listitem>
- <para>If <parameter>const</parameter> is omitted, it is assumed to be TRUE.</para>
- </listitem>
- <listitem>
- <para>If <parameter>known_y</parameter>'s and <parameter>known_x</parameter>'s have unequal number of data points, <function>TREND</function> returns #NUM! error.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>TREND</function>(A1:A5,B1:B5) equals {12.1, 15.7, 21.6, 26.7, 39.7}.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LINEST"><function>LINEST</function></link>.
@@ -19021,18 +13094,9 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>TRIMMEAN</function> returns the mean of the interior of a data set. <parameter>ref</parameter> is the list of numbers whose mean you want to calculate and <parameter>fraction</parameter> is the fraction of the data set excluded from the mean. For example, 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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>TRIMMEAN</function>(A1:A5,0.2) equals 23.2.</para>
+ <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>
@@ -19056,43 +13120,6 @@
</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><function>TTEST</function> function returns the probability of a Student's t-Test.</para>
- <para><parameter>array1</parameter> is the first data set and <parameter>array2</parameter> is the second data set. If <parameter>tails</parameter> is one, <function>TTEST</function> uses the one-tailed distribution and if <parameter>tails</parameter> is two, <function>TTEST</function> uses the two-tailed distribution. <parameter>type</parameter> determines the kind of the test:</para>
- <para> 1 Paired test</para>
- <para> 2 Two-sample equal variance</para>
- <para> 3 Two-sample unequal variance</para>
- <itemizedlist>
- <listitem>
- <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>
- </listitem>
- <listitem>
- <para><parameter>tails</parameter> and <parameter>type</parameter> are truncated to integers.</para>
- </listitem>
- <listitem>
- <para>If <parameter>tails</parameter> is not one or two, <function>TTEST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>type</parameter> is any other than one, two, or three, <function>TTEST</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1, and the cells B1, B2, ... B5 23.2, 25.8, 29.9, 33.5, and 42.7. Then</para>
- <para><function>TTEST</function>(A1:A5,B1:B5,1,1) equals 0.003127619.</para>
- <para><function>TTEST</function>(A1:A5,B1:B5,2,1) equals 0.006255239.</para>
- <para><function>TTEST</function>(A1:A5,B1:B5,1,2) equals 0.111804322.</para>
- <para><function>TTEST</function>(A1:A5,B1:B5,1,3) equals 0.113821797.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-FDIST"><function>FDIST</function></link>,
@@ -19113,23 +13140,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>VAR</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>VAR</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>VAR</function> calculates sample variance of the given sample. To get the true variance of a complete population use VARP.</para>
<para><function>VAR</function> is also known as the N-1-variance. Under reasonable conditions, it is the maximum-likelihood estimator for the true variance.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>VAR</function>(A1:A5) equals 117.64.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -19151,26 +13168,31 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>VARA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <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. Under reasonable conditions, it is the maximum-likelihood estimator for the true variance</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>VARA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>))</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>VARA</function> calculates sample variance of the given sample.</para>
<para>To get the true variance of a complete population use VARPA.</para>
- <para><function>VARA</function> is also known as the N-1-variance.</para>
- <para>Under reasonable conditions, it is the maximum-likelihood estimator for the true variance.</para>
- <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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>VARA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>VARA</function>(A1:A5) equals 228.613.</para>
+ <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>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -19192,18 +13214,13 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>VARP</function>(<parameter>b1</parameter>,<parameter/> b2,<parameter/> ...)</synopsis>
+ <synopsis><function>VARP</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>VARP</function> calculates the variance of an entire population.</para>
<para><function>VARP</function> is also known as the N-variance.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>VARP</function>(A1:A5) equals 94.112.</para>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -19228,24 +13245,22 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>VARPA</function>(<parameter>number1</parameter>,<parameter>number2</parameter>,<parameter/>...)</synopsis>
+ <synopsis><function>VARPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>VARPA</function> calculates the variance of an entire population.</para>
<para><function>VARPA</function> is also known as the N-variance.</para>
- <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>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para><parameter>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>VARPA</function>(<parameter>area1</parameter>,<parameter>area2</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers and strings 11.4, 17.3, "missing", 25.9, and 40.1. Then</para>
- <para><function>VARPA</function>(A1:A5) equals 182.8904.</para>
+ <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>area1</parameter>: first cell area</para>
+ <para><parameter>area2</parameter>: second cell area</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -19271,26 +13286,11 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>WEIBULL</function> function returns the Weibull distribution. If the <parameter>cumulative</parameter> boolean is true it will return:</para>
- <para> 1 - exp (-(<parameter>x</parameter>/<parameter>beta</parameter>)^<parameter>alpha</parameter>),</para>
- <para>otherwise it will return</para>
- <para> (<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>
- <itemizedlist>
- <listitem>
- <para>If <parameter>x</parameter> < 0 <function>WEIBULL</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>alpha</parameter> <= 0 or <parameter>beta</parameter> <= 0 <function>WEIBULL</function> returns #NUM! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>WEIBULL</function>(3,2,4,0) equals 0.213668559.</para>
+ <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>See also</title>
@@ -19310,29 +13310,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>ZTEST</function>(<parameter>ref</parameter>,<parameter>x</parameter>[,<parameter>stddev</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>ZTEST</function> returns the two-tailed probability of a z-test.</para>
- <para><parameter>ref</parameter> is the data set and <parameter>x</parameter> is the value to be tested.</para>
- <para><parameter>stddev</parameter> is optionally an assumed standard deviation.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>ref</parameter> contains less than two data items <function>ZTEST</function> returns #DIV/0! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para>Let us assume that the cells A1, A2, ..., A5 contain numbers 11.4, 17.3, 21.3, 25.9, and 40.1. Then</para>
- <para><function>ZTEST</function>(A1:A5,20) equals 0.254717826.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CONFIDENCE"><function>CONFIDENCE</function></link>,
@@ -19360,20 +13337,24 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>ASC</function>(<parameter>string</parameter>)</synopsis>
+ <synopsis><function>ASC</function>(<parameter>text</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>ASC</function> a compatibility function that is meaningless in Gnumeric. In MS Excel (tm) it converts 2 byte <parameter>string</parameter> into single byte text.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>ASC</function>(<parameter>text</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para>CHAR("Foo") equals "Foo".</para>
+ <title>Description</title>
+ <para>The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/.</para>
+ <para><parameter>text</parameter>: string</para>
</refsect1>
<refsect1>
<title>See also</title>
- <para>
+ <para><link linkend="gnumeric-JIS"><function>JIS</function></link>.
</para>
</refsect1>
</refentry>
@@ -19394,12 +13375,40 @@
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CHAR</function> returns the ASCII character represented by the number <parameter>x</parameter>.</para>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>CHAR</function>(<parameter>x</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CHAR</function>(65) equals A.</para>
+ <title>Description</title>
+ <para><parameter>x</parameter> must be in the range 1 to 255.</para>
+ <para><parameter>x</parameter>: code point</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>CHAR</function>(<parameter>x</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard.</para>
+ <para><parameter>x</parameter>: code point</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>CHAR</function>(<parameter>x</parameter>))))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <para><parameter>x</parameter>: code point</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>CHAR</function>(<parameter>x</parameter>)))))</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function is Excel compatible.</para>
+ <para><parameter>x</parameter>: code point</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -19419,28 +13428,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CLEAN</function>(<parameter>string</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CLEAN</function> removes any non-printable characters from <parameter>string</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CLEAN</function>("one"\&char(7)) equals "one".</para>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para>
- </para>
- </refsect1>
</refentry>
<refentry id="gnumeric-CODE">
<refmeta>
@@ -19455,21 +13442,36 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>CODE</function>(<parameter>char</parameter>)</synopsis>
+ <synopsis><function>CODE</function>(<parameter>c</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>CODE</function> returns the ASCII number for the character <parameter>char</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <para><parameter>c</parameter> must be a valid CP1252 (Windows-1252) character.</para>
+ <para><parameter>c</parameter>: character</para>
</refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>CODE</function>(<parameter>c</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CODE</function>("A") equals 65.</para>
+ <title>Description</title>
+ <para>CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard.</para>
+ <para><parameter>c</parameter>: character</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>CODE</function>(<parameter>c</parameter>)))</synopsis>
+ </refsynopsisdiv>
+ <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>
+ <para><parameter>c</parameter>: character</para>
+ </refsect1>
+ <refsynopsisdiv>
+ <synopsis><function>CODE</function>(<parameter>c</parameter>))))</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function is Excel compatible.</para>
+ <para><parameter>c</parameter>: character</para>
</refsect1>
<refsect1>
<title>See also</title>
@@ -19489,23 +13491,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>CONCATENATE</function>(<parameter>string1</parameter>[,<parameter>string2</parameter>...])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>CONCATENATE</function> returns the string obtained by concatenation of the given strings.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>CONCATENATE</function>("aa","bb") equals "aabb".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LEFT"><function>LEFT</function></link>,
@@ -19526,23 +13511,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>DOLLAR</function>(<parameter>num</parameter>[,<parameter>decimals</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>DOLLAR</function> returns <parameter>num</parameter> formatted as currency.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>DOLLAR</function>(12345) equals "$12,345.00".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-FIXED"><function>FIXED</function></link>,
@@ -19563,24 +13531,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>EXACT</function>(<parameter>string1</parameter>,<parameter/> string2)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>EXACT</function> returns true if <parameter>string1</parameter> is exactly equal to <parameter>string2</parameter> (this routine is case sensitive).</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>EXACT</function>("key","key") equals TRUE.</para>
- <para><function>EXACT</function>("key","Key") equals FALSE.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LEN"><function>LEN</function></link>,
@@ -19601,23 +13551,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>FIND</function>(<parameter>string1</parameter>,<parameter>string2</parameter>[,<parameter>start</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>FIND</function> returns position of <parameter>string1</parameter> in <parameter>string2</parameter> (case-sensitive), searching only from character <parameter>start</parameter> onwards (assuming 1 if omitted).</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FIND</function>("ac","Jack") equals 2.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-EXACT"><function>EXACT</function></link>,
@@ -19627,6 +13560,31 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-FINDB">
+ <refmeta>
+ <refentrytitle>
+ <function>FINDB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>FINDB</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <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>
@@ -19639,28 +13597,45 @@
</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>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-JIS">
+ <refmeta>
+ <refentrytitle>
+ <function>JIS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>JIS</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
<refsynopsisdiv>
- <synopsis><function>FIXED</function>(<parameter>num</parameter>,<parameter/>[decimals,<parameter/> no_commas])</synopsis>
+ <synopsis><function>JIS</function>(<parameter>text</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>FIXED</function> returns <parameter>num</parameter> as a formatted string with <parameter>decimals</parameter> numbers after the decimal point, omitting commas if requested by <parameter>no_commas</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
+ <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>
+ <refsynopsisdiv>
+ <synopsis><function>JIS</function>(<parameter>text</parameter>))</synopsis>
+ </refsynopsisdiv>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>FIXED</function>(1234.567,2) equals "1,234.57".</para>
+ <title>Description</title>
+ <para>The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/.</para>
+ <para><parameter>text</parameter>: original text</para>
</refsect1>
<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><link linkend="gnumeric-ASC"><function>ASC</function></link>.
</para>
</refsect1>
</refentry>
@@ -19676,27 +13651,38 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LEFT</function>(<parameter>text</parameter>[,<parameter>num_chars</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LEFT</function> returns the leftmost <parameter>num_chars</parameter> characters or the left character if <parameter>num_chars</parameter> is not specified.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LEFT</function>("Directory",3) equals "Dir".</para>
+ <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/>
+ </refnamediv>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-RIGHT"><function>RIGHT</function></link>.
+ <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>
@@ -19712,23 +13698,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LEN</function>(<parameter>string</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LEN</function> returns the length in characters of the string <parameter>string</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LEN</function>("Helsinki") equals 8.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
@@ -19749,23 +13718,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LENB</function>(<parameter>string</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LENB</function> returns the length in bytes of the string <parameter>string</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LENB</function>("Helsinki") equals 8.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
@@ -19786,23 +13738,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>LOWER</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>LOWER</function> returns a lower-case version of the string in <parameter>text</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>LOWER</function>("J. F. Kennedy") equals "j. f. kennedy".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-UPPER"><function>UPPER</function></link>.
@@ -19821,27 +13756,39 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>MID</function>(<parameter>string</parameter>,<parameter/> position,<parameter/> length)</synopsis>
- </refsynopsisdiv>
<refsect1>
- <title>Description</title>
- <para><function>MID</function> returns a substring from <parameter>string</parameter> starting at <parameter>position</parameter> for <parameter>length</parameter> characters.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>MID</function>("testing",2,3) equals "est".</para>
+ <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>
</refsect1>
+ </refentry>
+ <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>.
+ <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>
@@ -19857,23 +13804,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PROPER</function>(<parameter>string</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>PROPER</function> returns <parameter>string</parameter> with initial of each word capitalised.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>PROPER</function>("j. f. kennedy") equals "J. F. Kennedy".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LOWER"><function>LOWER</function></link>,
@@ -19893,23 +13823,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>REPLACE</function>(<parameter>old</parameter>,<parameter>start</parameter>,<parameter>num</parameter>,<parameter>new</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>REPLACE</function> returns <parameter>old</parameter> with <parameter>new</parameter> replacing <parameter>num</parameter> characters from <parameter>start</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>REPLACE</function>("testing",2,3,"*****") equals "t*****ing".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-MID"><function>MID</function></link>,
@@ -19931,23 +13844,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>REPT</function>(<parameter>string</parameter>,<parameter>num</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>REPT</function> returns <parameter>num</parameter> repetitions of <parameter>string</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>REPT</function>(".",3) equals "...".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CONCATENATE"><function>CONCATENATE</function></link>.
@@ -19966,28 +13862,39 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>RIGHT</function>(<parameter>text</parameter>[,<parameter>num_chars</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>RIGHT</function> returns the rightmost <parameter>num_chars</parameter> characters or the right character if <parameter>num_chars</parameter> is not specified.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
<refsect1>
- <title>Examples</title>
- <para/>
- <para><function>RIGHT</function>("end") equals "d".</para>
- <para><function>RIGHT</function>("end",2) equals "nd".</para>
+ <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/>
+ </refnamediv>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-MID"><function>MID</function></link>,
- <link linkend="gnumeric-LEFT"><function>LEFT</function></link>.
+ <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>
@@ -20004,29 +13911,14 @@
<refpurpose/>
</refnamediv>
<refsynopsisdiv>
- <synopsis><function>SEARCH</function>(<parameter>search_string</parameter>,<parameter>text</parameter>[,<parameter>start_num</parameter>])</synopsis>
+ <synopsis><function>SEARCH</function>(<parameter>search</parameter>,<parameter>text</parameter>,<parameter>start</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para><function>SEARCH</function> returns the location of the <parameter>search_</parameter> string within <parameter>text</parameter>. The search starts with the <parameter>start_num</parameter> character of text <parameter>text</parameter>. If <parameter>start_num</parameter> is omitted, it is assumed to be one. The search is not case sensitive.</para>
- <para><parameter>search_string</parameter> can contain wildcard characters (*) and question marks (?). A question mark matches any character and a wildcard matches any string including the empty string. If you want the actual wildcard or question mark to be found, use tilde (~) before the character.</para>
- <itemizedlist>
- <listitem>
- <para>If <parameter>search_string</parameter> is not found, <function>SEARCH</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>If <parameter>start_num</parameter> is less than one or it is greater than the length of <parameter>text</parameter>, <function>SEARCH</function> returns #VALUE! error.</para>
- </listitem>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SEARCH</function>("c","Cancel") equals 1.</para>
- <para><function>SEARCH</function>("c","Cancel",2) equals 4.</para>
+ <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>See also</title>
@@ -20046,23 +13938,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>SUBSTITUTE</function>(<parameter>text</parameter>,<parameter/> old,<parameter/> new [,<parameter>num</parameter>])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>SUBSTITUTE</function> replaces <parameter>old</parameter> with <parameter>new</parameter> in <parameter>text</parameter>. Substitutions are only applied to instance <parameter>num</parameter> of <parameter>old</parameter> in <parameter>text</parameter>, otherwise every one is changed.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>SUBSTITUTE</function>("testing","test","wait") equals "waiting".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-REPLACE"><function>REPLACE</function></link>,
@@ -20082,24 +13957,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>T</function>(<parameter>value</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>T</function> returns <parameter>value</parameter> if and only if it is text, otherwise a blank string.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>T</function>("text") equals "text".</para>
- <para><function>T</function>(64) returns an empty cell.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CELL"><function>CELL</function></link>,
@@ -20120,24 +13977,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>TEXT</function>(<parameter>value</parameter>,<parameter>format_text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TEXT</function> returns <parameter>value</parameter> as a string with the specified format.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TEXT</function>(3.223,"$0.00") equals "$3.22".</para>
- <para><function>TEXT</function>(date(1999,4,15),"mmmm, dd, yy") equals "April, 15, 99".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>,
@@ -20158,23 +13997,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>TRIM</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>TRIM</function> returns <parameter>text</parameter> with only single spaces between words.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>TRIM</function>(" a bbb cc") equals "a bbb cc".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CLEAN"><function>CLEAN</function></link>,
@@ -20196,19 +14018,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>UNICHAR</function>(<parameter>x</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>UNICHAR</function> returns the Unicode character represented by the number <parameter>x</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>UNICHAR</function>(65) equals A.</para>
- <para><function>UNICHAR</function>(960) equals a small Greek pi.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-CHAR"><function>CHAR</function></link>,
@@ -20229,18 +14038,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>UNICODE</function>(<parameter>char</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>UNICODE</function> returns the Unicode number for the character <parameter>char</parameter>.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>UNICODE</function>("A") equals 65.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-UNICHAR"><function>UNICHAR</function></link>,
@@ -20261,23 +14058,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>UPPER</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>UPPER</function> returns a upper-case version of the string in <parameter>text</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>UPPER</function>("cancelled") equals "CANCELLED".</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-LOWER"><function>LOWER</function></link>.
@@ -20296,23 +14076,6 @@
</refname>
<refpurpose/>
</refnamediv>
- <refsynopsisdiv>
- <synopsis><function>VALUE</function>(<parameter>text</parameter>)</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para><function>VALUE</function> returns numeric value of <parameter>text</parameter>.</para>
- <itemizedlist>
- <listitem>
- <para>This function is Excel compatible.</para>
- </listitem>
- </itemizedlist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- <para><function>VALUE</function>("$1,000") equals 1000.</para>
- </refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-DOLLAR"><function>DOLLAR</function></link>,
@@ -20322,115 +14085,4 @@
</refsect1>
</refentry>
</sect1>
- <sect1 id="CATEGORY_Time_Series_Analysis">
- <title>Time Series Analysis</title>
- <refentry id="gnumeric-INTERPOLATION">
- <refmeta>
- <refentrytitle>
- <function>INTERPOLATION</function>
- </refentrytitle>
- </refmeta>
- <refnamediv>
- <refname>
- <function>INTERPOLATION</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/>
- <para><function>INTERPOLATION</function> returns interpolated values corresponding</para>
- <para>to the given abscissa targets as a one column matrix.</para>
- <para><parameter>abscissas</parameter> are the absicssas of the data to interpolate.</para>
- <para><parameter>ordinates</parameter> are the ordinates of the data to interpolate.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells in <parameter>abscissas</parameter> and <parameter>ordinates</parameter> are simply ignored.</para>
- </listitem>
- </itemizedlist>
- <para><parameter>targets</parameter> are the abscissas of the interpolated data. If several data</para>
- <para>are provided, they must be in the same column, in consecutive cells</para>
- <para><parameter>interpolation</parameter> is the method to be used for the interpolation;</para>
- <para>possible values 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>
- <para>If an averaging method is used, the number of returned values</para>
- <para>is one less than the number of targets since the evaluation is made by</para>
- <para>averaging the interpolation over the interval between two consecutive data;</para>
- <para>in that case, the targets values must be given in increasing order.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <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/>
- </refnamediv>
- <refsynopsisdiv>
- <synopsis><function>PERIODOGRAM</function>(<parameter>ordinates</parameter>,<parameter/>[filter,<parameter/>[abscissas,<parameter/>[interpolation,<parameter/>[number]]]])</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para/>
- <para>periodogram returns the periodogram of the data</para>
- <para>as a one column matrix.</para>
- <para><parameter>ordinates</parameter> are the ordinates of the data to interpolate.</para>
- <para><parameter>filter</parameter> gives the window function to be used. Possible values 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>
- <para><parameter>abscissas</parameter> are the absicssas of the data to interpolate. If no</para>
- <para>abscissa is given, it is supposed that the data absicssas are regularly</para>
- <para>spaced. Otherwise, an interpolation method will be used to evaluate</para>
- <para>regularly spaced data.</para>
- <itemizedlist>
- <listitem>
- <para>Strings and empty cells in <parameter>abscissas</parameter> and <parameter>ordinates</parameter> are simply ignored.</para>
- </listitem>
- </itemizedlist>
- <para><parameter>interpolation</parameter> is the method to be used for the interpolation;</para>
- <para>possible values 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>
- <para><parameter>number</parameter> is the number of interpolated data to be used. If not given,</para>
- <para>a default number is automatically evaluated.</para>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para/>
- </refsect1>
- <refsect1>
- <title>See also</title>
- <para><link linkend="gnumeric-INTERPOLATION"><function>INTERPOLATION</function></link>.
- </para>
- </refsect1>
- </refentry>
- </sect1>
</appendix>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
