]> www.ginac.de Git - ginac.git/blobdiff - ginac/inifcns_gamma.cpp
- Made determinant_algo (in flags.h) really work.
[ginac.git] / ginac / inifcns_gamma.cpp
index fe059a4449003ee08099fb79cbcd274efe19588c..aa1cab4c1f365f8edca64acbc80195d8804647a9 100644 (file)
@@ -39,40 +39,118 @@ namespace GiNaC {
 #endif // ndef NO_NAMESPACE_GINAC
 
 //////////
-// Gamma-function
+// Logarithm of Gamma function
 //////////
 
-static ex Gamma_evalf(const ex & x)
+static ex lgamma_evalf(const ex & x)
 {
     BEGIN_TYPECHECK
         TYPECHECK(x,numeric)
-    END_TYPECHECK(Gamma(x))
+    END_TYPECHECK(lgamma(x))
     
-    return Gamma(ex_to_numeric(x));
+    return lgamma(ex_to_numeric(x));
 }
 
 
-/** Evaluation of Gamma(x). Knows about integer arguments, half-integer
- *  arguments and that's it. Somebody ought to provide some good numerical
- *  evaluation some day...
+/** Evaluation of lgamma(x), the natural logarithm of the Gamma function.
+ *  Knows about integer arguments and that's it.  Somebody ought to provide
+ *  some good numerical evaluation some day...
  *
- *  @exception std::domain_error("Gamma_eval(): simple pole") */
-static ex Gamma_eval(const ex & x)
+ *  @exception GiNaC::pole_error("lgamma_eval(): logarithmic pole",0) */
+static ex lgamma_eval(const ex & x)
 {
     if (x.info(info_flags::numeric)) {
         // trap integer arguments:
         if (x.info(info_flags::integer)) {
-            // Gamma(n+1) -> n! for postitive n
+            // lgamma(n) -> log((n-1)!) for postitive n
+            if (x.info(info_flags::posint))
+                return log(factorial(x.exadd(_ex_1())));
+            else
+                throw (pole_error("lgamma_eval(): logarithmic pole",0));
+        }
+        //  lgamma_evalf should be called here once it becomes available
+    }
+    
+    return lgamma(x).hold();
+}
+
+
+static ex lgamma_deriv(const ex & x, unsigned deriv_param)
+{
+    GINAC_ASSERT(deriv_param==0);
+    
+    // d/dx  lgamma(x) -> psi(x)
+    return psi(x);
+}
+
+
+static ex lgamma_series(const ex & arg,
+                        const relational & rel,
+                        int order,
+                        unsigned options)
+{
+    // method:
+    // Taylor series where there is no pole falls back to psi function
+    // evaluation.
+    // On a pole at -m we could use the recurrence relation
+    //   lgamma(x) == lgamma(x+1)-log(x)
+    // from which follows
+    //   series(lgamma(x),x==-m,order) ==
+    //   series(lgamma(x+m+1)-log(x)...-log(x+m)),x==-m,order);
+    const ex arg_pt = arg.subs(rel);
+    if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
+        throw do_taylor();  // caught by function::series()
+    // if we got here we have to care for a simple pole of tgamma(-m):
+    numeric m = -ex_to_numeric(arg_pt);
+    ex recur;
+    for (numeric p; p<=m; ++p)
+        recur += log(arg+p);
+    cout << recur << endl;
+    return (lgamma(arg+m+_ex1())-recur).series(rel, order, options);
+}
+
+
+REGISTER_FUNCTION(lgamma, eval_func(lgamma_eval).
+                          evalf_func(lgamma_evalf).
+                          derivative_func(lgamma_deriv).
+                          series_func(lgamma_series));
+
+
+//////////
+// true Gamma function
+//////////
+
+static ex tgamma_evalf(const ex & x)
+{
+    BEGIN_TYPECHECK
+        TYPECHECK(x,numeric)
+    END_TYPECHECK(tgamma(x))
+    
+    return tgamma(ex_to_numeric(x));
+}
+
+
+/** Evaluation of tgamma(x), the true Gamma function.  Knows about integer
+ *  arguments, half-integer arguments and that's it. Somebody ought to provide
+ *  some good numerical evaluation some day...
+ *
+ *  @exception pole_error("tgamma_eval(): simple pole",0) */
+static ex tgamma_eval(const ex & x)
+{
+    if (x.info(info_flags::numeric)) {
+        // trap integer arguments:
+        if (x.info(info_flags::integer)) {
+            // tgamma(n) -> (n-1)! for postitive n
             if (x.info(info_flags::posint)) {
                 return factorial(ex_to_numeric(x).sub(_num1()));
             } else {
-                throw (std::domain_error("Gamma_eval(): simple pole"));
+                throw (pole_error("tgamma_eval(): simple pole",1));
             }
         }
         // trap half integer arguments:
         if ((x*2).info(info_flags::integer)) {
             // trap positive x==(n+1/2)
-            // Gamma(n+1/2) -> Pi^(1/2)*(1*3*..*(2*n-1))/(2^n)
+            // tgamma(n+1/2) -> Pi^(1/2)*(1*3*..*(2*n-1))/(2^n)
             if ((x*_ex2()).info(info_flags::posint)) {
                 numeric n = ex_to_numeric(x).sub(_num1_2());
                 numeric coefficient = doublefactorial(n.mul(_num2()).sub(_num1()));
@@ -80,96 +158,98 @@ static ex Gamma_eval(const ex & x)
                 return coefficient * pow(Pi,_ex1_2());
             } else {
                 // trap negative x==(-n+1/2)
-                // Gamma(-n+1/2) -> Pi^(1/2)*(-2)^n/(1*3*..*(2*n-1))
+                // tgamma(-n+1/2) -> Pi^(1/2)*(-2)^n/(1*3*..*(2*n-1))
                 numeric n = abs(ex_to_numeric(x).sub(_num1_2()));
                 numeric coefficient = pow(_num_2(), n);
                 coefficient = coefficient.div(doublefactorial(n.mul(_num2()).sub(_num1())));;
                 return coefficient*power(Pi,_ex1_2());
             }
         }
-        //  Gamma_evalf should be called here once it becomes available
+        //  tgamma_evalf should be called here once it becomes available
     }
     
-    return Gamma(x).hold();
-}    
+    return tgamma(x).hold();
+}
 
 
-static ex Gamma_deriv(const ex & x, unsigned deriv_param)
+static ex tgamma_deriv(const ex & x, unsigned deriv_param)
 {
     GINAC_ASSERT(deriv_param==0);
     
-    // d/dx  log(Gamma(x)) -> psi(x)
-    // d/dx  Gamma(x) -> psi(x)*Gamma(x)
-    return psi(x)*Gamma(x);
+    // d/dx  tgamma(x) -> psi(x)*tgamma(x)
+    return psi(x)*tgamma(x);
 }
 
 
