Add step function to GiNaCs built-in functions.

[ginac.git] / ginac / inifcns.h

diff --git a/ginac/inifcns.h b/ginac/inifcns.h
index e68bd175569b0c6f7b7ae1d40ec725972c0222a0..0e13a040f1b42d85644e4525fd227ca11eda9c4c 100644 (file)
--- a/ginac/inifcns.h
+++ b/ginac/inifcns.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's initially known functions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -17,20 +17,27 @@
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
 #ifndef __GINAC_INIFCNS_H__
 #define __GINAC_INIFCNS_H__
 
+#include "numeric.h"
 #include "function.h"
 #include "ex.h"
 
 namespace GiNaC {
 
+/** Complex conjugate. */
+DECLARE_FUNCTION_1P(conjugate_function)
+       
 /** Absolute value. */
 DECLARE_FUNCTION_1P(abs)
        
+/** Step function. */
+DECLARE_FUNCTION_1P(step)
+
 /** Complex sign. */
 DECLARE_FUNCTION_1P(csgn)
 
@@ -95,21 +102,40 @@ DECLARE_FUNCTION_2P(zetaderiv)
 /** Multiple zeta value including Riemann's zeta-function. */
 class zeta1_SERIAL { public: static unsigned serial; };
 template<typename T1>
-inline function zeta(const T1 & p1) {
+inline function zeta(const T1& p1) {
        return function(zeta1_SERIAL::serial, ex(p1));
 }
 /** Alternating Euler sum or colored MZV. */
 class zeta2_SERIAL { public: static unsigned serial; };
 template<typename T1, typename T2>
-inline function zeta(const T1 & p1, const T2 & p2) {
+inline function zeta(const T1& p1, const T2& p2) {
        return function(zeta2_SERIAL::serial, ex(p1), ex(p2));
 }
 class zeta_SERIAL;
-template<> inline bool is_the_function<class zeta_SERIAL>(const ex & x)
+template<> inline bool is_the_function<zeta_SERIAL>(const ex& x)
 {
        return is_the_function<zeta1_SERIAL>(x) || is_the_function<zeta2_SERIAL>(x);
 }
 
+// overloading at work: we cannot use the macros here
+/** Generalized multiple polylogarithm. */
+class G2_SERIAL { public: static unsigned serial; };
+template<typename T1, typename T2>
+inline function G(const T1& x, const T2& y) {
+       return function(G2_SERIAL::serial, ex(x), ex(y));
+}
+/** Generalized multiple polylogarithm with explicit imaginary parts. */
+class G3_SERIAL { public: static unsigned serial; };
+template<typename T1, typename T2, typename T3>
+inline function G(const T1& x, const T2& s, const T3& y) {
+       return function(G3_SERIAL::serial, ex(x), ex(s), ex(y));
+}
+class G_SERIAL;
+template<> inline bool is_the_function<G_SERIAL>(const ex& x)
+{
+       return is_the_function<G2_SERIAL>(x) || is_the_function<G3_SERIAL>(x);
+}
+
 /** Polylogarithm and multiple polylogarithm. */
 DECLARE_FUNCTION_2P(Li)
 
@@ -140,7 +166,7 @@ inline function psi(const T1 & p1, const T2 & p2) {
        return function(psi2_SERIAL::serial, ex(p1), ex(p2));
 }
 class psi_SERIAL;
-template<> inline bool is_the_function<class psi_SERIAL>(const ex & x)
+template<> inline bool is_the_function<psi_SERIAL>(const ex & x)
 {
        return is_the_function<psi1_SERIAL>(x) || is_the_function<psi2_SERIAL>(x);
 }
@@ -156,12 +182,28 @@ DECLARE_FUNCTION_1P(Order)
 
 ex lsolve(const ex &eqns, const ex &symbols, unsigned options = solve_algo::automatic);
 
+/** Find a real root of real-valued function f(x) numerically within a given
+ *  interval. The function must change sign across interval. Uses Newton-
+ *  Raphson method combined with bisection in order to guarantee convergence.
+ *
+ *  @param f  Function f(x)
+ *  @param x  Symbol f(x)
+ *  @param x1  lower interval limit
+ *  @param x2  upper interval limit
+ *  @exception runtime_error (if interval is invalid). */
+const numeric fsolve(const ex& f, const symbol& x, const numeric& x1, const numeric& x2);
+
 /** Check whether a function is the Order (O(n)) function. */
 inline bool is_order_function(const ex & e)
 {
        return is_ex_the_function(e, Order);
 }
 
+/** Converts a given list containing parameters for H in Remiddi/Vermaseren notation into
+ *  the corresponding GiNaC functions.
+ */
+ex convert_H_to_Li(const ex& parameterlst, const ex& arg);
+
 } // namespace GiNaC
 
 #endif // ndef __GINAC_INIFCNS_H__