Added a document about the coding conventions used in GiNaC. Corrections,
[ginac.git] / ginac / inifcns.h
1 /** @file inifcns.h
2  *
3  *  Interface to GiNaC's initially known functions. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2003 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 /** Multiple zeta value including Riemann's zeta-function. */
93 class zeta1_SERIAL { public: static unsigned serial; };
94 template<typename T1>
95 inline function zeta(const T1 & p1) {
96         return function(zeta1_SERIAL::serial, ex(p1));
97 }
98 /** Derivatives of Riemann's Zeta-function. */
99 class zeta2_SERIAL { public: static unsigned serial; };
100 template<typename T1, typename T2>
101 inline function zeta(const T1 & p1, const T2 & p2) {
102         return function(zeta2_SERIAL::serial, ex(p1), ex(p2));
103 }
104 class zeta_SERIAL;
105 template<> inline bool is_the_function<class zeta_SERIAL>(const ex & x)
106 {
107         return is_the_function<zeta1_SERIAL>(x) || is_the_function<zeta2_SERIAL>(x);
108 }
109
110 /** Gamma-function. */
111 DECLARE_FUNCTION_1P(lgamma)
112 DECLARE_FUNCTION_1P(tgamma)
113
114 /** Beta-function. */
115 DECLARE_FUNCTION_2P(beta)
116
117 // overloading at work: we cannot use the macros here
118 /** Psi-function (aka digamma-function). */
119 class psi1_SERIAL { public: static unsigned serial; };
120 template<typename T1>
121 inline function psi(const T1 & p1) {
122         return function(psi1_SERIAL::serial, ex(p1));
123 }
124 /** Derivatives of Psi-function (aka polygamma-functions). */
125 class psi2_SERIAL { public: static unsigned serial; };
126 template<typename T1, typename T2>
127 inline function psi(const T1 & p1, const T2 & p2) {
128         return function(psi2_SERIAL::serial, ex(p1), ex(p2));
129 }
130 class psi_SERIAL;
131 template<> inline bool is_the_function<class psi_SERIAL>(const ex & x)
132 {
133         return is_the_function<psi1_SERIAL>(x) || is_the_function<psi2_SERIAL>(x);
134 }
135         
136 /** Factorial function. */
137 DECLARE_FUNCTION_1P(factorial)
138
139 /** Binomial function. */
140 DECLARE_FUNCTION_2P(binomial)
141
142 /** Order term function (for truncated power series). */
143 DECLARE_FUNCTION_1P(Order)
144
145 /** Polylogarithm and multiple polylogarithm. */
146 DECLARE_FUNCTION_2P(Li)
147
148 /** Nielsen's generalized polylogarithm. */
149 DECLARE_FUNCTION_3P(S)
150
151 /** Harmonic polylogarithm. */
152 DECLARE_FUNCTION_2P(H)
153
154 /** Multiple zeta value. */
155 DECLARE_FUNCTION_1P(mZeta)
156  
157 ex lsolve(const ex &eqns, const ex &symbols, unsigned options = solve_algo::automatic);
158
159 /** Check whether a function is the Order (O(n)) function. */
160 inline bool is_order_function(const ex & e)
161 {
162         return is_ex_the_function(e, Order);
163 }
164
165 } // namespace GiNaC
166
167 #endif // ndef __GINAC_INIFCNS_H__