-static ex Gamma_series(const ex & x, const symbol & s, const ex & pt, int order)
+static ex tgamma_series(const ex & arg,
+                        const relational & rel,
+                        int order,
+                        unsigned options)
 {
     // method:
     // Taylor series where there is no pole falls back to psi function
     // evaluation.
     // On a pole at -m use the recurrence relation
-    //   Gamma(x) == Gamma(x+1) / x
+    //   tgamma(x) == tgamma(x+1) / x
     // from which follows
-    //   series(Gamma(x),x,-m,order) ==
-    //   series(Gamma(x+m+1)/(x*(x+1)*...*(x+m)),x,-m,order+1);
-    const ex x_pt = x.subs(s==pt);
-    if (!x_pt.info(info_flags::integer) || x_pt.info(info_flags::positive))
+    //   series(tgamma(x),x==-m,order) ==
+    //   series(tgamma(x+m+1)/(x*(x+1)*...*(x+m)),x==-m,order+1);
+    const ex arg_pt = arg.subs(rel);
+    if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
         throw do_taylor();  // caught by function::series()
     // if we got here we have to care for a simple pole at -m:
-    numeric m = -ex_to_numeric(x_pt);
+    numeric m = -ex_to_numeric(arg_pt);
     ex ser_denom = _ex1();
     for (numeric p; p<=m; ++p)
-        ser_denom *= x+p;
-    return (Gamma(x+m+_ex1())/ser_denom).series(s, pt, order+1);
+        ser_denom *= arg+p;
+    return (tgamma(arg+m+_ex1())/ser_denom).series(rel, order+1, options);
 }
 
 
