ginac/inifcns.cpp

   1 /** @file inifcns.cpp
   2  *
   3  *  Implementation of GiNaC's initially known functions. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2000 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 "lst.h"
  30 #include "matrix.h"
  31 #include "mul.h"
  32 #include "ncmul.h"
  33 #include "numeric.h"
  34 #include "power.h"
  35 #include "relational.h"
  36 #include "pseries.h"
  37 #include "symbol.h"
  38 #include "utils.h"
  39
  40 #ifndef NO_NAMESPACE_GINAC
  41 namespace GiNaC {
  42 #endif // ndef NO_NAMESPACE_GINAC
  43
  44 //////////
  45 // absolute value
  46 //////////
  47
  48 static ex abs_evalf(const ex & x)
  49 {
  50     BEGIN_TYPECHECK
  51         TYPECHECK(x,numeric)
  52     END_TYPECHECK(abs(x))
  53
  54     return abs(ex_to_numeric(x));
  55 }
  56
  57 static ex abs_eval(const ex & x)
  58 {
  59     if (is_ex_exactly_of_type(x, numeric))
  60         return abs(ex_to_numeric(x));
  61     else
  62         return abs(x).hold();
  63 }
  64
  65 REGISTER_FUNCTION(abs, eval_func(abs_eval).
  66                        evalf_func(abs_evalf));
  67
  68 //////////
  69 // dilogarithm
  70 //////////
  71
  72 static ex Li2_eval(const ex & x)
  73 {
  74     if (x.is_zero())
  75         return x;
  76     if (x.is_equal(_ex1()))
  77         return power(Pi, _ex2()) / _ex6();
  78     if (x.is_equal(_ex_1()))
  79         return -power(Pi, _ex2()) / _ex12();
  80     return Li2(x).hold();
  81 }
  82
  83 REGISTER_FUNCTION(Li2, eval_func(Li2_eval));
  84
  85 //////////
  86 // trilogarithm
  87 //////////
  88
  89 static ex Li3_eval(const ex & x)
  90 {
  91     if (x.is_zero())
  92         return x;
  93     return Li3(x).hold();
  94 }
  95
  96 REGISTER_FUNCTION(Li3, eval_func(Li3_eval));
  97
  98 //////////
  99 // factorial
 100 //////////
 101
 102 static ex factorial_evalf(const ex & x)
 103 {
 104     return factorial(x).hold();
 105 }
 106
 107 static ex factorial_eval(const ex & x)
 108 {
 109     if (is_ex_exactly_of_type(x, numeric))
 110         return factorial(ex_to_numeric(x));
 111     else
 112         return factorial(x).hold();
 113 }
 114
 115 REGISTER_FUNCTION(factorial, eval_func(factorial_eval).
 116                              evalf_func(factorial_evalf));
 117
 118 //////////
 119 // binomial
 120 //////////
 121
 122 static ex binomial_evalf(const ex & x, const ex & y)
 123 {
 124     return binomial(x, y).hold();
 125 }
 126
 127 static ex binomial_eval(const ex & x, const ex &y)
 128 {
 129     if (is_ex_exactly_of_type(x, numeric) && is_ex_exactly_of_type(y, numeric))
 130         return binomial(ex_to_numeric(x), ex_to_numeric(y));
 131     else
 132         return binomial(x, y).hold();
 133 }
 134
 135 REGISTER_FUNCTION(binomial, eval_func(binomial_eval).
 136                             evalf_func(binomial_evalf));
 137
 138 //////////
 139 // Order term function (for truncated power series)
 140 //////////
 141
 142 static ex Order_eval(const ex & x)
 143 {
 144         if (is_ex_exactly_of_type(x, numeric)) {
 145
 146                 // O(c)=O(1)
 147                 return Order(_ex1()).hold();
 148
 149         } else if (is_ex_exactly_of_type(x, mul)) {
 150
 151                 mul *m = static_cast<mul *>(x.bp);
 152                 if (is_ex_exactly_of_type(m->op(m->nops() - 1), numeric)) {
 153
 154                         // O(c*expr)=O(expr)
 155                         return Order(x / m->op(m->nops() - 1)).hold();
 156                 }
 157         }
 158         return Order(x).hold();
 159 }
 160
 161 static ex Order_series(const ex & x, const symbol & s, const ex & point, int order)
 162 {
 163         // Just wrap the function into a pseries object
 164         epvector new_seq;
 165         new_seq.push_back(expair(Order(_ex1()), numeric(min(x.ldegree(s), order))));
 166         return pseries(s, point, new_seq);
 167 }
 168
 169 // Differentiation is handled in function::derivative because of its special requirements
 170
 171 REGISTER_FUNCTION(Order, eval_func(Order_eval).
 172                          series_func(Order_series));
 173
 174 //////////
 175 // Inert differentiation
 176 //////////
 177
 178 static ex Diff_eval(const ex & f, const ex & x)
 179 {
 180         return Diff(f, x).hold();
 181 }
 182
 183 static ex Diff_deriv(const ex & f, const ex & x, unsigned deriv_param)
 184 {
 185         GINAC_ASSERT(deriv_param == 0 || deriv_param == 1);
 186         if (deriv_param == 1)
 187                 return Diff(Diff(f, x), x);
 188         else
 189                 return _ex0();
 190 }
 191
 192 REGISTER_FUNCTION(Diff, eval_func(Diff_eval).
 193                         derivative_func(Diff_deriv));
 194
 195 //////////
 196 // Inert partial differentiation operator
 197 //////////
 198
 199 static ex Derivative_eval(const ex & f, const ex & n)
 200 {
 201         if (is_ex_exactly_of_type(n, numeric) && ex_to_numeric(n).is_nonneg_integer()) {
 202                 unsigned i = ex_to_numeric(n).to_int();
 203                 if (is_ex_exactly_of_type(f, function)) {
 204                         if (i < f.nops() && is_ex_exactly_of_type(f.op(i), symbol))
 205                                 return Diff(f, f.op(i));
 206                 }
 207         }
 208         return Derivative(f, n).hold();
 209 }
 210
 211 REGISTER_FUNCTION(Derivative, eval_func(Derivative_eval));
 212
 213 //////////
 214 // Solve linear system
 215 //////////
 216
 217 ex lsolve(const ex &eqns, const ex &symbols)
 218 {
 219     // solve a system of linear equations
 220     if (eqns.info(info_flags::relation_equal)) {
 221         if (!symbols.info(info_flags::symbol)) {
 222             throw(std::invalid_argument("lsolve: 2nd argument must be a symbol"));
 223         }
 224         ex sol=lsolve(lst(eqns),lst(symbols));
 225
 226         GINAC_ASSERT(sol.nops()==1);
 227         GINAC_ASSERT(is_ex_exactly_of_type(sol.op(0),relational));
 228
 229         return sol.op(0).op(1); // return rhs of first solution
 230     }
 231
 232     // syntax checks
 233     if (!eqns.info(info_flags::list)) {
 234         throw(std::invalid_argument("lsolve: 1st argument must be a list"));
 235     }
 236     for (unsigned i=0; i<eqns.nops(); i++) {
 237         if (!eqns.op(i).info(info_flags::relation_equal)) {
 238             throw(std::invalid_argument("lsolve: 1st argument must be a list of equations"));
 239         }
 240     }
 241     if (!symbols.info(info_flags::list)) {
 242         throw(std::invalid_argument("lsolve: 2nd argument must be a list"));
 243     }
 244     for (unsigned i=0; i<symbols.nops(); i++) {
 245         if (!symbols.op(i).info(info_flags::symbol)) {
 246             throw(std::invalid_argument("lsolve: 2nd argument must be a list of symbols"));
 247         }
 248     }
 249
 250     // build matrix from equation system
 251     matrix sys(eqns.nops(),symbols.nops());
 252     matrix rhs(eqns.nops(),1);
 253     matrix vars(symbols.nops(),1);
 254
 255     for (unsigned r=0; r<eqns.nops(); r++) {
 256         ex eq = eqns.op(r).op(0)-eqns.op(r).op(1); // lhs-rhs==0
 257         ex linpart = eq;
 258         for (unsigned c=0; c<symbols.nops(); c++) {
 259             ex co = eq.coeff(ex_to_symbol(symbols.op(c)),1);
 260             linpart -= co*symbols.op(c);
 261             sys.set(r,c,co);
 262         }
 263         linpart=linpart.expand();
 264         rhs.set(r,0,-linpart);
 265     }
 266
 267     // test if system is linear and fill vars matrix
 268     for (unsigned i=0; i<symbols.nops(); i++) {
 269         vars.set(i,0,symbols.op(i));
 270         if (sys.has(symbols.op(i)))
 271             throw(std::logic_error("lsolve: system is not linear"));
 272         if (rhs.has(symbols.op(i)))
 273             throw(std::logic_error("lsolve: system is not linear"));
 274     }
 275
 276     //matrix solution=sys.solve(rhs);
 277     matrix solution;
 278     try {
 279         solution = sys.fraction_free_elim(vars,rhs);
 280     } catch (const runtime_error & e) {
 281         // probably singular matrix (or other error)
 282         // return empty solution list
 283         // cerr << e.what() << endl;
 284         return lst();
 285     }
 286
 287     // return a list of equations
 288     if (solution.cols()!=1) {
 289         throw(std::runtime_error("lsolve: strange number of columns returned from matrix::solve"));
 290     }
 291     if (solution.rows()!=symbols.nops()) {
 292         cout << "symbols.nops()=" << symbols.nops() << endl;
 293         cout << "solution.rows()=" << solution.rows() << endl;
 294         throw(std::runtime_error("lsolve: strange number of rows returned from matrix::solve"));
 295     }
 296
 297     // return list of the form lst(var1==sol1,var2==sol2,...)
 298     lst sollist;
 299     for (unsigned i=0; i<symbols.nops(); i++) {
 300         sollist.append(symbols.op(i)==solution(i,0));
 301     }
 302
 303     return sollist;
 304 }
 305
 306 /** non-commutative power. */
 307 ex ncpower(const ex &basis, unsigned exponent)
 308 {
 309     if (exponent==0) {
 310         return _ex1();
 311     }
 312
 313     exvector v;
 314     v.reserve(exponent);
 315     for (unsigned i=0; i<exponent; ++i) {
 316         v.push_back(basis);
 317     }
 318
 319     return ncmul(v,1);
 320 }
 321
 322 /** Force inclusion of functions from initcns_gamma and inifcns_zeta
 323  *  for static lib (so ginsh will see them). */
 324 unsigned force_include_gamma = function_index_gamma;
 325 unsigned force_include_zeta1 = function_index_zeta1;
 326
 327 #ifndef NO_NAMESPACE_GINAC
 328 } // namespace GiNaC
 329 #endif // ndef NO_NAMESPACE_GINAC