The R Project SVN R

Rev

Rev 7002 | Rev 7007 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3279 pd 1
/*
2
 *  Mathlib : A C Library of Special Functions
5458 ripley 3
 *  Copyright (C) 1998-1999 R Development Core Team
3279 pd 4
 *
5
 *  This program is free software; you can redistribute it and/or modify
6
 *  it under the terms of the GNU General Public License as published by
7
 *  the Free Software Foundation; either version 2 of the License, or
8
 *  (at your option) any later version.
9
 *
10
 *  This program is distributed in the hope that it will be useful,
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 *  GNU General Public License for more details.
14
 *
15
 *  You should have received a copy of the GNU General Public License
16
 *  along with this program; if not, write to the Free Software
5458 ripley 17
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
3279 pd 18
 *
19
 
20
 * Mathlib.h  should contain ALL headers from R's C code in `src/nmath'
21
   ---------  such that ``the Math library'' can be used by simply
22
 
23
   ``#include "Mathlib.h" ''
24
 
25
   and nothing else.
26
*/
571 ihaka 27
#ifndef MATHLIB_H
28
#define MATHLIB_H
2 r 29
 
3279 pd 30
/*-- Mathlib as part of R --  undefine this for standalone : */
31
#define MATHLIB_IN_R
3076 pd 32
 
7003 ripley 33
#include "Rconfig.h" /* for IEEE_754 etc */
34
#include "R_ext/Arith.h"
35
/*#include "R_ext/Random.h"*/
2 r 36
 
2629 maechler 37
#ifdef FORTRAN_H
38
#error __MUST__include "Mathlib.h"  _before_  "Fortran.h"
39
#endif
40
 
571 ihaka 41
#include <errno.h>
2737 hornik 42
#include <limits.h>
571 ihaka 43
#include <float.h>
2 r 44
#include <math.h>
45
#include <stdlib.h>
46
 
2629 maechler 47
/* TRUE and FALSE conflict with the Mac --- Fortran.h still defines them... */
48
#define LTRUE	(1)
49
#define LFALSE	(0)
50
 
3244 ihaka 51
/* 30 Decimal-place constants */
52
/* Computed with bc -l (scale=32; proper round) */
2 r 53
 
3244 ihaka 54
/* SVID & X/Open Constants */
55
/* Names from Solaris math.h */
56
 
57
#ifndef M_E
58
#define M_E		2.718281828459045235360287471353	/* e */
59
#endif
60
 
61
#ifndef M_LOG2E
62
#define M_LOG2E		1.442695040888963407359924681002	/* log2(e) */
63
#endif
64
 
65
#ifndef M_LOG10E
4835 maechler 66
#define M_LOG10E	0.434294481903251827651128918917	/* log10(e) */
3244 ihaka 67
#endif
68
 
69
#ifndef M_LN2
70
#define M_LN2		0.693147180559945309417232121458	/* ln(2) */
71
#endif
72
 
73
#ifndef M_LN10
74
#define M_LN10		2.302585092994045684017991454684	/* ln(10) */
75
#endif
76
 
77
#ifndef M_PI
4835 maechler 78
#define M_PI		3.141592653589793238462643383280	/* pi */
3244 ihaka 79
#endif
80
 
81
#ifndef M_PI_2
82
#define M_PI_2		1.570796326794896619231321691640	/* pi/2 */
83
#endif
84
 
85
#ifndef M_PI_4
86
#define M_PI_4		0.785398163397448309615660845820	/* pi/4 */
87
#endif
88
 
4835 maechler 89
#ifndef M_1_PI
3244 ihaka 90
#define M_1_PI		0.318309886183790671537767526745	/* 1/pi */
91
#endif
92
 
4835 maechler 93
#ifndef M_2_PI
3244 ihaka 94
#define M_2_PI		0.636619772367581343075535053490	/* 1/pi */
95
#endif
96
 
97
#ifndef M_2_SQRTPI
98
#define M_2_SQRTPI	1.128379167095512573896158903122	/* 1/sqrt(pi) */
99
#endif
100
 
101
#ifndef M_SQRT2
102
#define M_SQRT2		1.414213562373095048801688724210	/* sqrt(2) */
103
#endif
104
 
