src/outoflinedocs.c

   1 /*
   2  * Documentation for those functions where inline documentation is
   3  * not appropriate, for example because the source code was imported
   4  * from elsewhere.
   5  */
   6
   7 #include <gnumeric-config.h>
   8
   9 /* ------------------------------------------------------------------------- */
  10
  11 /**
  12  * log1pmx:
  13  * @x: a number
  14  *
  15  * Returns: log(1+@x)-@x with less rounding error than the naive formula,
  16  * especially for small values of @x.
  17  */
  18
  19 /* ------------------------------------------------------------------------- */
  20
  21 /**
  22  * pnorm:
  23  * @x: observation
  24  * @mu: mean of the distribution
  25  * @sigma: standard deviation of the distribution
  26  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  27  * @log_p: if %TRUE, log of the result will be returned instead
  28  *
  29  * Returns: cumulative density of the normal distribution.
  30  */
  31
  32 /**
  33  * qnorm:
  34  * @p: probability
  35  * @mu: mean of the distribution
  36  * @sigma: standard deviation of the distribution
  37  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  38  * @log_p: if %TRUE, @p is given as log probability
  39  *
  40  * Returns: the observation with cumulative probability @p for the
  41  * normal distribution.
  42  */
  43
  44 /* ------------------------------------------------------------------------- */
  45
  46 /**
  47  * dgamma:
  48  * @x: observation
  49  * @shape: the shape parameter of the distribution
  50  * @scale: the scale parameter of the distribution
  51  * @give_log: if %TRUE, log of the result will be returned instead
  52  *
  53  * Returns: density of the gamma distribution.
  54  */
  55
  56 /**
  57  * pgamma:
  58  * @x: observation
  59  * @shape: the shape parameter of the distribution
  60  * @scale: the scale parameter of the distribution
  61  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  62  * @log_p: if %TRUE, log of the result will be returned instead
  63  *
  64  * Returns: cumulative density of the gamma distribution.
  65  */
  66
  67 /**
  68  * qgamma:
  69  * @p: probability
  70  * @shape: the shape parameter of the distribution
  71  * @scale: the scale parameter of the distribution
  72  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  73  * @log_p: if %TRUE, @p is given as log probability
  74  *
  75  * Returns: the observation with cumulative probability @p for the
  76  * gamma distribution.
  77  */
  78
  79 /* ------------------------------------------------------------------------- */
  80
  81 /**
  82  * dbeta:
  83  * @x: observation
  84  * @a: the first shape parameter of the distribution
  85  * @b: the second scale parameter of the distribution
  86  * @give_log: if %TRUE, log of the result will be returned instead
  87  *
  88  * Returns: density of the beta distribution.
  89  */
  90
  91 /**
  92  * pbeta:
  93  * @x: observation
  94  * @a: the first shape parameter of the distribution
  95  * @b: the second scale parameter of the distribution
  96  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
  97  * @log_p: if %TRUE, log of the result will be returned instead
  98  *
  99  * Returns: cumulative density of the beta distribution.
 100  */
 101
 102 /**
 103  * qbeta:
 104  * @p: probability
 105  * @a: the first shape parameter of the distribution
 106  * @b: the second scale parameter of the distribution
 107  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 108  * @log_p: if %TRUE, @p is given as log probability
 109  *
 110  * Returns: the observation with cumulative probability @p for the
 111  * beta distribution.
 112  */
 113
 114 /* ------------------------------------------------------------------------- */
 115
 116 /**
 117  * dt:
 118  * @x: observation
 119  * @n: the number of degrees of freedom of the distribution
 120  * @give_log: if %TRUE, log of the result will be returned instead
 121  *
 122  * Returns: density of the Student t distribution.
 123  */
 124
 125 /**
 126  * pt:
 127  * @x: observation
 128  * @n: the number of degrees of freedom of the distribution
 129  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 130  * @log_p: if %TRUE, log of the result will be returned instead
 131  *
 132  * Returns: cumulative density of the Student t distribution.
 133  */
 134
 135 /**
 136  * qt:
 137  * @p: probability
 138  * @n: the number of degrees of freedom of the distribution
 139  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 140  * @log_p: if %TRUE, @p is given as log probability
 141  *
 142  * Returns: the observation with cumulative probability @p for the
 143  * Student t distribution.
 144  */
 145
 146 /* ------------------------------------------------------------------------- */
 147
 148 /**
 149  * df:
 150  * @x: observation
 151  * @n1: the first number of degrees of freedom of the distribution
 152  * @n2: the first number of degrees of freedom of the distribution
 153  * @give_log: if %TRUE, log of the result will be returned instead
 154  *
 155  * Returns: density of the F distribution.
 156  */
 157
 158 /**
 159  * pf:
 160  * @x: observation
 161  * @n1: the first number of degrees of freedom of the distribution
 162  * @n2: the first number of degrees of freedom of the distribution
 163  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 164  * @log_p: if %TRUE, log of the result will be returned instead
 165  *
 166  * Returns: cumulative density of the F distribution.
 167  */
 168
 169 /**
 170  * qf:
 171  * @p: probability
 172  * @n1: the first number of degrees of freedom of the distribution
 173  * @n2: the first number of degrees of freedom of the distribution
 174  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 175  * @log_p: if %TRUE, @p is given as log probability
 176  *
 177  * Returns: the observation with cumulative probability @p for the
 178  * F distribution.
 179  */
 180
 181 /* ------------------------------------------------------------------------- */
 182
 183 /**
 184  * dgeom:
 185  * @x: observation
 186  * @psuc: the probability of success in each trial
 187  * @give_log: if %TRUE, log of the result will be returned instead
 188  *
 189  * Returns: density of the geometric distribution.
 190  */
 191
 192 /**
 193  * pgeom:
 194  * @x: observation
 195  * @psuc: the probability of success in each trial
 196  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 197  * @log_p: if %TRUE, log of the result will be returned instead
 198  *
 199  * Returns: cumulative density of the geometric distribution.
 200  */
 201
 202 /**
 203  * qgeom:
 204  * @p: probability
 205  * @psuc: the probability of success in each trial
 206  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 207  * @log_p: if %TRUE, @p is given as log probability
 208  *
 209  * Returns: the observation with cumulative probability @p for the
 210  * geometric distribution.
 211  */
 212
 213 /* ------------------------------------------------------------------------- */
 214
 215 /**
 216  * dchisq:
 217  * @x: observation
 218  * @df: the number of degrees of freedom of the distribution
 219  * @give_log: if %TRUE, log of the result will be returned instead
 220  *
 221  * Returns: density of the &#x1D712;&#xb2; distribution.
 222  */
 223
 224 /**
 225  * pchisq:
 226  * @x: observation
 227  * @df: the number of degrees of freedom of the distribution
 228  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 229  * @log_p: if %TRUE, log of the result will be returned instead
 230  *
 231  * Returns: cumulative density of the &#x1D712;&#xb2; distribution.
 232  */
 233
 234 /**
 235  * qchisq:
 236  * @p: probability
 237  * @df: the number of degrees of freedom of the distribution
 238  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 239  * @log_p: if %TRUE, @p is given as log probability
 240  *
 241  * Returns: the observation with cumulative probability @p for the
 242  * &#x1D712;&#xb2; distribution.
 243  */
 244
 245 /* ------------------------------------------------------------------------- */
 246
 247 /**
 248  * dweibull:
 249  * @x: observation
 250  * @shape: the shape parameter of the distribution
 251  * @scale: the scale parameter of the distribution
 252  * @give_log: if %TRUE, log of the result will be returned instead
 253  *
 254  * Returns: density of the Weibull distribution.
 255  */
 256
 257 /**
 258  * pweibull:
 259  * @x: observation
 260  * @shape: the shape parameter of the distribution
 261  * @scale: the scale parameter of the distribution
 262  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 263  * @log_p: if %TRUE, log of the result will be returned instead
 264  *
 265  * Returns: cumulative density of the Weibull distribution.
 266  */
 267
 268 /**
 269  * qweibull:
 270  * @p: probability
 271  * @shape: the shape parameter of the distribution
 272  * @scale: the scale parameter of the distribution
 273  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 274  * @log_p: if %TRUE, @p is given as log probability
 275  *
 276  * Returns: the observation with cumulative probability @p for the
 277  * Weibull distribution.
 278  */
 279
 280 /* ------------------------------------------------------------------------- */
 281
 282 /**
 283  * dpois:
 284  * @x: observation
 285  * @lambda: the mean of the distribution
 286  * @give_log: if %TRUE, log of the result will be returned instead
 287  *
 288  * Returns: density of the Poisson distribution.
 289  */
 290
 291 /**
 292  * ppois:
 293  * @x: observation
 294  * @lambda: the mean of the distribution
 295  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 296  * @log_p: if %TRUE, log of the result will be returned instead
 297  *
 298  * Returns: cumulative density of the Poisson distribution.
 299  */
 300
 301 /**
 302  * qpois:
 303  * @p: probability
 304  * @lambda: the mean of the distribution
 305  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 306  * @log_p: if %TRUE, @p is given as log probability
 307  *
 308  * Returns: the observation with cumulative probability @p for the
 309  * Poisson distribution.
 310  */
 311
 312 /* ------------------------------------------------------------------------- */
 313
 314 /**
 315  * dexp:
 316  * @x: observation
 317  * @scale: the scale parameter of the distribution
 318  * @give_log: if %TRUE, log of the result will be returned instead
 319  *
 320  * Returns: density of the exponential distribution.
 321  */
 322
 323 /**
 324  * pexp:
 325  * @x: observation
 326  * @scale: the scale parameter of the distribution
 327  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 328  * @log_p: if %TRUE, log of the result will be returned instead
 329  *
 330  * Returns: cumulative density of the exponential distribution.
 331  */
 332
 333 /**
 334  * qexp:
 335  * @p: probability
 336  * @scale: the scale parameter of the distribution
 337  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 338  * @log_p: if %TRUE, @p is given as log probability
 339  *
 340  * Returns: the observation with cumulative probability @p for the
 341  * exponential distribution.
 342  */
 343
 344 /* ------------------------------------------------------------------------- */
 345
 346 /**
 347  * dbinom:
 348  * @x: observation
 349  * @n: the number of trials
 350  * @psuc: the probability of success in each trial
 351  * @give_log: if %TRUE, log of the result will be returned instead
 352  *
 353  * Returns: density of the binomial distribution.
 354  */
 355
 356 /**
 357  * pbinom:
 358  * @x: observation
 359  * @n: the number of trials
 360  * @psuc: the probability of success in each trial
 361  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 362  * @log_p: if %TRUE, log of the result will be returned instead
 363  *
 364  * Returns: cumulative density of the binomial distribution.
 365  */
 366
 367 /**
 368  * qbinom:
 369  * @p: probability
 370  * @n: the number of trials
 371  * @psuc: the probability of success in each trial
 372  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 373  * @log_p: if %TRUE, @p is given as log probability
 374  *
 375  * Returns: the observation with cumulative probability @p for the
 376  * binomial distribution.
 377  */
 378
 379 /* ------------------------------------------------------------------------- */
 380
 381 /**
 382  * dnbinom:
 383  * @x: observation
 384  * @n: the number of trials
 385  * @psuc: the probability of success in each trial
 386  * @give_log: if %TRUE, log of the result will be returned instead
 387  *
 388  * Returns: density of the negative binomial distribution.
 389  */
 390
 391 /**
 392  * pnbinom:
 393  * @x: observation
 394  * @n: the number of trials
 395  * @psuc: the probability of success in each trial
 396  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 397  * @log_p: if %TRUE, log of the result will be returned instead
 398  *
 399  * Returns: cumulative density of the negative binomial distribution.
 400  */
 401
 402 /**
 403  * qnbinom:
 404  * @p: probability
 405  * @n: the number of trials
 406  * @psuc: the probability of success in each trial
 407  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 408  * @log_p: if %TRUE, @p is given as log probability
 409  *
 410  * Returns: the observation with cumulative probability @p for the
 411  * negative binomial distribution.
 412  */
 413
 414 /* ------------------------------------------------------------------------- */
 415
 416 /**
 417  * dhyper:
 418  * @x: observation
 419  * @r: the number of red balls
 420  * @b: the number of black balls
 421  * @n: the number of balls drawn
 422  * @give_log: if %TRUE, log of the result will be returned instead
 423  *
 424  * Returns: density of the hypergeometric distribution.
 425  */
 426
 427 /**
 428  * phyper:
 429  * @x: observation
 430  * @r: the number of red balls
 431  * @b: the number of black balls
 432  * @n: the number of balls drawn
 433  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 434  * @log_p: if %TRUE, log of the result will be returned instead
 435  *
 436  * Returns: cumulative density of the hypergeometric distribution.
 437  */
 438
 439 /**
 440  * qhyper:
 441  * @p: probability
 442  * @r: the number of red balls
 443  * @b: the number of black balls
 444  * @n: the number of balls drawn
 445  * @lower_tail: if %TRUE, the lower tail of the distribution is considered.
 446  * @log_p: if %TRUE, @p is given as log probability
 447  *
 448  * Returns: the observation with cumulative probability @p for the
 449  * hypergeometric distribution.
 450  */
 451
 452 /* ------------------------------------------------------------------------- */