1 /** @file inifcns_gamma.cpp
3 * Implementation of Gamma-function, Beta-function, Polygamma-functions, and
4 * some related stuff. */
7 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include "relational.h"
39 // Logarithm of Gamma function
42 static ex lgamma_evalf(const ex & x)
46 END_TYPECHECK(lgamma(x))
48 return lgamma(ex_to_numeric(x));
52 /** Evaluation of lgamma(x), the natural logarithm of the Gamma function.
53 * Knows about integer arguments and that's it. Somebody ought to provide
54 * some good numerical evaluation some day...
56 * @exception GiNaC::pole_error("lgamma_eval(): logarithmic pole",0) */
57 static ex lgamma_eval(const ex & x)
59 if (x.info(info_flags::numeric)) {
60 // trap integer arguments:
61 if (x.info(info_flags::integer)) {
62 // lgamma(n) -> log((n-1)!) for postitive n
63 if (x.info(info_flags::posint))
64 return log(factorial(x + _ex_1()));
66 throw (pole_error("lgamma_eval(): logarithmic pole",0));
68 // lgamma_evalf should be called here once it becomes available
71 return lgamma(x).hold();
75 static ex lgamma_deriv(const ex & x, unsigned deriv_param)
77 GINAC_ASSERT(deriv_param==0);
79 // d/dx lgamma(x) -> psi(x)
84 static ex lgamma_series(const ex & arg,
85 const relational & rel,
90 // Taylor series where there is no pole falls back to psi function
92 // On a pole at -m we could use the recurrence relation
93 // lgamma(x) == lgamma(x+1)-log(x)
95 // series(lgamma(x),x==-m,order) ==
96 // series(lgamma(x+m+1)-log(x)...-log(x+m)),x==-m,order);
97 const ex arg_pt = arg.subs(rel);
98 if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
99 throw do_taylor(); // caught by function::series()
100 // if we got here we have to care for a simple pole of tgamma(-m):
101 numeric m = -ex_to_numeric(arg_pt);
103 for (numeric p; p<=m; ++p)
105 return (lgamma(arg+m+_ex1())-recur).series(rel, order, options);
109 REGISTER_FUNCTION(lgamma, eval_func(lgamma_eval).
110 evalf_func(lgamma_evalf).
111 derivative_func(lgamma_deriv).
112 series_func(lgamma_series).
113 latex_name("\\log \\Gamma"));
117 // true Gamma function
120 static ex tgamma_evalf(const ex & x)
124 END_TYPECHECK(tgamma(x))
126 return tgamma(ex_to_numeric(x));
130 /** Evaluation of tgamma(x), the true Gamma function. Knows about integer
131 * arguments, half-integer arguments and that's it. Somebody ought to provide
132 * some good numerical evaluation some day...
134 * @exception pole_error("tgamma_eval(): simple pole",0) */
135 static ex tgamma_eval(const ex & x)
137 if (x.info(info_flags::numeric)) {
138 // trap integer arguments:
139 if (x.info(info_flags::integer)) {
140 // tgamma(n) -> (n-1)! for postitive n
141 if (x.info(info_flags::posint)) {
142 return factorial(ex_to_numeric(x).sub(_num1()));
144 throw (pole_error("tgamma_eval(): simple pole",1));
147 // trap half integer arguments:
148 if ((x*2).info(info_flags::integer)) {
149 // trap positive x==(n+1/2)
150 // tgamma(n+1/2) -> Pi^(1/2)*(1*3*..*(2*n-1))/(2^n)
151 if ((x*_ex2()).info(info_flags::posint)) {
152 numeric n = ex_to_numeric(x).sub(_num1_2());
153 numeric coefficient = doublefactorial(n.mul(_num2()).sub(_num1()));
154 coefficient = coefficient.div(pow(_num2(),n));
155 return coefficient * pow(Pi,_ex1_2());
157 // trap negative x==(-n+1/2)
158 // tgamma(-n+1/2) -> Pi^(1/2)*(-2)^n/(1*3*..*(2*n-1))
159 numeric n = abs(ex_to_numeric(x).sub(_num1_2()));
160 numeric coefficient = pow(_num_2(), n);
161 coefficient = coefficient.div(doublefactorial(n.mul(_num2()).sub(_num1())));;
162 return coefficient*power(Pi,_ex1_2());
165 // tgamma_evalf should be called here once it becomes available
168 return tgamma(x).hold();
172 static ex tgamma_deriv(const ex & x, unsigned deriv_param)
174 GINAC_ASSERT(deriv_param==0);
176 // d/dx tgamma(x) -> psi(x)*tgamma(x)
177 return psi(x)*tgamma(x);
181 static ex tgamma_series(const ex & arg,
182 const relational & rel,
187 // Taylor series where there is no pole falls back to psi function
189 // On a pole at -m use the recurrence relation
190 // tgamma(x) == tgamma(x+1) / x
191 // from which follows
192 // series(tgamma(x),x==-m,order) ==
193 // series(tgamma(x+m+1)/(x*(x+1)*...*(x+m)),x==-m,order+1);
194 const ex arg_pt = arg.subs(rel);
195 if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
196 throw do_taylor(); // caught by function::series()
197 // if we got here we have to care for a simple pole at -m:
198 numeric m = -ex_to_numeric(arg_pt);
199 ex ser_denom = _ex1();
200 for (numeric p; p<=m; ++p)
202 return (tgamma(arg+m+_ex1())/ser_denom).series(rel, order+1, options);
206 REGISTER_FUNCTION(tgamma, eval_func(tgamma_eval).
207 evalf_func(tgamma_evalf).
208 derivative_func(tgamma_deriv).
209 series_func(tgamma_series).
210 latex_name("\\Gamma"));
217 static ex beta_evalf(const ex & x, const ex & y)
222 END_TYPECHECK(beta(x,y))
224 return tgamma(ex_to_numeric(x))*tgamma(ex_to_numeric(y))/tgamma(ex_to_numeric(x+y));
228 static ex beta_eval(const ex & x, const ex & y)
230 if (x.info(info_flags::numeric) && y.info(info_flags::numeric)) {
231 // treat all problematic x and y that may not be passed into tgamma,
232 // because they would throw there although beta(x,y) is well-defined
233 // using the formula beta(x,y) == (-1)^y * beta(1-x-y, y)
234 numeric nx(ex_to_numeric(x));
235 numeric ny(ex_to_numeric(y));
236 if (nx.is_real() && nx.is_integer() &&
237 ny.is_real() && ny.is_integer()) {
238 if (nx.is_negative()) {
240 return pow(_num_1(), ny)*beta(1-x-y, y);
242 throw (pole_error("beta_eval(): simple pole",1));
244 if (ny.is_negative()) {
246 return pow(_num_1(), nx)*beta(1-y-x, x);
248 throw (pole_error("beta_eval(): simple pole",1));
250 return tgamma(x)*tgamma(y)/tgamma(x+y);
252 // no problem in numerator, but denominator has pole:
253 if ((nx+ny).is_real() &&
254 (nx+ny).is_integer() &&
255 !(nx+ny).is_positive())
258 return tgamma(x)*tgamma(y)/tgamma(x+y);
261 return beta(x,y).hold();
265 static ex beta_deriv(const ex & x, const ex & y, unsigned deriv_param)
267 GINAC_ASSERT(deriv_param<2);
270 // d/dx beta(x,y) -> (psi(x)-psi(x+y)) * beta(x,y)
272 retval = (psi(x)-psi(x+y))*beta(x,y);
273 // d/dy beta(x,y) -> (psi(y)-psi(x+y)) * beta(x,y)
275 retval = (psi(y)-psi(x+y))*beta(x,y);
280 static ex beta_series(const ex & arg1,
282 const relational & rel,
287 // Taylor series where there is no pole of one of the tgamma functions
288 // falls back to beta function evaluation. Otherwise, fall back to
289 // tgamma series directly.
290 const ex arg1_pt = arg1.subs(rel);
291 const ex arg2_pt = arg2.subs(rel);
292 GINAC_ASSERT(is_ex_exactly_of_type(rel.lhs(),symbol));
293 const symbol *s = static_cast<symbol *>(rel.lhs().bp);
294 ex arg1_ser, arg2_ser, arg1arg2_ser;
295 if ((!arg1_pt.info(info_flags::integer) || arg1_pt.info(info_flags::positive)) &&
296 (!arg2_pt.info(info_flags::integer) || arg2_pt.info(info_flags::positive)))
297 throw do_taylor(); // caught by function::series()
298 // trap the case where arg1 is on a pole:
299 if (arg1.info(info_flags::integer) && !arg1.info(info_flags::positive))
300 arg1_ser = tgamma(arg1+*s).series(rel, order, options);
302 arg1_ser = tgamma(arg1).series(rel,order);
303 // trap the case where arg2 is on a pole:
304 if (arg2.info(info_flags::integer) && !arg2.info(info_flags::positive))
305 arg2_ser = tgamma(arg2+*s).series(rel, order, options);
307 arg2_ser = tgamma(arg2).series(rel,order);
308 // trap the case where arg1+arg2 is on a pole:
309 if ((arg1+arg2).info(info_flags::integer) && !(arg1+arg2).info(info_flags::positive))
310 arg1arg2_ser = tgamma(arg2+arg1+*s).series(rel, order, options);
312 arg1arg2_ser = tgamma(arg2+arg1).series(rel,order);
313 // compose the result (expanding all the terms):
314 return (arg1_ser*arg2_ser/arg1arg2_ser).series(rel, order, options).expand();
318 REGISTER_FUNCTION(beta, eval_func(beta_eval).
319 evalf_func(beta_evalf).
320 derivative_func(beta_deriv).
321 series_func(beta_series).
322 latex_name("\\mbox{B}"));
326 // Psi-function (aka digamma-function)
329 static ex psi1_evalf(const ex & x)
333 END_TYPECHECK(psi(x))
335 return psi(ex_to_numeric(x));
338 /** Evaluation of digamma-function psi(x).
339 * Somebody ought to provide some good numerical evaluation some day... */
340 static ex psi1_eval(const ex & x)
342 if (x.info(info_flags::numeric)) {
343 numeric nx = ex_to_numeric(x);
344 if (nx.is_integer()) {
346 if (nx.is_positive()) {
347 // psi(n) -> 1 + 1/2 +...+ 1/(n-1) - Euler
349 for (numeric i(nx+_num_1()); i.is_positive(); --i)
353 // for non-positive integers there is a pole:
354 throw (pole_error("psi_eval(): simple pole",1));
357 if ((_num2()*nx).is_integer()) {
359 if (nx.is_positive()) {
360 // psi((2m+1)/2) -> 2/(2m+1) + 2/2m +...+ 2/1 - Euler - 2log(2)
362 for (numeric i((nx+_num_1())*_num2()); i.is_positive(); i-=_num2())
363 rat += _num2()*i.inverse();
364 return rat-Euler-_ex2()*log(_ex2());
366 // use the recurrence relation
367 // psi(-m-1/2) == psi(-m-1/2+1) - 1 / (-m-1/2)
368 // to relate psi(-m-1/2) to psi(1/2):
369 // psi(-m-1/2) == psi(1/2) + r
370 // where r == ((-1/2)^(-1) + ... + (-m-1/2)^(-1))
372 for (numeric p(nx); p<0; ++p)
373 recur -= pow(p, _num_1());
374 return recur+psi(_ex1_2());
377 // psi1_evalf should be called here once it becomes available
380 return psi(x).hold();
383 static ex psi1_deriv(const ex & x, unsigned deriv_param)
385 GINAC_ASSERT(deriv_param==0);
387 // d/dx psi(x) -> psi(1,x)
388 return psi(_ex1(), x);
391 static ex psi1_series(const ex & arg,
392 const relational & rel,
397 // Taylor series where there is no pole falls back to polygamma function
399 // On a pole at -m use the recurrence relation
400 // psi(x) == psi(x+1) - 1/z
401 // from which follows
402 // series(psi(x),x==-m,order) ==
403 // series(psi(x+m+1) - 1/x - 1/(x+1) - 1/(x+m)),x==-m,order);
404 const ex arg_pt = arg.subs(rel);
405 if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
406 throw do_taylor(); // caught by function::series()
407 // if we got here we have to care for a simple pole at -m:
408 numeric m = -ex_to_numeric(arg_pt);
410 for (numeric p; p<=m; ++p)
411 recur += power(arg+p,_ex_1());
412 return (psi(arg+m+_ex1())-recur).series(rel, order, options);
415 const unsigned function_index_psi1 =
416 function::register_new(function_options("psi").
417 eval_func(psi1_eval).
418 evalf_func(psi1_evalf).
419 derivative_func(psi1_deriv).
420 series_func(psi1_series).
424 // Psi-functions (aka polygamma-functions) psi(0,x)==psi(x)
427 static ex psi2_evalf(const ex & n, const ex & x)
432 END_TYPECHECK(psi(n,x))
434 return psi(ex_to_numeric(n), ex_to_numeric(x));
437 /** Evaluation of polygamma-function psi(n,x).
438 * Somebody ought to provide some good numerical evaluation some day... */
439 static ex psi2_eval(const ex & n, const ex & x)
441 // psi(0,x) -> psi(x)
444 // psi(-1,x) -> log(tgamma(x))
445 if (n.is_equal(_ex_1()))
446 return log(tgamma(x));
447 if (n.info(info_flags::numeric) && n.info(info_flags::posint) &&
448 x.info(info_flags::numeric)) {
449 numeric nn = ex_to_numeric(n);
450 numeric nx = ex_to_numeric(x);
451 if (nx.is_integer()) {
453 if (nx.is_equal(_num1()))
454 // use psi(n,1) == (-)^(n+1) * n! * zeta(n+1)
455 return pow(_num_1(),nn+_num1())*factorial(nn)*zeta(ex(nn+_num1()));
456 if (nx.is_positive()) {
457 // use the recurrence relation
458 // psi(n,m) == psi(n,m+1) - (-)^n * n! / m^(n+1)
459 // to relate psi(n,m) to psi(n,1):
460 // psi(n,m) == psi(n,1) + r
461 // where r == (-)^n * n! * (1^(-n-1) + ... + (m-1)^(-n-1))
463 for (numeric p(1); p<nx; ++p)
464 recur += pow(p, -nn+_num_1());
465 recur *= factorial(nn)*pow(_num_1(), nn);
466 return recur+psi(n,_ex1());
468 // for non-positive integers there is a pole:
469 throw (pole_error("psi2_eval(): pole",1));
472 if ((_num2()*nx).is_integer()) {
474 if (nx.is_equal(_num1_2()))
475 // use psi(n,1/2) == (-)^(n+1) * n! * (2^(n+1)-1) * zeta(n+1)
476 return pow(_num_1(),nn+_num1())*factorial(nn)*(pow(_num2(),nn+_num1()) + _num_1())*zeta(ex(nn+_num1()));
477 if (nx.is_positive()) {
478 numeric m = nx - _num1_2();
479 // use the multiplication formula
480 // psi(n,2*m) == (psi(n,m) + psi(n,m+1/2)) / 2^(n+1)
481 // to revert to positive integer case
482 return psi(n,_num2()*m)*pow(_num2(),nn+_num1())-psi(n,m);
484 // use the recurrence relation
485 // psi(n,-m-1/2) == psi(n,-m-1/2+1) - (-)^n * n! / (-m-1/2)^(n+1)
486 // to relate psi(n,-m-1/2) to psi(n,1/2):
487 // psi(n,-m-1/2) == psi(n,1/2) + r
488 // where r == (-)^(n+1) * n! * ((-1/2)^(-n-1) + ... + (-m-1/2)^(-n-1))
490 for (numeric p(nx); p<0; ++p)
491 recur += pow(p, -nn+_num_1());
492 recur *= factorial(nn)*pow(_num_1(), nn+_num_1());
493 return recur+psi(n,_ex1_2());
496 // psi2_evalf should be called here once it becomes available
499 return psi(n, x).hold();
502 static ex psi2_deriv(const ex & n, const ex & x, unsigned deriv_param)
504 GINAC_ASSERT(deriv_param<2);
506 if (deriv_param==0) {
508 throw(std::logic_error("cannot diff psi(n,x) with respect to n"));
510 // d/dx psi(n,x) -> psi(n+1,x)
511 return psi(n+_ex1(), x);
514 static ex psi2_series(const ex & n,
516 const relational & rel,
521 // Taylor series where there is no pole falls back to polygamma function
523 // On a pole at -m use the recurrence relation
524 // psi(n,x) == psi(n,x+1) - (-)^n * n! / x^(n+1)
525 // from which follows
526 // series(psi(x),x==-m,order) ==
527 // series(psi(x+m+1) - (-1)^n * n! * ((x)^(-n-1) + (x+1)^(-n-1) + ...
528 // ... + (x+m)^(-n-1))),x==-m,order);
529 const ex arg_pt = arg.subs(rel);
530 if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
531 throw do_taylor(); // caught by function::series()
532 // if we got here we have to care for a pole of order n+1 at -m:
533 numeric m = -ex_to_numeric(arg_pt);
535 for (numeric p; p<=m; ++p)
536 recur += power(arg+p,-n+_ex_1());
537 recur *= factorial(n)*power(_ex_1(),n);
538 return (psi(n, arg+m+_ex1())-recur).series(rel, order, options);
541 const unsigned function_index_psi2 =
542 function::register_new(function_options("psi").
543 eval_func(psi2_eval).
544 evalf_func(psi2_evalf).
545 derivative_func(psi2_deriv).
546 series_func(psi2_series).