-REGISTER_FUNCTION(Gamma, eval_func(Gamma_eval).
-                         evalf_func(Gamma_evalf).
-                         derivative_func(Gamma_deriv).
-                         series_func(Gamma_series));
+REGISTER_FUNCTION(tgamma, eval_func(tgamma_eval).
+                          evalf_func(tgamma_evalf).
+                          derivative_func(tgamma_deriv).
+                          series_func(tgamma_series));
 
 
 //////////
-// Beta-function
+// beta-function
 //////////
 
-static ex Beta_evalf(const ex & x, const ex & y)
+static ex beta_evalf(const ex & x, const ex & y)
 {
     BEGIN_TYPECHECK
         TYPECHECK(x,numeric)
         TYPECHECK(y,numeric)
-    END_TYPECHECK(Beta(x,y))
+    END_TYPECHECK(beta(x,y))
     
-    return Gamma(ex_to_numeric(x))*Gamma(ex_to_numeric(y))/Gamma(ex_to_numeric(x+y));
+    return tgamma(ex_to_numeric(x))*tgamma(ex_to_numeric(y))/tgamma(ex_to_numeric(x+y));
 }
 
 
-static ex Beta_eval(const ex & x, const ex & y)
+static ex beta_eval(const ex & x, const ex & y)
 {
     if (x.info(info_flags::numeric) && y.info(info_flags::numeric)) {
-        // treat all problematic x and y that may not be passed into Gamma,
-        // because they would throw there although Beta(x,y) is well-defined
-        // using the formula Beta(x,y) == (-1)^y * Beta(1-x-y, y)
+        // treat all problematic x and y that may not be passed into tgamma,
+        // because they would throw there although beta(x,y) is well-defined
+        // using the formula beta(x,y) == (-1)^y * beta(1-x-y, y)
         numeric nx(ex_to_numeric(x));
         numeric ny(ex_to_numeric(y));
         if (nx.is_real() && nx.is_integer() &&
             ny.is_real() && ny.is_integer()) {
             if (nx.is_negative()) {
                 if (nx<=-ny)
-                    return pow(_num_1(), ny)*Beta(1-x-y, y);
+                    return pow(_num_1(), ny)*beta(1-x-y, y);
                 else
-                    throw (std::domain_error("Beta_eval(): simple pole"));
+                    throw (pole_error("beta_eval(): simple pole",1));
             }
             if (ny.is_negative()) {
                 if (ny<=-nx)
-                    return pow(_num_1(), nx)*Beta(1-y-x, x);
+                    return pow(_num_1(), nx)*beta(1-y-x, x);
                 else
-                    throw (std::domain_error("Beta_eval(): simple pole"));
+                    throw (pole_error("beta_eval(): simple pole",1));
             }
-            return Gamma(x)*Gamma(y)/Gamma(x+y);
+            return tgamma(x)*tgamma(y)/tgamma(x+y);
         }
         // no problem in numerator, but denominator has pole:
         if ((nx+ny).is_real() &&
@@ -177,65 +257,70 @@ static ex Beta_eval(const ex & x, const ex & y)
             !(nx+ny).is_positive())
              return _ex0();
         // everything is ok:
-        return Gamma(x)*Gamma(y)/Gamma(x+y);
+        return tgamma(x)*tgamma(y)/tgamma(x+y);
     }
     
-    return Beta(x,y).hold();
+    return beta(x,y).hold();
 }
 
 