105
#ifndef M_SQRT1_2
106
#define M_SQRT1_2	0.707106781186547524400844362105	/* 1/sqrt(2) */
107
#endif
108
 
109
/* Other, R-Specific Constants */
110
/* Note there are some repeats of values above */
111
/* Needs a cleanup */
112
 
113
#ifndef M_1_SQRT_2
777 maechler 114
#define M_1_SQRT_2	0.707106781186547524400844362105	/* 1/sqrt(2) */
3244 ihaka 115
#endif
116
 
117
#ifndef M_SQRT_32
777 maechler 118
#define M_SQRT_32	5.656854249492380195206754896838	/* sqrt(32) */
2 r 119
#endif
120
 
3244 ihaka 121
#ifndef M_LOG10_2
122
#define M_LOG10_2	0.301029995663981195213738894724	/* log10(2) */
777 maechler 123
#endif
124
 
2 r 125
#ifndef M_PI_half
3244 ihaka 126
#define M_PI_half	1.570796326794896619231321691640	/* pi/2 */
2 r 127
#endif
128
 
129
#ifndef M_SQRT_PI
3244 ihaka 130
#define M_SQRT_PI	1.772453850905516027298167483341	/* sqrt(pi) */
2 r 131
#endif
132
 
3244 ihaka 133
#ifndef M_1_SQRT_2PI
134
#define M_1_SQRT_2PI	0.398942280401432677939946059934	/* 1/sqrt(2pi) */
135
#endif
2 r 136
 
3244 ihaka 137
#ifndef M_SQRT_2dPI
138
#define M_SQRT_2dPI	0.797884560802865355879892119869	/* sqrt(2/pi) */
139
#endif
140
 
141
 
777 maechler 142
#ifndef M_LN_SQRT_PI
3244 ihaka 143
#define M_LN_SQRT_PI	0.572364942924700087071713675677	/* log(sqrt(pi)) */
2 r 144
#endif
145
 
3244 ihaka 146
#ifndef M_LN_SQRT_2PI
147
#define M_LN_SQRT_2PI	0.918938533204672741780329736406	/* log(sqrt(2*pi)) */
148
#endif
777 maechler 149
 
3244 ihaka 150
#ifndef M_LN_SQRT_PId2
151
#define M_LN_SQRT_PId2	0.225791352644727432363097614947	/* log(sqrt(pi/2)) */
152
#endif
153
 
154
 
3076 pd 155
#ifdef MATHLIB_IN_R/* Mathlib in R */
777 maechler 156
 
3076 pd 157
#include "Error.h"
158
# define MATHLIB_ERROR(fmt,x)		error(fmt,x);
159
# define MATHLIB_WARNING(fmt,x)		warning(fmt,x)
160
# define MATHLIB_WARNING2(fmt,x,x2)	warning(fmt,x,x2)
161
# define MATHLIB_WARNING3(fmt,x,x2,x3)	warning(fmt,x,x2,x3)
162
# define MATHLIB_WARNING4(fmt,x,x2,x3,x4) warning(fmt,x,x2,x3,x4)
2 r 163
 
3076 pd 164
#else/* Mathlib standalone */
165
 
166
#include <stdio.h>
3786 pd 167
# define MATHLIB_ERROR(fmt,x)	{ printf(fmt,x); exit(1) }
3076 pd 168
# define MATHLIB_WARNING(fmt,x)		printf(fmt,x)
169
# define MATHLIB_WARNING2(fmt,x,x2)	printf(fmt,x,x2)
170
# define MATHLIB_WARNING3(fmt,x,x2,x3)	printf(fmt,x,x2,x3)
171
# define MATHLIB_WARNING4(fmt,x,x2,x3,x4) printf(fmt,x,x2,x3,x4)
172
#endif
173
 
571 ihaka 174
#define ME_NONE		0
3786 pd 175
/*	no error */
571 ihaka 176
#define ME_DOMAIN	1
3786 pd 177
/*	argument out of domain */
571 ihaka 178
#define ME_RANGE	2
3786 pd 179
/*	value out of range */
180
#define ME_NOCONV	4
181
/*	process did not converge */
182
#define ME_PRECISION	8
183
/*	does not have "full" precision */
184
#define ME_UNDERFLOW	16
185
/*	and underflow occured (important for IEEE)*/
571 ihaka 186
 
