[gnumeric] Introspection: even more docs.



commit 092449d8f2cb3b552669067f113719d7a840d77d
Author: Morten Welinder <terra gnome org>
Date:   Fri Mar 22 15:59:54 2013 -0400

    Introspection: even more docs.

 plugins/fn-r/generate |    4 --
 src/mathfunc.h        |   10 ++--
 src/outoflinedocs.c   |  140 +++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 145 insertions(+), 9 deletions(-)
---
diff --git a/plugins/fn-r/generate b/plugins/fn-r/generate
index 2f06350..53e18f7 100644
--- a/plugins/fn-r/generate
+++ b/plugins/fn-r/generate
@@ -100,8 +100,6 @@ my %argoverride = ();
         ({ 'n' => 'the number of trials',
            'psuc' => "the probability of success in each trial",
            @common })];
-    $argoverride{"dnbinom:p"} = $argoverride{"pnbinom:p"} = $argoverride{"qnbinom:pr"} =
-       "psuc";
 
     $funcs{'dhyper'} = $funcs{'phyper'} = $funcs{'qhyper'} =
        [\&distribution,
@@ -110,8 +108,6 @@ my %argoverride = ();
            'b' => "the number of black balls",
            'n' => "the number of balls drawn",     
            @common })];
-    $argoverride{"phyper:NR"} = $argoverride{"qhyper:NR"} = 'r';
-    $argoverride{"phyper:NB"} = $argoverride{"qhyper:NB"} = 'b';
 
     $funcs{'dcauchy'} = $funcs{'pcauchy'} = $funcs{'qcauchy'} =
        [\&distribution,
diff --git a/src/mathfunc.h b/src/mathfunc.h
index 16f29e9..73304f8 100644
--- a/src/mathfunc.h
+++ b/src/mathfunc.h
@@ -107,14 +107,14 @@ gnm_float pbinom2 (gnm_float x0, gnm_float x1, gnm_float n, gnm_float p);
 gnm_float qbinom (gnm_float p, gnm_float n, gnm_float psuc, gboolean lower_tail, gboolean log_p);
 
 /* Negative binomial distribution.  */
-gnm_float dnbinom (gnm_float x, gnm_float n, gnm_float p, gboolean give_log);
-gnm_float pnbinom (gnm_float x, gnm_float n, gnm_float p, gboolean lower_tail, gboolean log_p);
-gnm_float qnbinom (gnm_float p, gnm_float n, gnm_float pr, gboolean lower_tail, gboolean log_p);
+gnm_float dnbinom (gnm_float x, gnm_float n, gnm_float psuc, gboolean give_log);
+gnm_float pnbinom (gnm_float x, gnm_float n, gnm_float psuc, gboolean lower_tail, gboolean log_p);
+gnm_float qnbinom (gnm_float p, gnm_float n, gnm_float psuc, gboolean lower_tail, gboolean log_p);
 
 /* Hyper-geometrical distribution.  */
 gnm_float dhyper (gnm_float x, gnm_float r, gnm_float b, gnm_float n, gboolean give_log);
-gnm_float phyper (gnm_float x, gnm_float NR, gnm_float NB, gnm_float n, gboolean lower_tail, gboolean log_p);
-gnm_float qhyper (gnm_float p, gnm_float NR, gnm_float NB, gnm_float n, gboolean lower_tail, gboolean log_p);
+gnm_float phyper (gnm_float x, gnm_float r, gnm_float b, gnm_float n, gboolean lower_tail, gboolean log_p);
+gnm_float qhyper (gnm_float p, gnm_float r, gnm_float b, gnm_float n, gboolean lower_tail, gboolean log_p);
 
 /* Geometric distribution.  */
 gnm_float dgeom (gnm_float x, gnm_float psuc, gboolean give_log);
diff --git a/src/outoflinedocs.c b/src/outoflinedocs.c
index 189c7c4..847d564 100644
--- a/src/outoflinedocs.c
+++ b/src/outoflinedocs.c
@@ -421,3 +421,143 @@
  */
 
 /* ------------------------------------------------------------------------- */
+
+/**
+ * dexp:
+ * @x: observation
+ * @scale: the scale parameter of the distribution
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the exponential distribution.
+ */
+
+/**
+ * pexp:
+ * @x: observation
+ * @scale: the scale parameter of the distribution
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: cumulative density of the exponential distribution.
+ */
+
+/**
+ * qexp:
+ * @p: probability
+ * @scale: the scale parameter of the distribution
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, @p is given as log probability
+ *
+ * Returns: the observation with cumulative probability @p for the
+ * exponential distribution.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * dbinom:
+ * @x: observation
+ * @n: the number of trials
+ * @psuc: the probability of success in each trial
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the binomial distribution.
+ */
+
+/**
+ * pbinom:
+ * @x: observation
+ * @n: the number of trials
+ * @psuc: the probability of success in each trial
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: cumulative density of the binomial distribution.
+ */
+
+/**
+ * qbinom:
+ * @p: probability
+ * @n: the number of trials
+ * @psuc: the probability of success in each trial
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, @p is given as log probability
+ *
+ * Returns: the observation with cumulative probability @p for the
+ * binomial distribution.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * dnbinom:
+ * @x: observation
+ * @n: the number of trials
+ * @psuc: the probability of success in each trial
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the negative binomial distribution.
+ */
+
+/**
+ * pnbinom:
+ * @x: observation
+ * @n: the number of trials
+ * @psuc: the probability of success in each trial
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: cumulative density of the negative binomial distribution.
+ */
+
+/**
+ * qnbinom:
+ * @p: probability
+ * @n: the number of trials
+ * @psuc: the probability of success in each trial
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, @p is given as log probability
+ *
+ * Returns: the observation with cumulative probability @p for the
+ * negative binomial distribution.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * dhyper:
+ * @x: observation
+ * @r: the number of red balls
+ * @b: the number of black balls
+ * @n: the number of balls drawn
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the hypergeometric distribution.
+ */
+
+/**
+ * phyper:
+ * @x: observation
+ * @r: the number of red balls
+ * @b: the number of black balls
+ * @n: the number of balls drawn
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: cumulative density of the hypergeometric distribution.
+ */
+
+/**
+ * qhyper:
+ * @p: probability
+ * @r: the number of red balls
+ * @b: the number of black balls
+ * @n: the number of balls drawn
+ * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
+ * @log_p: if %TRUE, @p is given as log probability
+ *
+ * Returns: the observation with cumulative probability @p for the
+ * hypergeometric distribution.
+ */
+
+/* ------------------------------------------------------------------------- */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]