-static ex Beta_deriv(const ex & x, const ex & y, unsigned deriv_param)
+static ex beta_deriv(const ex & x, const ex & y, unsigned deriv_param)
 {
     GINAC_ASSERT(deriv_param<2);
     ex retval;
     
-    // d/dx Beta(x,y) -> (psi(x)-psi(x+y)) * Beta(x,y)
+    // d/dx beta(x,y) -> (psi(x)-psi(x+y)) * beta(x,y)
     if (deriv_param==0)
-        retval = (psi(x)-psi(x+y))*Beta(x,y);
-    // d/dy Beta(x,y) -> (psi(y)-psi(x+y)) * Beta(x,y)
+        retval = (psi(x)-psi(x+y))*beta(x,y);
+    // d/dy beta(x,y) -> (psi(y)-psi(x+y)) * beta(x,y)
     if (deriv_param==1)
-        retval = (psi(y)-psi(x+y))*Beta(x,y);
+        retval = (psi(y)-psi(x+y))*beta(x,y);
     return retval;
 }
 
 
-static ex Beta_series(const ex & x, const ex & y, const symbol & s, const ex & pt, int order)
+static ex beta_series(const ex & arg1,
+                      const ex & arg2,
+                      const relational & rel,
+                      int order,
+                      unsigned options)
 {
     // method:
-    // Taylor series where there is no pole of one of the Gamma functions
-    // falls back to Beta function evaluation.  Otherwise, fall back to
-    // Gamma series directly.
-    // FIXME: this could need some testing, maybe it's wrong in some cases?
-    const ex x_pt = x.subs(s==pt);
-    const ex y_pt = y.subs(s==pt);
-    ex x_ser, y_ser, xy_ser;
-    if ((!x_pt.info(info_flags::integer) || x_pt.info(info_flags::positive)) &&
-        (!y_pt.info(info_flags::integer) || y_pt.info(info_flags::positive)))
+    // Taylor series where there is no pole of one of the tgamma functions
+    // falls back to beta function evaluation.  Otherwise, fall back to
+    // tgamma series directly.
+    const ex arg1_pt = arg1.subs(rel);
+    const ex arg2_pt = arg2.subs(rel);
+    GINAC_ASSERT(is_ex_exactly_of_type(rel.lhs(),symbol));
+    const symbol *s = static_cast<symbol *>(rel.lhs().bp);
+    ex arg1_ser, arg2_ser, arg1arg2_ser;
+    if ((!arg1_pt.info(info_flags::integer) || arg1_pt.info(info_flags::positive)) &&
+        (!arg2_pt.info(info_flags::integer) || arg2_pt.info(info_flags::positive)))
         throw do_taylor();  // caught by function::series()
-    // trap the case where x is on a pole directly:
-    if (x.info(info_flags::integer) && !x.info(info_flags::positive))
-        x_ser = Gamma(x+s).series(s,pt,order);
+    // trap the case where arg1 is on a pole:
+    if (arg1.info(info_flags::integer) && !arg1.info(info_flags::positive))
+        arg1_ser = tgamma(arg1+*s).series(rel, order, options);
     else
-        x_ser = Gamma(x).series(s,pt,order);
-    // trap the case where y is on a pole directly:
-    if (y.info(info_flags::integer) && !y.info(info_flags::positive))
-        y_ser = Gamma(y+s).series(s,pt,order);
+        arg1_ser = tgamma(arg1).series(rel,order);
+    // trap the case where arg2 is on a pole:
+    if (arg2.info(info_flags::integer) && !arg2.info(info_flags::positive))
+        arg2_ser = tgamma(arg2+*s).series(rel, order, options);
     else
-        y_ser = Gamma(y).series(s,pt,order);
-    // trap the case where y is on a pole directly:
-    if ((x+y).info(info_flags::integer) && !(x+y).info(info_flags::positive))
-        xy_ser = Gamma(y+x+s).series(s,pt,order);
+        arg2_ser = tgamma(arg2).series(rel,order);
+    // trap the case where arg1+arg2 is on a pole:
+    if ((arg1+arg2).info(info_flags::integer) && !(arg1+arg2).info(info_flags::positive))
+        arg1arg2_ser = tgamma(arg2+arg1+*s).series(rel, order, options);
     else
-        xy_ser = Gamma(y+x).series(s,pt,order);
-    // compose the result:
-    return (x_ser*y_ser/xy_ser).series(s,pt,order);
+        arg1arg2_ser = tgamma(arg2+arg1).series(rel,order);
+    // compose the result (expanding all the terms):
+    return (arg1_ser*arg2_ser/arg1arg2_ser).series(rel, order, options).expand();
 }
 
 