187
 
188
#ifdef IEEE_754
3786 pd 189
 
3609 pd 190
# ifdef HAVE_IEEE754_H
191
#  include <ieee754.h> /* newer Linuxen */
192
# else
193
#  ifdef HAVE_IEEEFP_H
194
#   include <ieeefp.h> /* others [Solaris 2.5.x], .. */
195
#  endif
196
# endif
995 ihaka 197
 
571 ihaka 198
extern double m_zero;
199
extern double m_one;
3548 ihaka 200
/* extern double m_tiny; */
571 ihaka 201
#define ML_ERROR(x)	/* nothing */
202
#define ML_POSINF	(m_one / m_zero)
203
#define ML_NEGINF	((-m_one) / m_zero)
204
#define ML_NAN		(m_zero / m_zero)
3548 ihaka 205
#define ML_UNDERFLOW	(DBL_MIN * DBL_MIN)
777 maechler 206
#define ML_VALID(x)	(!isnan(x))
3609 pd 207
 
208
#else/*--- NO IEEE: No +/-Inf, NAN,... ---*/
571 ihaka 209
#define ML_ERROR(x)	ml_error(x)
210
#define ML_POSINF	DBL_MAX
211
#define ML_NEGINF	(-DBL_MAX)
212
#define ML_NAN		(-DBL_MAX)
213
#define ML_UNDERFLOW	0
777 maechler 214
#define ML_VALID(x)	(errno == 0)
2 r 215
#endif
216
 
571 ihaka 217
	/* Splus Compatibility */
2 r 218
 
571 ihaka 219
#define snorm	norm_rand
220
#define sunif	unif_rand
221
#define sexp	exp_rand
2 r 222
 
1394 ihaka 223
	/* Undo SGI Madness */
224
 
225
#ifdef ftrunc
5408 hornik 226
# undef ftrunc
1394 ihaka 227
#endif
228
#ifdef qexp
5408 hornik 229
# undef qexp
1394 ihaka 230
#endif
5408 hornik 231
#ifdef qgamma
232
# undef qgamma
233
#endif
1394 ihaka 234
 
571 ihaka 235
	/* Name Hiding to Avoid Clashes with Fortran */
2 r 236
 
571 ihaka 237
#ifdef HIDE_NAMES
3076 pd 238
# define d1mach	c_d1mach
239
# define i1mach	c_i1mach
571 ihaka 240
#endif
2 r 241
 
571 ihaka 242
#define	rround	fround
243
#define	prec	fprec
3244 ihaka 244
#undef trunc
571 ihaka 245
#define	trunc	ftrunc
2 r 246
 
4835 maechler 247
 
248
	/* Utilities for `dpq' handling (density/probability/quantile) */
249
 
250
#define R_D__0 (give_log ? ML_NEGINF : 0.)
251
#define R_D__1 (give_log ? 0. : 1.)
252
#define R_DT_0 (lower_tail ? R_D__0 : R_D__1)
253
#define R_DT_1 (lower_tail ? R_D__1 : R_D__0)
254
 
255
#define R_D_val(x)   (give_log	 ? log(x) : x)	      /*  x  */
256
#define R_D_log(x)   (give_log	 ?  x	  : exp(x))   /* log(x) */
257
 
258
#define R_DT_val(x)  R_D_val(lower_tail ? x	 : 1. - x) /*  x  */
259
#define R_DT_Cval(x) R_D_val(lower_tail ? 1. - x : x)	   /*  1 - x */
260
#define R_DT_log(x)  R_D_log(lower_tail ? x	 : 1. - x) /* log(x) */
261
#define R_DT_Clog(x) R_D_log(lower_tail ? 1. - x : x)	   /* log(1 - x) */
262
 
263
#define R_D_give_log(dd)    (((int)dd) >> 1) /* Extract ``give_log'' flag */
264
#define R_D_lower_tail(dd)  (((int)dd) % 2)  /* Extract ``lower_tail'' flag */
265
 
266
	/* R's version of C functions: */
267
 
268
double R_log(double x);
269
double R_pow(double x, double y);
270
 
571 ihaka 271
	/* Machine Characteristics */
2 r 272
 
