[gnumeric] Introspection: more docs.



commit c4620203f1b6fff211bc95cf18f69c99cf0f0715
Author: Morten Welinder <terra gnome org>
Date:   Fri Mar 22 11:26:51 2013 -0400

    Introspection: more docs.

 plugins/fn-r/generate |    3 --
 src/mathfunc.h        |    4 +-
 src/outoflinedocs.c   |   67 +++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 69 insertions(+), 5 deletions(-)
---
diff --git a/plugins/fn-r/generate b/plugins/fn-r/generate
index ca9c294..4fd9a7f 100644
--- a/plugins/fn-r/generate
+++ b/plugins/fn-r/generate
@@ -57,7 +57,6 @@ my %argoverride = ();
         'Student t',
         ({ 'n' => "the number of degrees of freedom $of",
            @common })];
-    $argoverride{"qt:ndf"} = "n";
 
     $funcs{'df'} = $funcs{'pf'} = $funcs{'qf'} =
        [\&distribution,
@@ -65,8 +64,6 @@ my %argoverride = ();
         ({ 'n1' => "the first number of degrees of freedom $of",
            'n2' => "the second number of degrees of freedom $of",
            @common })];
-    $argoverride{"df:m"} = "n1";
-    $argoverride{"df:n"} = "n2";
 
     $funcs{'dchisq'} = $funcs{'pchisq'} = $funcs{'qchisq'} =
        [\&distribution,
diff --git a/src/mathfunc.h b/src/mathfunc.h
index fb258eb..01bad21 100644
--- a/src/mathfunc.h
+++ b/src/mathfunc.h
@@ -73,10 +73,10 @@ gnm_float qbeta (gnm_float p, gnm_float a, gnm_float b, gboolean lower_tail, gbo
 /* The t distribution.  */
 gnm_float dt (gnm_float x, gnm_float n, gboolean give_log);
 gnm_float pt (gnm_float x, gnm_float n, gboolean lower_tail, gboolean log_p);
-gnm_float qt (gnm_float p, gnm_float ndf, gboolean lower_tail, gboolean log_p);
+gnm_float qt (gnm_float p, gnm_float n, gboolean lower_tail, gboolean log_p);
 
 /* The F distribution.  */
-gnm_float df (gnm_float x, gnm_float m, gnm_float n, gboolean give_log);
+gnm_float df (gnm_float x, gnm_float n1, gnm_float n2, gboolean give_log);
 gnm_float pf (gnm_float x, gnm_float n1, gnm_float n2, gboolean lower_tail, gboolean log_p);
 gnm_float qf (gnm_float p, gnm_float n1, gnm_float n2, gboolean lower_tail, gboolean log_p);
 
diff --git a/src/outoflinedocs.c b/src/outoflinedocs.c
index 8ca667e..afb92fb 100644
--- a/src/outoflinedocs.c
+++ b/src/outoflinedocs.c
@@ -223,3 +223,70 @@
  */
 
 /* ------------------------------------------------------------------------- */
+
+/**
+ * dt:
+ * @x: observation
+ * @n: the number of degrees of freedom of the distribution
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the Student t distribution.
+ */
+
+/**
+ * pt:
+ * @x: observation
+ * @n: the number of degrees of freedom 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 Student t distribution.
+ */
+
+/**
+ * qt:
+ * @p: probability
+ * @n: the number of degrees of freedom 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
+ * Student t distribution.
+ */
+
+/* ------------------------------------------------------------------------- */
+
+/**
+ * df:
+ * @x: observation
+ * @n1: the first number of degrees of freedom of the distribution
+ * @n2: the first number of degrees of freedom of the distribution
+ * @give_log: if %TRUE, log of the result will be returned instead
+ *
+ * Returns: density of the F distribution.
+ */
+
+/**
+ * pf:
+ * @x: observation
+ * @n1: the first number of degrees of freedom of the distribution
+ * @n2: the first number of degrees of freedom 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 F distribution.
+ */
+
+/**
+ * qf:
+ * @p: probability
+ * @n1: the first number of degrees of freedom of the distribution
+ * @n2: the first number of degrees of freedom 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
+ * F distribution.
+ */
+
+/* ------------------------------------------------------------------------- */


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