-REGISTER_FUNCTION(Beta, eval_func(Beta_eval).
-                        evalf_func(Beta_evalf).
-                        derivative_func(Beta_deriv).
-                        series_func(Beta_series));
+REGISTER_FUNCTION(beta, eval_func(beta_eval).
+                        evalf_func(beta_evalf).
+                        derivative_func(beta_deriv).
+                        series_func(beta_series));
 
 
 //////////
@@ -260,24 +345,24 @@ static ex psi1_eval(const ex & x)
         if (nx.is_integer()) {
             // integer case 
             if (nx.is_positive()) {
-                // psi(n) -> 1 + 1/2 +...+ 1/(n-1) - gamma
+                // psi(n) -> 1 + 1/2 +...+ 1/(n-1) - Euler
                 numeric rat(0);
                 for (numeric i(nx+_num_1()); i.is_positive(); --i)
                     rat += i.inverse();
-                return rat-gamma;
+                return rat-Euler;
             } else {
                 // for non-positive integers there is a pole:
-                throw (std::domain_error("psi_eval(): simple pole"));
+                throw (pole_error("psi_eval(): simple pole",1));
             }
         }
         if ((_num2()*nx).is_integer()) {
             // half integer case
             if (nx.is_positive()) {
-                // psi((2m+1)/2) -> 2/(2m+1) + 2/2m +...+ 2/1 - gamma - 2log(2)
+                // psi((2m+1)/2) -> 2/(2m+1) + 2/2m +...+ 2/1 - Euler - 2log(2)
                 numeric rat(0);
                 for (numeric i((nx+_num_1())*_num2()); i.is_positive(); i-=_num2())
                                       rat += _num2()*i.inverse();
-                                      return rat-gamma-_ex2()*log(_ex2());
+                                      return rat-Euler-_ex2()*log(_ex2());
             } else {
                 // use the recurrence relation
                 //   psi(-m-1/2) == psi(-m-1/2+1) - 1 / (-m-1/2)
@@ -304,7 +389,10 @@ static ex psi1_deriv(const ex & x, unsigned deriv_param)
     return psi(_ex1(), x);
 }
 
-static ex psi1_series(const ex & x, const symbol & s, const ex & pt, int order)
+static ex psi1_series(const ex & arg,
+                      const relational & rel,
+                      int order,
+                      unsigned options)
 {
     // method:
     // Taylor series where there is no pole falls back to polygamma function
@@ -312,17 +400,17 @@ static ex psi1_series(const ex & x, const symbol & s, const ex & pt, int order)
     // On a pole at -m use the recurrence relation
     //   psi(x) == psi(x+1) - 1/z
     // from which follows
-    //   series(psi(x),x,-m,order) ==
-    //   series(psi(x+m+1) - 1/x - 1/(x+1) - 1/(x+m)),x,-m,order);
-    const ex x_pt = x.subs(s==pt);
-    if (!x_pt.info(info_flags::integer) || x_pt.info(info_flags::positive))
+    //   series(psi(x),x==-m,order) ==
+    //   series(psi(x+m+1) - 1/x - 1/(x+1) - 1/(x+m)),x==-m,order);
+    const ex arg_pt = arg.subs(rel);
+    if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
         throw do_taylor();  // caught by function::series()
     // if we got here we have to care for a simple pole at -m:
-    numeric m = -ex_to_numeric(x_pt);
+    numeric m = -ex_to_numeric(arg_pt);
     ex recur;
     for (numeric p; p<=m; ++p)
-        recur += power(x+p,_ex_1());
-    return (psi(x+m+_ex1())-recur).series(s, pt, order);
+        recur += power(arg+p,_ex_1());
+    return (psi(arg+m+_ex1())-recur).series(rel, order, options);
 }
 
 const unsigned function_index_psi1 =
@@ -354,9 +442,9 @@ static ex psi2_eval(const ex & n, const ex & x)
     // psi(0,x) -> psi(x)
     if (n.is_zero())
         return psi(x);
-    // psi(-1,x) -> log(Gamma(x))
+    // psi(-1,x) -> log(tgamma(x))
     if (n.is_equal(_ex_1()))
-        return log(Gamma(x));
+        return log(tgamma(x));
     if (n.info(info_flags::numeric) && n.info(info_flags::posint) &&
         x.info(info_flags::numeric)) {
         numeric nn = ex_to_numeric(n);
@@ -379,7 +467,7 @@ static ex psi2_eval(const ex & n, const ex & x)
                 return recur+psi(n,_ex1());
             } else {
                 // for non-positive integers there is a pole:
-                throw (std::domain_error("psi2_eval(): pole"));
+                throw (pole_error("psi2_eval(): pole",1));
             }
         }
         if ((_num2()*nx).is_integer()) {
@@ -424,7 +512,11 @@ static ex psi2_deriv(const ex & n, const ex & x, unsigned deriv_param)
     return psi(n+_ex1(), x);
 }
 