571 ihaka 273
double	d1mach(int);
274
double	d1mach_(int*);
275
int	i1mach(int);
276
int	i1mach_(int*);
2 r 277
 
571 ihaka 278
	/* General Support Functions */
2 r 279
 
571 ihaka 280
int	imax2(int, int);
281
int	imin2(int, int);
282
double	fmax2(double, double);
283
double	fmin2(double, double);
284
double	fmod(double, double);
285
double	fprec(double, double);
286
double	fround(double, double);
287
double	ftrunc(double);
3076 pd 288
double	sign(double);
571 ihaka 289
double	fsign(double, double);
290
double	fsquare(double);
291
double	fcube(double);
2 r 292
 
571 ihaka 293
	/* Random Number Generators */
2 r 294
 
571 ihaka 295
double	snorm(void);
296
double	sunif(void);
297
double	sexp(void);
2 r 298
 
571 ihaka 299
	/* Chebyshev Series */
2 r 300
 
571 ihaka 301
int	chebyshev_init(double*, int, double);
302
double	chebyshev_eval(double, double *, int);
2 r 303
 
571 ihaka 304
	/* Gamma and Related Functions */
2 r 305
 
571 ihaka 306
double	logrelerr(double);
307
void	gammalims(double*, double*);
308
double	lgammacor(double);
2278 maechler 309
double	gammafn(double);
2629 maechler 310
double	gamma_cody(double);
2278 maechler 311
double	lgammafn(double);
571 ihaka 312
void	dpsifn(double, int, int, int, double*, int*, int*);
313
double	digamma(double);
314
double	trigamma(double);
315
double	tetragamma(double);
316
double	pentagamma(double);
2 r 317
 
571 ihaka 318
double	choose(double, double);
319
double	lchoose(double, double);
320
double	fastchoose(double, double);
321
double	lfastchoose(double, double);
2 r 322
 
2629 maechler 323
	/* Bessel Functions of All Kinds */
324
 
3786 pd 325
double	bessel_i(double, double, double);
326
double	bessel_j(double, double);
327
double	bessel_k(double, double, double);
328
double	bessel_y(double, double);
329
void	I_bessel(double*, double*, long*, long*, double*, long*);
330
void	J_bessel(double*, double*, long*,	 double*, long*);
331
void	K_bessel(double*, double*, long*, long*, double*, long*);
332
void	Y_bessel(double*, double*, long*,	 double*, long*);
2629 maechler 333
 
571 ihaka 334
	/* Beta and Related Functions */
2 r 335
 
571 ihaka 336
double	beta(double, double);
337
double	lbeta(double, double);
2 r 338
 
571 ihaka 339
	/* Normal Distribution */
2 r 340
 
571 ihaka 341
double	dnorm(double, double, double);
342
double	pnorm(double, double, double);
343
double	qnorm(double, double, double);
344
double	rnorm(double, double);
2 r 345
 
571 ihaka 346
	/* Uniform Distribution */
2 r 347
 
571 ihaka 348
double	dunif(double, double, double);
349
double	punif(double, double, double);
350
double	qunif(double, double, double);
351
double	runif(double, double);
2 r 352
 
571 ihaka 353
	/* Gamma Distribution */
2 r 354
 
571 ihaka 355
double	dgamma(double, double, double);
356
double	pgamma(double, double, double);
357
double	qgamma(double, double, double);
358
double	rgamma(double, double);
2 r 359
 
571 ihaka 360
	/* Beta Distribution */
2 r 361
 
571 ihaka 362
double	dbeta(double, double, double);
363
double	pbeta(double, double, double);
364
double	pbeta_raw(double, double, double);
365
double	qbeta(double, double, double);
366
double	rbeta(double, double);
2 r 367
 
571 ihaka 368
	/* Lognormal Distribution */
2 r 369
 
571 ihaka 370
double	dlnorm(double, double, double);
371
double	plnorm(double, double, double);
372
double	qlnorm(double, double, double);
373
double	rlnorm(double, double);
2 r 374
 
571 ihaka 375
	/* Chi-squared Distribution */
2 r 376
 
571 ihaka 377
double	dchisq(double, double);
378
double	pchisq(double, double);
379
double	qchisq(double, double);
380
double	rchisq(double);
2 r 381
 
