[gnumeric] funcs: fix various help texts.
- From: Morten Welinder <mortenw src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gnumeric] funcs: fix various help texts.
- Date: Sun, 1 Nov 2009 23:47:11 +0000 (UTC)
commit dfe3794b9251ee2516b067d6ec54144e26e00b30
Author: Morten Welinder <terra gnome org>
Date: Sun Nov 1 18:46:52 2009 -0500
funcs: fix various help texts.
doc/C/func.defs | 177 ++++++++++++-
doc/C/functions.xml | 616 ++++++++++++++++++++++++++++++++++++++++-
plugins/fn-random/functions.c | 8 +-
plugins/fn-stat/functions.c | 1 -
plugins/fn-string/functions.c | 2 +-
5 files changed, 796 insertions(+), 8 deletions(-)
---
diff --git a/doc/C/func.defs b/doc/C/func.defs
index 84b3e87..080ad04 100644
--- a/doc/C/func.defs
+++ b/doc/C/func.defs
@@ -551,6 +551,22 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
@NOTE=If the summary data is unavailable, GETPIVOTDATA returns #REF!
@CATEGORY=Date/Time
+ FUNCTION=ASCENSIONTHURSDAY
+ SYNTAX=ASCENSIONTHURSDAY(year)
+ DESCRIPTION=
+ {year}: year between 1582 and 9956, defaults to the year of the next Ascension Thursday
+ NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.
+ SEEALSO=EASTERSUNDAY
+
+ CATEGORY=Date/Time
+ FUNCTION=ASHWEDNESDAY
+ SYNTAX=ASHWEDNESDAY(year)
+ DESCRIPTION=
+ {year}: year between 1582 and 9956, defaults to the year of the next Ash Wednesday
+ NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.
+ SEEALSO=EASTERSUNDAY
+
+ CATEGORY=Date/Time
@FUNCTION=DATE
@SYNTAX=DATE(year,month,day)
@DESCRIPTION=The DATE 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.
@@ -600,6 +616,15 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
@SEEALSO=DATE,YEAR,MONTH
@CATEGORY=Date/Time
+ FUNCTION=DAYS
+ SYNTAX=DAYS(start_date,end_date)
+ DESCRIPTION=DAYS returns the positive or negative number of days from @{start_date} to @{end_date}.
+ {start_date}: starting date serial value
+ {end_date}: ending date serial value
+
+ SEEALSO=DATEDIF
+
+ CATEGORY=Date/Time
@FUNCTION=DAYS360
@SYNTAX=DAYS360(start_date,end_date,method)
@DESCRIPTION=DAYS360 returns the number of days from @{start_date} to @{end_date}.
@@ -613,6 +638,14 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
@SEEALSO=DATEDIF
@CATEGORY=Date/Time
+ FUNCTION=EASTERSUNDAY
+ SYNTAX=EASTERSUNDAY(year)
+ DESCRIPTION=
+ {year}: year between 1582 and 9956, defaults to the year of the next Easter Sunday
+ NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.
+ SEEALSO=ASHWEDNESDAY
+
+ CATEGORY=Date/Time
@FUNCTION=EDATE
@SYNTAX=EDATE(date,months)
@DESCRIPTION=EDATE returns @{date} moved forward or backward the number of months specified by @{months}.
@@ -631,6 +664,38 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
@SEEALSO=EDATE
@CATEGORY=Date/Time
+ FUNCTION=GOODFRIDAY
+ SYNTAX=GOODFRIDAY(year)
+ DESCRIPTION=
+ {year}: year between 1582 and 9956, defaults to the year of the next Good Friday
+ NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.
+ SEEALSO=EASTERSUNDAY
+
+ CATEGORY=Date/Time
+ FUNCTION=HDATE
+ SEEALSO=HDATE_HEB,DATE
+
+ CATEGORY=Date/Time
+ FUNCTION=HDATE_DAY
+ SEEALSO=HDATE_JULIAN
+
+ CATEGORY=Date/Time
+ FUNCTION=HDATE_HEB
+ SEEALSO=HDATE,DATE
+
+ CATEGORY=Date/Time
+ FUNCTION=HDATE_JULIAN
+ SEEALSO=HDATE
+
+ CATEGORY=Date/Time
+ FUNCTION=HDATE_MONTH
+ SEEALSO=HDATE_JULIAN
+
+ CATEGORY=Date/Time
+ FUNCTION=HDATE_YEAR
+ SEEALSO=HDATE_JULIAN
+
+ CATEGORY=Date/Time
@FUNCTION=HOUR
@SYNTAX=HOUR(time)
@DESCRIPTION=The HOUR function computes the hour part of the fractional day given by @{time}.
@@ -690,6 +755,14 @@ The natural logarithm is not uniquely defined on complex numbers. You may need t
@SEEALSO=DATE
@CATEGORY=Date/Time
+ FUNCTION=PENTECOSTSUNDAY
+ SYNTAX=PENTECOSTSUNDAY(year)
+ DESCRIPTION=
+ {year}: year between 1582 and 9956, defaults to the year of the next Pentecost Sunday
+ NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.
+ SEEALSO=EASTERSUNDAY
+
+ CATEGORY=Date/Time
@FUNCTION=SECOND
@SYNTAX=SECOND(time)
@DESCRIPTION=The SECOND function computes the seconds part of the fractional day given by @{time}.
@@ -2386,7 +2459,7 @@ If any argument is zero, the result is zero.
@CATEGORY=Information
@FUNCTION=GET.FORMULA
- SEEALSO=EXPRESSION
+ SEEALSO=EXPRESSION,ISFORMULA
@CATEGORY=Information
@FUNCTION=GETENV
@@ -2432,6 +2505,10 @@ If any argument is zero, the result is zero.
@SEEALSO=ISODD
@CATEGORY=Information
+ FUNCTION=ISFORMULA
+ SEEALSO=GET_FORMULA
+
+ CATEGORY=Information
@FUNCTION=ISLOGICAL
@SYNTAX=ISLOGICAL(value)
@DESCRIPTION=This function checks if a value is either TRUE or FALSE.
@@ -2531,6 +2608,15 @@ If any argument is zero, the result is zero.
@SEEALSO=IF,ISERROR
@CATEGORY=Logic
+ FUNCTION=IFNA
+ SYNTAX=IFNA(x,y)
+ DESCRIPTION=This function returns the first value, unless that is #NA!, in which case it returns the second.
+ {x}: value to test for #NA! error.
+ {y}: alternate value.
+
+ SEEALSO=IF,ISERROR
+
+ CATEGORY=Logic
@FUNCTION=NOT
@SYNTAX=NOT(b)
@DESCRIPTION=NOT calculates the logical negation of its argument.
@@ -2726,6 +2812,22 @@ If any argument is zero, the result is zero.
@SEEALSO=COLUMN,COLUMNS,ROW
@CATEGORY=Lookup
+ FUNCTION=SHEET
+ SYNTAX=SHEET(reference)
+ DESCRIPTION=
+ {reference}: reference or literal sheet name, defaults to the current sheet
+ NOTE=If @{reference} is neither a reference nor a literal sheet name, SHEETS returns #VALUE!
+ SEEALSO=SHEETS,ROW,COLUMNNUMBER
+
+ CATEGORY=Lookup
+ FUNCTION=SHEETS
+ SYNTAX=SHEETS(reference)
+ DESCRIPTION=
+ {reference}: array, reference, or range, defaults to the maximum range
+ NOTE=If @{reference} is neither an array nor a reference nor a range, SHEETS returns #VALUE!
+ SEEALSO=COLUMNS,ROWS
+
+ CATEGORY=Lookup
@FUNCTION=TRANSPOSE
@SEEALSO=MMULT
@@ -3580,6 +3682,20 @@ Strings and empty cells are simply ignored.
@SEEALSO=RAND,RANDRAYLEIGH
@CATEGORY=Random Numbers
+ FUNCTION=RANDSNORM
+ SYNTAX=RANDSNORM(a,μ,Ï?)
+ DESCRIPTION=
+ {a}: amount of skew, defaults to 0
+ {μ}: mean of the underlying normal distribution, defaults to 0
+ {Ï?}: standard deviation of the underlying normal distribution, defaults to 1
+ NOTE=If @{Ï?} < 0, RANDSNORM returns #NUM!
+ SEEALSO=RANDNORM
+
+ CATEGORY=Random Numbers
+ FUNCTION=RANDSTDIST
+ SEEALSO=RANDTDIST
+
+ CATEGORY=Random Numbers
@FUNCTION=RANDTDIST
@SEEALSO=RAND
@@ -3662,6 +3778,20 @@ The successive use of the simulation tool also requires that you give to the too
@SEEALSO=BETADIST
@CATEGORY=Statistics
+ FUNCTION=BINOM DIST RANGE
+ SYNTAX=BINOM DIST RANGE(trials,p,start,end)
+ DESCRIPTION=
+ {trials}: number of trials
+ {p}: probability of success in each trial
+ {start}: start of the interval
+ {end}: start of the interval, defaults to @{start}
+ NOTE=If @{start}, @{end} or @{trials} are non-integer they are truncated.
+ NOTE=If @{trials} < 0 this function returns a #NUM! error.
+ NOTE=If @{p} < 0 or @{p} > 1 this function returns a #NUM! error.
+ NOTE=If @{start} > @{end} this function returns 0.
+ SEEALSO=BINOMDIST,R.PBINOM
+
+ CATEGORY=Statistics
@FUNCTION=BINOMDIST
@SYNTAX=BINOMDIST(n,trials,p,cumulative)
@DESCRIPTION=.
@@ -4401,6 +4531,29 @@ The successive use of the simulation tool also requires that you give to the too
@SEEALSO=R.PPOIS,R.QPOIS
@CATEGORY=Statistics
+ FUNCTION=R DSNORM
+ SYNTAX=R DSNORM(x,shape,location,scale,give_log)
+ DESCRIPTION=This function returns the probability density function of the skew-normal distribution.
+ {x}: observation
+ {shape}: the shape parameter of the distribution
+ {location}: the location parameter of the distribution
+ {scale}: the scale parameter of the distribution
+ {give_log}: if true, log of the result will be returned instead
+
+ SEEALSO=R PSNORM
+
+ CATEGORY=Statistics
+ FUNCTION=R DST
+ SYNTAX=R DST(x,n,shape,give_log)
+ DESCRIPTION=This function returns the probability density function of the skew-t distribution.
+ {x}: observation
+ {n}: the number of degrees of freedom of the distribution
+ {shape}: the shape parameter of the distribution
+ {give_log}: if true, log of the result will be returned instead
+
+ SEEALSO=
+
+ CATEGORY=Statistics
@FUNCTION=R.DT
@SYNTAX=R.DT(x,n,give_log)
@DESCRIPTION=This function returns the probability density function of the Student t distribution.
@@ -4575,6 +4728,19 @@ The successive use of the simulation tool also requires that you give to the too
@SEEALSO=R.DPOIS,R.QPOIS
@CATEGORY=Statistics
+ FUNCTION=R PSNORM
+ SYNTAX=R PSNORM(x,shape,location,scale,lower_tail,log_p)
+ DESCRIPTION=This function returns the cumulative distribution function of the skew-normal distribution.
+ {x}: observation
+ {shape}: the shape parameter of the distribution
+ {location}: the location parameter of the distribution
+ {scale}: the scale parameter of the distribution
+ {lower_tail}: if true (the default), the lower tail of the distribution is considered
+ {log_p}: if true, log of the probability is used
+
+ SEEALSO=R DSNORM
+
+ CATEGORY=Statistics
@FUNCTION=R.PT
@SYNTAX=R.PT(x,n,lower_tail,log_p)
@DESCRIPTION=This function returns the cumulative distribution function of the Student t distribution.
@@ -5166,6 +5332,15 @@ The successive use of the simulation tool also requires that you give to the too
@SEEALSO=LEFTB,RIGHTB,LENB,LEFT,MID,RIGHT,LEN
@CATEGORY=String
+ FUNCTION=NUMBERVALUE
+ SYNTAX=NUMBERVALUE(text,separator)
+ DESCRIPTION=
+ {text}: string
+ {separator}: decimal separator
+ NOTE=If @{text} does not look like a decimal number, NUMBERVALUE returns the value VALUE would return (ignoring the given @{separator}).
+ SEEALSO=VALUE
+
+ CATEGORY=String
@FUNCTION=PROPER
@SEEALSO=LOWER,UPPER
diff --git a/doc/C/functions.xml b/doc/C/functions.xml
index 8a651e9..e4423de 100644
--- a/doc/C/functions.xml
+++ b/doc/C/functions.xml
@@ -1909,6 +1909,66 @@
</sect1>
<sect1 id="CATEGORY_DateTime">
<title>Date/Time</title>
+ <refentry id="gnumeric-ASCENSIONTHURSDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>ASCENSIONTHURSDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ASCENSIONTHURSDAY</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASCENSIONTHURSDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Ascension Thursday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-ASHWEDNESDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>ASHWEDNESDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ASHWEDNESDAY</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>ASHWEDNESDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Ash Wednesday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-DATE">
<refmeta>
<refentrytitle>
@@ -2070,6 +2130,33 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-DAYS">
+ <refmeta>
+ <refentrytitle>
+ <function>DAYS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>DAYS</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>DAYS</function>(<parameter>start_date</parameter>,<parameter>end_date</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para><function>DAYS</function> returns the positive or negative number of days from <parameter>start_date</parameter> to <parameter>end_date</parameter>.</para>
+ <para><parameter>start_date</parameter>: starting date serial value</para>
+ <para><parameter>end_date</parameter>: ending date serial value</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-DATEDIF"><function>DATEDIF</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-DAYS360">
<refmeta>
<refentrytitle>
@@ -2110,6 +2197,36 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-EASTERSUNDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>EASTERSUNDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>EASTERSUNDAY</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>EASTERSUNDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Easter Sunday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-ASHWEDNESDAY"><function>ASHWEDNESDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-EDATE">
<refmeta>
<refentrytitle>
@@ -2164,6 +2281,146 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-GOODFRIDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>GOODFRIDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>GOODFRIDAY</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>GOODFRIDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Good Friday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_HEB"><function>HDATE_HEB</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_DAY">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_DAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_DAY</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_HEB">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_HEB</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_HEB</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE"><function>HDATE</function></link>,
+ <link linkend="gnumeric-DATE"><function>DATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_JULIAN">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_JULIAN</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_JULIAN</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE"><function>HDATE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_MONTH">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_MONTH</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_MONTH</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-HDATE_YEAR">
+ <refmeta>
+ <refentrytitle>
+ <function>HDATE_YEAR</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>HDATE_YEAR</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-HDATE_JULIAN"><function>HDATE_JULIAN</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-HOUR">
<refmeta>
<refentrytitle>
@@ -2363,6 +2620,36 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-PENTECOSTSUNDAY">
+ <refmeta>
+ <refentrytitle>
+ <function>PENTECOSTSUNDAY</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>PENTECOSTSUNDAY</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>PENTECOSTSUNDAY</function>(<parameter>year</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>year</parameter>: year between 1582 and 9956, defaults to the year of the next Pentecost Sunday</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-EASTERSUNDAY"><function>EASTERSUNDAY</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-SECOND">
<refmeta>
<refentrytitle>
@@ -7178,7 +7465,8 @@
</refnamediv>
<refsect1>
<title>See also</title>
- <para><link linkend="gnumeric-EXPRESSION"><function>EXPRESSION</function></link>.
+ <para><link linkend="gnumeric-EXPRESSION"><function>EXPRESSION</function></link>,
+ <link linkend="gnumeric-ISFORMULA"><function>ISFORMULA</function></link>.
</para>
</refsect1>
</refentry>
@@ -7321,6 +7609,24 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-ISFORMULA">
+ <refmeta>
+ <refentrytitle>
+ <function>ISFORMULA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>ISFORMULA</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-GET_FORMULA"><function>GET_FORMULA</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-ISLOGICAL">
<refmeta>
<refentrytitle>
@@ -7659,6 +7965,34 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-IFNA">
+ <refmeta>
+ <refentrytitle>
+ <function>IFNA</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>IFNA</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>IFNA</function>(<parameter>x</parameter>,<parameter>y</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the first value, unless that is #NA!, in which case it returns the second.</para>
+ <para><parameter>x</parameter>: value to test for #NA! error.</para>
+ <para><parameter>y</parameter>: alternate value.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-IF"><function>IF</function></link>,
+ <link linkend="gnumeric-ISERROR"><function>ISERROR</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-NOT">
<refmeta>
<refentrytitle>
@@ -8310,6 +8644,69 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-SHEET">
+ <refmeta>
+ <refentrytitle>
+ <function>SHEET</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SHEET</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SHEET</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>reference</parameter>: reference or literal sheet name, defaults to the current sheet</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither a reference nor a literal sheet name, SHEETS returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-SHEETS"><function>SHEETS</function></link>,
+ <link linkend="gnumeric-ROW"><function>ROW</function></link>,
+ <link linkend="gnumeric-COLUMNNUMBER"><function>COLUMNNUMBER</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-SHEETS">
+ <refmeta>
+ <refentrytitle>
+ <function>SHEETS</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>SHEETS</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>SHEETS</function>(<parameter>reference</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>reference</parameter>: array, reference, or range, defaults to the maximum range</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>reference</parameter> is neither an array nor a reference nor a range, <function>SHEETS</function> returns #VALUE!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-COLUMNS"><function>COLUMNS</function></link>,
+ <link linkend="gnumeric-ROWS"><function>ROWS</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-TRANSPOSE">
<refmeta>
<refentrytitle>
@@ -11560,6 +11957,56 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-RANDSNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDSNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDSNORM</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>RANDSNORM</function>(<parameter>a</parameter>,<parameter/>μ,<parameter/>Ï?)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>a</parameter>: amount of skew, defaults to 0</para>
+ <para>@{μ}: mean of the underlying normal distribution, defaults to 0</para>
+ <para>@{Ï?}: standard deviation of the underlying normal distribution, defaults to 1</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If @{Ï?} < 0, <function>RANDSNORM</function> returns #NUM!</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDNORM"><function>RANDNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-RANDSTDIST">
+ <refmeta>
+ <refentrytitle>
+ <function>RANDSTDIST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>RANDSTDIST</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-RANDTDIST"><function>RANDTDIST</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-RANDTDIST">
<refmeta>
<refentrytitle>
@@ -11838,6 +12285,52 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-BINOM.DIST.RANGE">
+ <refmeta>
+ <refentrytitle>
+ <function>BINOM.DIST.RANGE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>BINOM.DIST.RANGE</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>BINOM.DIST.RANGE</function>(<parameter>trials</parameter>,<parameter>p</parameter>,<parameter>start</parameter>,<parameter>end</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>trials</parameter>: number of trials</para>
+ <para><parameter>p</parameter>: probability of success in each trial</para>
+ <para><parameter>start</parameter>: start of the interval</para>
+ <para><parameter>end</parameter>: start of the interval, defaults to <parameter>start</parameter></para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>start</parameter>, <parameter>end</parameter> or <parameter>trials</parameter> are non-integer they are truncated.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>trials</parameter> < 0 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>p</parameter> < 0 or <parameter>p</parameter> > 1 this function returns a #NUM! error.</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>start</parameter> > <parameter>end</parameter> this function returns 0.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-BINOMDIST"><function>BINOMDIST</function></link>,
+ <link linkend="gnumeric-R.PBINOM"><function>R.PBINOM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-BINOMDIST">
<refmeta>
<refentrytitle>
@@ -14278,6 +14771,65 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-R.DSNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DSNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DSNORM</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DSNORM</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the skew-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>location</parameter>: the location parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.PSNORM"><function>R.PSNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
+ <refentry id="gnumeric-R.DST">
+ <refmeta>
+ <refentrytitle>
+ <function>R.DST</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.DST</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.DST</function>(<parameter>x</parameter>,<parameter>n</parameter>,<parameter>shape</parameter>,<parameter>give_log</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the probability density function of the skew-t distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>n</parameter>: the number of degrees of freedom of the distribution</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>give_log</parameter>: if true, log of the result will be returned instead</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-R.DT">
<refmeta>
<refentrytitle>
@@ -14737,6 +15289,37 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-R.PSNORM">
+ <refmeta>
+ <refentrytitle>
+ <function>R.PSNORM</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>R.PSNORM</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>R.PSNORM</function>(<parameter>x</parameter>,<parameter>shape</parameter>,<parameter>location</parameter>,<parameter>scale</parameter>,<parameter>lower_tail</parameter>,<parameter>log_p</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>This function returns the cumulative distribution function of the skew-normal distribution.</para>
+ <para><parameter>x</parameter>: observation</para>
+ <para><parameter>shape</parameter>: the shape parameter of the distribution</para>
+ <para><parameter>location</parameter>: the location parameter of the distribution</para>
+ <para><parameter>scale</parameter>: the scale parameter of the distribution</para>
+ <para><parameter>lower_tail</parameter>: if true (the default), the lower tail of the distribution is considered</para>
+ <para><parameter>log_p</parameter>: if true, log of the probability is used</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-R.DSNORM"><function>R.DSNORM</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-R.PT">
<refmeta>
<refentrytitle>
@@ -16677,6 +17260,37 @@
</para>
</refsect1>
</refentry>
+ <refentry id="gnumeric-NUMBERVALUE">
+ <refmeta>
+ <refentrytitle>
+ <function>NUMBERVALUE</function>
+ </refentrytitle>
+ </refmeta>
+ <refnamediv>
+ <refname>
+ <function>NUMBERVALUE</function>
+ </refname>
+ <refpurpose/>
+ </refnamediv>
+ <refsynopsisdiv>
+ <synopsis><function>NUMBERVALUE</function>(<parameter>text</parameter>,<parameter>separator</parameter>)</synopsis>
+ </refsynopsisdiv>
+ <refsect1>
+ <title>Description</title>
+ <para>.</para>
+ <para><parameter>text</parameter>: string</para>
+ <para><parameter>separator</parameter>: decimal separator</para>
+ </refsect1>
+ <refsect1>
+ <title>Note</title>
+ <para>If <parameter>text</parameter> does not look like a decimal number, <function>NUMBERVALUE</function> returns the value VALUE would return (ignoring the given <parameter>separator</parameter>).</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para><link linkend="gnumeric-VALUE"><function>VALUE</function></link>.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="gnumeric-PROPER">
<refmeta>
<refentrytitle>
diff --git a/plugins/fn-random/functions.c b/plugins/fn-random/functions.c
index a21e29f..d4f5b94 100644
--- a/plugins/fn-random/functions.c
+++ b/plugins/fn-random/functions.c
@@ -879,7 +879,7 @@ gnumeric_simtable (GnmFuncEvalInfo *ei, int argc, GnmExprConstPtr const *argv)
/***************************************************************************/
static GnmFuncHelp const help_randsnorm[] = {
- { GNM_FUNC_HELP_NAME, F_("RANDNORM:random variate from a skew normal distribution") },
+ { GNM_FUNC_HELP_NAME, F_("RANDSNORM:random variate from a skew normal distribution") },
{ GNM_FUNC_HELP_ARG, F_("a: amount of skew, defaults to 0") },
{ GNM_FUNC_HELP_ARG, F_("\xce\xbc:mean of the underlying normal distribution, defaults to 0") },
{ GNM_FUNC_HELP_ARG, F_("\xcf\x83:standard deviation of the underlying normal distribution, defaults to 1") },
@@ -897,13 +897,13 @@ gnumeric_randsnorm (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
gnm_float mean = 0.;
gnm_float stdev = 1.;
gnm_float result;
-
+
if (argv[0]) {
alpha = value_get_as_float (argv[0]);
if (argv[1]) {
mean = value_get_as_float (argv[1]);
if (argv[2])
- stdev = value_get_as_float (argv[2]);
+ stdev = value_get_as_float (argv[2]);
}
}
@@ -933,7 +933,7 @@ gnumeric_randstdist (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
gnm_float nu = value_get_as_float (argv[0]);
gnm_float alpha = argv[1] ? value_get_as_float (argv[1]) : 0.;
- return ((alpha == 0.) ? value_new_float (random_tdist (nu))
+ return ((alpha == 0.) ? value_new_float (random_tdist (nu))
: value_new_float (random_skew_tdist (nu, alpha)));;
}
diff --git a/plugins/fn-stat/functions.c b/plugins/fn-stat/functions.c
index 39b4297..484f12b 100644
--- a/plugins/fn-stat/functions.c
+++ b/plugins/fn-stat/functions.c
@@ -1429,7 +1429,6 @@ gnumeric_binomdist (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
static GnmFuncHelp const help_binom_dist_range[] = {
{ GNM_FUNC_HELP_NAME, F_("BINOM.DIST.RANGE:probability of the binomial distribution over an interval")},
- { GNM_FUNC_HELP_ARG, F_("n:number of successes")},
{ GNM_FUNC_HELP_ARG, F_("trials:number of trials")},
{ GNM_FUNC_HELP_ARG, F_("p:probability of success in each trial")},
{ GNM_FUNC_HELP_ARG, F_("start:start of the interval")},
diff --git a/plugins/fn-string/functions.c b/plugins/fn-string/functions.c
index c667cee..819bc20 100644
--- a/plugins/fn-string/functions.c
+++ b/plugins/fn-string/functions.c
@@ -1045,7 +1045,7 @@ gnumeric_value (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
/***************************************************************************/
static GnmFuncHelp const help_numbervalue[] = {
- { GNM_FUNC_HELP_NAME, F_("VALUE:numeric value of @{text}")},
+ { GNM_FUNC_HELP_NAME, F_("NUMBERVALUE:numeric value of @{text}")},
{ GNM_FUNC_HELP_ARG, F_("text:string")},
{ GNM_FUNC_HELP_ARG, F_("separator:decimal separator")},
{ GNM_FUNC_HELP_NOTE, F_("If @{text} does not look like a decimal number, "
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