-static ex psi2_series(const ex & n, const ex & x, const symbol & s, const ex & pt, int order)
+static ex psi2_series(const ex & n,
+                      const ex & arg,
+                      const relational & rel,
+                      int order,
+                      unsigned options)
 {
     // method:
     // Taylor series where there is no pole falls back to polygamma function
@@ -432,26 +524,26 @@ static ex psi2_series(const ex & n, const ex & x, const symbol & s, const ex & p
     // On a pole at -m use the recurrence relation
     //   psi(n,x) == psi(n,x+1) - (-)^n * n! / x^(n+1)
     // from which follows
-    //   series(psi(x),x,-m,order) == 
+    //   series(psi(x),x==-m,order) == 
     //   series(psi(x+m+1) - (-1)^n * n! * ((x)^(-n-1) + (x+1)^(-n-1) + ...
-    //                                      ... + (x+m)^(-n-1))),x,-m,order);
-    const ex x_pt = x.subs(s==pt);
-    if (!x_pt.info(info_flags::integer) || x_pt.info(info_flags::positive))
+    //                                      ... + (x+m)^(-n-1))),x==-m,order);
+    const ex arg_pt = arg.subs(rel);
+    if (!arg_pt.info(info_flags::integer) || arg_pt.info(info_flags::positive))
         throw do_taylor();  // caught by function::series()
     // if we got here we have to care for a pole of order n+1 at -m:
-    numeric m = -ex_to_numeric(x_pt);
+    numeric m = -ex_to_numeric(arg_pt);
     ex recur;
     for (numeric p; p<=m; ++p)
-        recur += power(x+p,-n+_ex_1());
+        recur += power(arg+p,-n+_ex_1());
     recur *= factorial(n)*power(_ex_1(),n);
-    return (psi(n, x+m+_ex1())-recur).series(s, pt, order);
+    return (psi(n, arg+m+_ex1())-recur).series(rel, order, options);
 }
 
 const unsigned function_index_psi2 =
     function::register_new(function_options("psi").
                            eval_func(psi2_eval).
                            evalf_func(psi2_evalf).
-                          derivative_func(psi2_deriv).
+               derivative_func(psi2_deriv).
                           series_func(psi2_series).
                           overloaded(2));