571 ihaka 382
	/* Non-central Chi-squared Distribution */
2 r 383
 
605 ihaka 384
double	dnchisq(double, double, double);
571 ihaka 385
double	pnchisq(double, double, double);
386
double	qnchisq(double, double, double);
605 ihaka 387
double	rnchisq(double, double);
571 ihaka 388
 
389
	/* F Distibution */
390
 
391
double	df(double, double, double);
392
double	pf(double, double, double);
393
double	qf(double, double, double);
394
double	rf(double, double);
395
 
396
	/* Student t Distibution */
397
 
398
double	dt(double, double);
399
double	pt(double, double);
400
double	qt(double, double);
401
double	rt(double);
402
 
403
	/* Binomial Distribution */
404
 
405
double	dbinom(double, double, double);
406
double	pbinom(double, double, double);
407
double	qbinom(double, double, double);
408
double	rbinom(double, double);
409
 
410
	/* Cauchy Distribution */
411
 
412
double	dcauchy(double, double, double);
413
double	pcauchy(double, double, double);
414
double	qcauchy(double, double, double);
415
double	rcauchy(double, double);
416
 
417
	/* Exponential Distribution */
418
 
419
double	dexp(double, double);
420
double	pexp(double, double);
421
double	qexp(double, double);
422
double	rexp(double);
423
 
424
	/* Geometric Distribution */
425
 
426
double	dgeom(double, double);
427
double	pgeom(double, double);
428
double	qgeom(double, double);
429
double	rgeom(double);
430
 
431
	/* Hypergeometric Distibution */
432
 
433
double	dhyper(double, double, double, double);
434
double	phyper(double, double, double, double);
435
double	qhyper(double, double, double, double);
436
double	rhyper(double, double, double);
437
 
438
	/* Negative Binomial Distribution */
439
 
440
double	dnbinom(double, double, double);
441
double	pnbinom(double, double, double);
442
double	qnbinom(double, double, double);
443
double	rnbinom(double, double);
444
 
445
	/* Poisson Distribution */
446
 
447
double	dpois(double, double);
448
double	ppois(double, double);
449
double	qpois(double, double);
450
double	rpois(double);
451
 
452
	/* Weibull Distribution */
453
 
454
double	dweibull(double, double, double);
455
double	pweibull(double, double, double);
456
double	qweibull(double, double, double);
457
double	rweibull(double, double);
458
 
459
	/* Logistic Distribution */
460
 
461
double	dlogis(double, double, double);
462
double	plogis(double, double, double);
463
double	qlogis(double, double, double);
464
double	rlogis(double, double);
465
 
602 ihaka 466
	/* Non-central Beta Distribution */
467
 
468
double	dnbeta(double, double, double, double);
469
double	pnbeta(double, double, double, double);
470
double	qnbeta(double, double, double, double);
471
double	rnbeta(double, double, double);
472
 
473
	/* Non-central F Distribution */
474
 
475
double	dnf(double, double, double, double);
476
double	pnf(double, double, double, double);
477
double	qnf(double, double, double, double);
478
double	rnf(double, double, double);
479
 
480
	/* Non-central Student t Distribution */
481
 
482
double	dnt(double, double, double);
483
double	pnt(double, double, double);
484
double	qnt(double, double, double);
485
double	rnt(double, double);
486
 
624 ihaka 487
	/* Studentized Range Distribution */
488
 
489
double	dtukey(double, double, double, double);
490
double	ptukey(double, double, double, double);
491
double	qtukey(double, double, double, double);
492
double	rtukey(double, double, double);
493
 
2235 hornik 494
/* Wilcoxon Rank Sum Distribution */
1276 hornik 495
 
3865 pd 496
#define WILCOX_MAX 50
1276 hornik 497
double dwilcox(double, double, double);
498
double pwilcox(double, double, double);
499
double qwilcox(double, double, double);
500
double rwilcox(double, double);
501
 
2235 hornik 502
/* Wilcoxon Signed Rank Distribution */
503
 
3865 pd 504
#define SIGNRANK_MAX 50
2235 hornik 505
double dsignrank(double, double);
506
double psignrank(double, double);
507
double qsignrank(double, double);
508
double rsignrank(double);
509
 
2 r 510
#endif