ginac/inifcns.h

   1 /** @file inifcns.h
   2  *
   3  *  Interface to GiNaC's initially known functions. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 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 #ifndef __GINAC_INIFCNS_H__
  24 #define __GINAC_INIFCNS_H__
  25
  26 #include "function.h"
  27 #include "ex.h"
  28
  29 namespace GiNaC {
  30
  31 /** Absolute value. */
  32 DECLARE_FUNCTION_1P(abs)
  33
  34 /** Complex sign. */
  35 DECLARE_FUNCTION_1P(csgn)
  36
  37 /** Eta function: log(a*b) == log(a) + log(b) + eta(a, b). */
  38 DECLARE_FUNCTION_2P(eta)
  39
  40 /** Sine. */
  41 DECLARE_FUNCTION_1P(sin)
  42
  43 /** Cosine. */
  44 DECLARE_FUNCTION_1P(cos)
  45
  46 /** Tangent. */
  47 DECLARE_FUNCTION_1P(tan)
  48
  49 /** Exponential function. */
  50 DECLARE_FUNCTION_1P(exp)
  51
  52 /** Natural logarithm. */
  53 DECLARE_FUNCTION_1P(log)
  54
  55 /** Inverse sine (arc sine). */
  56 DECLARE_FUNCTION_1P(asin)
  57
  58 /** Inverse cosine (arc cosine). */
  59 DECLARE_FUNCTION_1P(acos)
  60
  61 /** Inverse tangent (arc tangent). */
  62 DECLARE_FUNCTION_1P(atan)
  63
  64 /** Inverse tangent with two arguments. */
  65 DECLARE_FUNCTION_2P(atan2)
  66
  67 /** Hyperbolic Sine. */
  68 DECLARE_FUNCTION_1P(sinh)
  69
  70 /** Hyperbolic Cosine. */
  71 DECLARE_FUNCTION_1P(cosh)
  72
  73 /** Hyperbolic Tangent. */
  74 DECLARE_FUNCTION_1P(tanh)
  75
  76 /** Inverse hyperbolic Sine (area hyperbolic sine). */
  77 DECLARE_FUNCTION_1P(asinh)
  78
  79 /** Inverse hyperbolic Cosine (area hyperbolic cosine). */
  80 DECLARE_FUNCTION_1P(acosh)
  81
  82 /** Inverse hyperbolic Tangent (area hyperbolic tangent). */
  83 DECLARE_FUNCTION_1P(atanh)
  84
  85 /** Dilogarithm. */
  86 DECLARE_FUNCTION_1P(Li2)
  87
  88 /** Trilogarithm. */
  89 DECLARE_FUNCTION_1P(Li3)
  90
  91 // overloading at work: we cannot use the macros here
  92 /** Riemann's Zeta-function. */
  93 extern const unsigned function_index_zeta1;
  94 inline function zeta(const ex & p1) {
  95         return function(function_index_zeta1, p1);
  96 }
  97 /** Derivatives of Riemann's Zeta-function. */
  98 extern const unsigned function_index_zeta2;
  99 inline function zeta(const ex & p1, const ex & p2) {
 100         return function(function_index_zeta2, p1, p2);
 101 }
 102
 103 /** Gamma-function. */
 104 DECLARE_FUNCTION_1P(lgamma)
 105 DECLARE_FUNCTION_1P(tgamma)
 106
 107 /** Beta-function. */
 108 DECLARE_FUNCTION_2P(beta)
 109
 110 // overloading at work: we cannot use the macros here
 111 /** Psi-function (aka digamma-function). */
 112 extern const unsigned function_index_psi1;
 113 inline function psi(const ex & p1) {
 114         return function(function_index_psi1, p1);
 115 }
 116 /** Derivatives of Psi-function (aka polygamma-functions). */
 117 extern const unsigned function_index_psi2;
 118 inline function psi(const ex & p1, const ex & p2) {
 119         return function(function_index_psi2, p1, p2);
 120 }
 121
 122 /** Factorial function. */
 123 DECLARE_FUNCTION_1P(factorial)
 124
 125 /** Binomial function. */
 126 DECLARE_FUNCTION_2P(binomial)
 127
 128 /** Order term function (for truncated power series). */
 129 DECLARE_FUNCTION_1P(Order)
 130
 131 /** Inert partial differentiation operator. */
 132 DECLARE_FUNCTION_2P(Derivative)
 133
 134 ex lsolve(const ex &eqns, const ex &symbols);
 135
 136 ex ncpower(const ex &basis, unsigned exponent);
 137
 138 inline bool is_order_function(const ex & e)
 139 {
 140         return is_ex_the_function(e, Order);
 141 }
 142
 143 } // namespace GiNaC
 144
 145 #endif // ndef __GINAC_INIFCNS_H__