ginac/inifcns_gamma.cpp

   1 /** @file inifcns_gamma.cpp
   2  *
   3  *  Implementation of Gamma function and some related stuff. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #include <vector>
  24 #include <stdexcept>
  25
  26 #include "inifcns.h"
  27 #include "ex.h"
  28 #include "constant.h"
  29 #include "numeric.h"
  30 #include "power.h"
  31 #include "symbol.h"
  32
  33 namespace GiNaC {
  34
  35 //////////
  36 // gamma function
  37 //////////
  38
  39 /** Evaluation of gamma(x). Knows about integer arguments, half-integer
  40  *  arguments and that's it. Somebody ought to provide some good numerical
  41  *  evaluation some day...
  42  *
  43  *  @exception fail_numeric("complex_infinity") or something similar... */
  44 static ex gamma_eval(ex const & x)
  45 {
  46     if (x.info(info_flags::numeric)) {
  47
  48         // trap integer arguments:
  49         if ( x.info(info_flags::integer) ) {
  50             // gamma(n+1) -> n! for postitive n
  51             if ( x.info(info_flags::posint) ) {
  52                 return factorial(ex_to_numeric(x).sub(numONE()));
  53             } else {
  54                 return numZERO();  // Infinity. Throw? What?
  55             }
  56         }
  57         // trap half integer arguments:
  58         if ( (x*2).info(info_flags::integer) ) {
  59             // trap positive x=(n+1/2)
  60             // gamma(n+1/2) -> Pi^(1/2)*(1*3*..*(2*n-1))/(2^n)
  61             if ( (x*2).info(info_flags::posint) ) {
  62                 numeric n = ex_to_numeric(x).sub(numHALF());
  63                 numeric coefficient = doublefactorial(n.mul(numTWO()).sub(numONE()));
  64                 coefficient = coefficient.div(numTWO().power(n));
  65                 return coefficient * pow(Pi,numHALF());
  66             } else {
  67                 // trap negative x=(-n+1/2)
  68                 // gamma(-n+1/2) -> Pi^(1/2)*(-2)^n/(1*3*..*(2*n-1))
  69                 numeric n = abs(ex_to_numeric(x).sub(numHALF()));
  70                 numeric coefficient = numeric(-2).power(n);
  71                 coefficient = coefficient.div(doublefactorial(n.mul(numTWO()).sub(numONE())));;
  72                 return coefficient*sqrt(Pi);
  73             }
  74         }
  75     }
  76     return gamma(x).hold();
  77 }
  78
  79 static ex gamma_evalf(ex const & x)
  80 {
  81     BEGIN_TYPECHECK
  82         TYPECHECK(x,numeric)
  83     END_TYPECHECK(gamma(x))
  84
  85     return gamma(ex_to_numeric(x));
  86 }
  87
  88 static ex gamma_diff(ex const & x, unsigned diff_param)
  89 {
  90     ASSERT(diff_param==0);
  91
  92     return psi(exZERO(),x)*gamma(x);
  93 }
  94
  95 static ex gamma_series(ex const & x, symbol const & s, ex const & point, int order)
  96 {
  97         // FIXME: Only handle one special case for now...
  98         if (x.is_equal(s) && point.is_zero()) {
  99                 ex e = 1 / s - EulerGamma + s * (pow(Pi, 2) / 12 + pow(EulerGamma, 2) / 2) + Order(pow(s, 2));
 100                 return e.series(s, point, order);
 101         } else
 102                 throw(std::logic_error("don't know the series expansion of this particular gamma function"));
 103 }
 104
 105 REGISTER_FUNCTION(gamma, gamma_eval, gamma_evalf, gamma_diff, gamma_series);
 106
 107 //////////
 108 // psi function (aka polygamma function)
 109 //////////
 110
 111 /** Evaluation of polygamma-function psi(n,x).
 112  *  Somebody ought to provide some good numerical evaluation some day... */
 113 static ex psi_eval(ex const & n, ex const & x)
 114 {
 115     if (n.info(info_flags::numeric) && x.info(info_flags::numeric)) {
 116         // do some stuff...
 117     }
 118     return psi(n, x).hold();
 119 }
 120
 121 static ex psi_evalf(ex const & n, ex const & x)
 122 {
 123     BEGIN_TYPECHECK
 124         TYPECHECK(n,numeric)
 125         TYPECHECK(x,numeric)
 126     END_TYPECHECK(psi(n,x))
 127
 128     return psi(ex_to_numeric(n), ex_to_numeric(x));
 129 }
 130
 131 static ex psi_diff(ex const & n, ex const & x, unsigned diff_param)
 132 {
 133     ASSERT(diff_param==0);
 134
 135     return psi(n+1, x);
 136 }
 137
 138 static ex psi_series(ex const & n, ex const & x, symbol const & s, ex const & point, int order)
 139 {
 140     throw(std::logic_error("Nobody told me how to series expand the psi function. :-("));
 141 }
 142
 143 REGISTER_FUNCTION(psi, psi_eval, psi_evalf, psi_diff, psi_series);
 144
 145 } // namespace GiNaC