ginac/integral.cpp

   1 /** @file integral.cpp
   2  *
   3  *  Implementation of GiNaC's symbolic  integral. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2008 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #include "integral.h"
  24 #include "numeric.h"
  25 #include "symbol.h"
  26 #include "add.h"
  27 #include "mul.h"
  28 #include "power.h"
  29 #include "inifcns.h"
  30 #include "wildcard.h"
  31 #include "archive.h"
  32 #include "registrar.h"
  33 #include "utils.h"
  34 #include "operators.h"
  35 #include "relational.h"
  36
  37 using namespace std;
  38
  39 namespace GiNaC {
  40
  41 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(integral, basic,
  42   print_func<print_dflt>(&integral::do_print).
  43   print_func<print_latex>(&integral::do_print_latex))
  44
  45
  46 //////////
  47 // default constructor
  48 //////////
  49
  50 integral::integral()
  51                 : inherited(&integral::tinfo_static),
  52                 x((new symbol())->setflag(status_flags::dynallocated))
  53 {}
  54
  55 //////////
  56 // other constructors
  57 //////////
  58
  59 // public
  60
  61 integral::integral(const ex & x_, const ex & a_, const ex & b_, const ex & f_)
  62                 : inherited(&integral::tinfo_static), x(x_), a(a_), b(b_), f(f_)
  63 {
  64         if (!is_a<symbol>(x)) {
  65                 throw(std::invalid_argument("first argument of integral must be of type symbol"));
  66         }
  67 }
  68
  69 //////////
  70 // archiving
  71 //////////
  72
  73 integral::integral(const archive_node & n, lst & sym_lst) : inherited(n, sym_lst)
  74 {
  75         n.find_ex("x", x, sym_lst);
  76         n.find_ex("a", a, sym_lst);
  77         n.find_ex("b", b, sym_lst);
  78         n.find_ex("f", f, sym_lst);
  79 }
  80
  81 void integral::archive(archive_node & n) const
  82 {
  83         inherited::archive(n);
  84         n.add_ex("x", x);
  85         n.add_ex("a", a);
  86         n.add_ex("b", b);
  87         n.add_ex("f", f);
  88 }
  89
  90 DEFAULT_UNARCHIVE(integral)
  91
  92 //////////
  93 // functions overriding virtual functions from base classes
  94 //////////
  95
  96 void integral::do_print(const print_context & c, unsigned level) const
  97 {
  98         c.s << "integral(";
  99         x.print(c);
 100         c.s << ",";
 101         a.print(c);
 102         c.s << ",";
 103         b.print(c);
 104         c.s << ",";
 105         f.print(c);
 106         c.s << ")";
 107 }
 108
 109 void integral::do_print_latex(const print_latex & c, unsigned level) const
 110 {
 111         string varname = ex_to<symbol>(x).get_name();
 112         if (level > precedence())
 113                 c.s << "\\left(";
 114         c.s << "\\int_{";
 115         a.print(c);
 116         c.s << "}^{";
 117         b.print(c);
 118         c.s << "} d";
 119         if (varname.size() > 1)
 120                 c.s << "\\," << varname << "\\:";
 121         else
 122                 c.s << varname << "\\,";
 123         f.print(c,precedence());
 124         if (level > precedence())
 125                 c.s << "\\right)";
 126 }
 127
 128 int integral::compare_same_type(const basic & other) const
 129 {
 130         GINAC_ASSERT(is_exactly_a<integral>(other));
 131         const integral &o = static_cast<const integral &>(other);
 132
 133         int cmpval = x.compare(o.x);
 134         if (cmpval)
 135                 return cmpval;
 136         cmpval = a.compare(o.a);
 137         if (cmpval)
 138                 return cmpval;
 139         cmpval = b.compare(o.b);
 140         if (cmpval)
 141                 return cmpval;
 142         return f.compare(o.f);
 143 }
 144
 145 ex integral::eval(int level) const
 146 {
 147         if ((level==1) && (flags & status_flags::evaluated))
 148                 return *this;
 149         if (level == -max_recursion_level)
 150                 throw(std::runtime_error("max recursion level reached"));
 151
 152         ex eintvar = (level==1) ? x : x.eval(level-1);
 153         ex ea      = (level==1) ? a : a.eval(level-1);
 154         ex eb      = (level==1) ? b : b.eval(level-1);
 155         ex ef      = (level==1) ? f : f.eval(level-1);
 156
 157         if (!ef.has(eintvar) && !haswild(ef))
 158                 return eb*ef-ea*ef;
 159
 160         if (ea==eb)
 161                 return _ex0;
 162
 163         if (are_ex_trivially_equal(eintvar,x) && are_ex_trivially_equal(ea,a)
 164                         && are_ex_trivially_equal(eb,b) && are_ex_trivially_equal(ef,f))
 165                 return this->hold();
 166         return (new integral(eintvar, ea, eb, ef))
 167                 ->setflag(status_flags::dynallocated | status_flags::evaluated);
 168 }
 169
 170 ex integral::evalf(int level) const
 171 {
 172         ex ea;
 173         ex eb;
 174         ex ef;
 175
 176         if (level==1) {
 177                 ea = a;
 178                 eb = b;
 179                 ef = f;
 180         } else if (level == -max_recursion_level) {
 181                 throw(runtime_error("max recursion level reached"));
 182         } else {
 183                 ea = a.evalf(level-1);
 184                 eb = b.evalf(level-1);
 185                 ef = f.evalf(level-1);
 186         }
 187
 188         // 12.34 is just an arbitrary number used to check whether a number
 189         // results after subsituting a number for the integration variable.
 190         if (is_exactly_a<numeric>(ea) && is_exactly_a<numeric>(eb)
 191                         && is_exactly_a<numeric>(ef.subs(x==12.34).evalf())) {
 192                 try {
 193                         return adaptivesimpson(x, ea, eb, ef);
 194                 } catch (runtime_error &rte) {}
 195         }
 196
 197         if (are_ex_trivially_equal(a, ea) && are_ex_trivially_equal(b, eb)
 198                                 && are_ex_trivially_equal(f, ef))
 199                         return *this;
 200                 else
 201                         return (new integral(x, ea, eb, ef))
 202                                 ->setflag(status_flags::dynallocated);
 203 }
 204
 205 int integral::max_integration_level = 15;
 206 ex integral::relative_integration_error = 1e-8;
 207
 208 ex subsvalue(const ex & var, const ex & value, const ex & fun)
 209 {
 210         ex result = fun.subs(var==value).evalf();
 211         if (is_a<numeric>(result))
 212                 return result;
 213         throw logic_error("integrand does not evaluate to numeric");
 214 }
 215
 216 struct error_and_integral
 217 {
 218         error_and_integral(const ex &err, const ex &integ)
 219                 :error(err), integral(integ){}
 220         ex error;
 221         ex integral;
 222 };
 223
 224 struct error_and_integral_is_less
 225 {
 226         bool operator()(const error_and_integral &e1,const error_and_integral &e2) const
 227         {
 228                 int c = e1.integral.compare(e2.integral);
 229                 if(c < 0)
 230                         return true;
 231                 if(c > 0)
 232                         return false;
 233                 return ex_is_less()(e1.error, e2.error);
 234         }
 235 };
 236
 237 typedef map<error_and_integral, ex, error_and_integral_is_less> lookup_map;
 238
 239 /** Numeric integration routine based upon the "Adaptive Quadrature" one
 240   * in "Numerical Analysis" by Burden and Faires. Parameters are integration
 241   * variable, left boundary, right boundary, function to be integrated and
 242   * the relative integration error. The function should evalf into a number
 243   * after substituting the integration variable by a number. Another thing
 244   * to note is that this implementation is no good at integrating functions
 245   * with discontinuities. */
 246 ex adaptivesimpson(const ex & x, const ex & a_in, const ex & b_in, const ex & f, const ex & error)
 247 {
 248         // Check whether boundaries and error are numbers.
 249         ex a = is_exactly_a<numeric>(a_in) ? a_in : a_in.evalf();
 250         ex b = is_exactly_a<numeric>(b_in) ? b_in : b_in.evalf();
 251         if(!is_exactly_a<numeric>(a) || !is_exactly_a<numeric>(b))
 252                 throw std::runtime_error("For numerical integration the boundaries of the integral should evalf into numbers.");
 253         if(!is_exactly_a<numeric>(error))
 254                 throw std::runtime_error("For numerical integration the error should be a number.");
 255
 256         // Use lookup table to be potentially much faster.
 257         static lookup_map lookup;
 258         static symbol ivar("ivar");
 259         ex lookupex = integral(ivar,a,b,f.subs(x==ivar));
 260         lookup_map::iterator emi = lookup.find(error_and_integral(error, lookupex));
 261         if (emi!=lookup.end())
 262                 return emi->second;
 263
 264         ex app = 0;
 265         int i = 1;
 266         exvector avec(integral::max_integration_level+1);
 267         exvector hvec(integral::max_integration_level+1);
 268         exvector favec(integral::max_integration_level+1);
 269         exvector fbvec(integral::max_integration_level+1);
 270         exvector fcvec(integral::max_integration_level+1);
 271         exvector svec(integral::max_integration_level+1);
 272         exvector errorvec(integral::max_integration_level+1);
 273         vector<int> lvec(integral::max_integration_level+1);
 274
 275         avec[i] = a;
 276         hvec[i] = (b-a)/2;
 277         favec[i] = subsvalue(x, a, f);
 278         fcvec[i] = subsvalue(x, a+hvec[i], f);
 279         fbvec[i] = subsvalue(x, b, f);
 280         svec[i] = hvec[i]*(favec[i]+4*fcvec[i]+fbvec[i])/3;
 281         lvec[i] = 1;
 282         errorvec[i] = error*abs(svec[i]);
 283
 284         while (i>0) {
 285                 ex fd = subsvalue(x, avec[i]+hvec[i]/2, f);
 286                 ex fe = subsvalue(x, avec[i]+3*hvec[i]/2, f);
 287                 ex s1 = hvec[i]*(favec[i]+4*fd+fcvec[i])/6;
 288                 ex s2 = hvec[i]*(fcvec[i]+4*fe+fbvec[i])/6;
 289                 ex nu1 = avec[i];
 290                 ex nu2 = favec[i];
 291                 ex nu3 = fcvec[i];
 292                 ex nu4 = fbvec[i];
 293                 ex nu5 = hvec[i];
 294                 // hopefully prevents a crash if the function is zero sometimes.
 295                 ex nu6 = max(errorvec[i], abs(s1+s2)*error);
 296                 ex nu7 = svec[i];
 297                 int nu8 = lvec[i];
 298                 --i;
 299                 if (abs(ex_to<numeric>(s1+s2-nu7)) <= nu6)
 300                         app+=(s1+s2);
 301                 else {
 302                         if (nu8>=integral::max_integration_level)
 303                                 throw runtime_error("max integration level reached");
 304                         ++i;
 305                         avec[i] = nu1+nu5;
 306                         favec[i] = nu3;
 307                         fcvec[i] = fe;
 308                         fbvec[i] = nu4;
 309                         hvec[i] = nu5/2;
 310                         errorvec[i]=nu6/2;
 311                         svec[i] = s2;
 312                         lvec[i] = nu8+1;
 313                         ++i;
 314                         avec[i] = nu1;
 315                         favec[i] = nu2;
 316                         fcvec[i] = fd;
 317                         fbvec[i] = nu3;
 318                         hvec[i] = hvec[i-1];
 319                         errorvec[i]=errorvec[i-1];
 320                         svec[i] = s1;
 321                         lvec[i] = lvec[i-1];
 322                 }
 323         }
 324
 325         lookup[error_and_integral(error, lookupex)]=app;
 326         return app;
 327 }
 328
 329 int integral::degree(const ex & s) const
 330 {
 331         return ((b-a)*f).degree(s);
 332 }
 333
 334 int integral::ldegree(const ex & s) const
 335 {
 336         return ((b-a)*f).ldegree(s);
 337 }
 338
 339 ex integral::eval_ncmul(const exvector & v) const
 340 {
 341         return f.eval_ncmul(v);
 342 }
 343
 344 size_t integral::nops() const
 345 {
 346         return 4;
 347 }
 348
 349 ex integral::op(size_t i) const
 350 {
 351         GINAC_ASSERT(i<4);
 352
 353         switch (i) {
 354                 case 0:
 355                         return x;
 356                 case 1:
 357                         return a;
 358                 case 2:
 359                         return b;
 360                 case 3:
 361                         return f;
 362                 default:
 363                         throw (std::out_of_range("integral::op() out of range"));
 364         }
 365 }
 366
 367 ex & integral::let_op(size_t i)
 368 {
 369         ensure_if_modifiable();
 370         switch (i) {
 371                 case 0:
 372                         return x;
 373                 case 1:
 374                         return a;
 375                 case 2:
 376                         return b;
 377                 case 3:
 378                         return f;
 379                 default:
 380                         throw (std::out_of_range("integral::let_op() out of range"));
 381         }
 382 }
 383
 384 ex integral::expand(unsigned options) const
 385 {
 386         if (options==0 && (flags & status_flags::expanded))
 387                 return *this;
 388
 389         ex newa = a.expand(options);
 390         ex newb = b.expand(options);
 391         ex newf = f.expand(options);
 392
 393         if (is_a<add>(newf)) {
 394                 exvector v;
 395                 v.reserve(newf.nops());
 396                 for (size_t i=0; i<newf.nops(); ++i)
 397                         v.push_back(integral(x, newa, newb, newf.op(i)).expand(options));
 398                 return ex(add(v)).expand(options);
 399         }
 400
 401         if (is_a<mul>(newf)) {
 402                 ex prefactor = 1;
 403                 ex rest = 1;
 404                 for (size_t i=0; i<newf.nops(); ++i)
 405                         if (newf.op(i).has(x))
 406                                 rest *= newf.op(i);
 407                         else
 408                                 prefactor *= newf.op(i);
 409                 if (prefactor != 1)
 410                         return (prefactor*integral(x, newa, newb, rest)).expand(options);
 411         }
 412
 413         if (are_ex_trivially_equal(a, newa) && are_ex_trivially_equal(b, newb)
 414                         && are_ex_trivially_equal(f, newf)) {
 415                 if (options==0)
 416                         this->setflag(status_flags::expanded);
 417                 return *this;
 418         }
 419
 420         const basic & newint = (new integral(x, newa, newb, newf))
 421                 ->setflag(status_flags::dynallocated);
 422         if (options == 0)
 423                 newint.setflag(status_flags::expanded);
 424         return newint;
 425 }
 426
 427 ex integral::derivative(const symbol & s) const
 428 {
 429         if (s==x)
 430                 throw(logic_error("differentiation with respect to dummy variable"));
 431         return b.diff(s)*f.subs(x==b)-a.diff(s)*f.subs(x==a)+integral(x, a, b, f.diff(s));
 432 }
 433
 434 unsigned integral::return_type() const
 435 {
 436         return f.return_type();
 437 }
 438
 439 tinfo_t integral::return_type_tinfo() const
 440 {
 441         return f.return_type_tinfo();
 442 }
 443
 444 ex integral::conjugate() const
 445 {
 446         ex conja = a.conjugate();
 447         ex conjb = b.conjugate();
 448         ex conjf = f.conjugate().subs(x.conjugate()==x);
 449
 450         if (are_ex_trivially_equal(a, conja) && are_ex_trivially_equal(b, conjb)
 451                         && are_ex_trivially_equal(f, conjf))
 452                 return *this;
 453
 454         return (new integral(x, conja, conjb, conjf))
 455                 ->setflag(status_flags::dynallocated);
 456 }
 457
 458 ex integral::eval_integ() const
 459 {
 460         if (!(flags & status_flags::expanded))
 461                 return this->expand().eval_integ();
 462
 463         if (f==x)
 464                 return b*b/2-a*a/2;
 465         if (is_a<power>(f) && f.op(0)==x) {
 466                 if (f.op(1)==-1)
 467                         return log(b/a);
 468                 if (!f.op(1).has(x)) {
 469                         ex primit = power(x,f.op(1)+1)/(f.op(1)+1);
 470                         return primit.subs(x==b)-primit.subs(x==a);
 471                 }
 472         }
 473
 474         return *this;
 475 }
 476
 477 } // namespace GiNaC