Added a document about the coding conventions used in GiNaC. Corrections,

[ginac.git] / ginac / inifcns.h

diff --git a/ginac/inifcns.h b/ginac/inifcns.h
index fdd33108ac199318eae9e2040089086eb6b58936..3531c8a07dd776a1dd97dbd7831ebf4167c9d2a2 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 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 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
@@ -23,12 +23,19 @@
 #ifndef __GINAC_INIFCNS_H__
 #define __GINAC_INIFCNS_H__
 
-#include <ginac/function.h>
-#include <ginac/ex.h>
+#include "function.h"
+#include "ex.h"
 
-#ifndef NO_GINAC_NAMESPACE
 namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
+
+/** Absolute value. */
+DECLARE_FUNCTION_1P(abs)
+       
+/** Complex sign. */
+DECLARE_FUNCTION_1P(csgn)
+
+/** Eta function: log(a*b) == log(a) + log(b) + eta(a, b). */
+DECLARE_FUNCTION_2P(eta)
 
 /** Sine. */
 DECLARE_FUNCTION_1P(sin)
@@ -81,36 +88,51 @@ DECLARE_FUNCTION_1P(Li2)
 /** Trilogarithm. */
 DECLARE_FUNCTION_1P(Li3)
 
-// overloading at work: we cannot use the macros
-/** Riemann's Zeta-function. */
-extern const unsigned function_index_zeta1;
-inline function zeta(ex const & p1) {
-    return function(function_index_zeta1, p1);
+// overloading at work: we cannot use the macros here
+/** Multiple zeta value including Riemann's zeta-function. */
+class zeta1_SERIAL { public: static unsigned serial; };
+template<typename T1>
+inline function zeta(const T1 & p1) {
+       return function(zeta1_SERIAL::serial, ex(p1));
 }
 /** Derivatives of Riemann's Zeta-function. */
-extern const unsigned function_index_zeta2;
-inline function zeta(ex const & p1, ex const & p2) {
-    return function(function_index_zeta2, p1, p2);
+class zeta2_SERIAL { public: static unsigned serial; };
+template<typename T1, typename T2>
+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)
+{
+       return is_the_function<zeta1_SERIAL>(x) || is_the_function<zeta2_SERIAL>(x);
 }
 
 /** Gamma-function. */
-DECLARE_FUNCTION_1P(gamma)
+DECLARE_FUNCTION_1P(lgamma)
+DECLARE_FUNCTION_1P(tgamma)
 
 /** Beta-function. */
 DECLARE_FUNCTION_2P(beta)
 
-// overloading at work: we cannot use the macros
+// overloading at work: we cannot use the macros here
 /** Psi-function (aka digamma-function). */
-extern const unsigned function_index_psi1;
-inline function psi(ex const & p1) {
-    return function(function_index_psi1, p1);
+class psi1_SERIAL { public: static unsigned serial; };
+template<typename T1>
+inline function psi(const T1 & p1) {
+       return function(psi1_SERIAL::serial, ex(p1));
 }
 /** Derivatives of Psi-function (aka polygamma-functions). */
-extern const unsigned function_index_psi2;
-inline function psi(ex const & p1, ex const & p2) {
-    return function(function_index_psi2, p1, p2);
+class psi2_SERIAL { public: static unsigned serial; };
+template<typename T1, typename T2>
+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)
+{
+       return is_the_function<psi1_SERIAL>(x) || is_the_function<psi2_SERIAL>(x);
+}
+       
 /** Factorial function. */
 DECLARE_FUNCTION_1P(factorial)
 
@@ -120,17 +142,26 @@ DECLARE_FUNCTION_2P(binomial)
 /** Order term function (for truncated power series). */
 DECLARE_FUNCTION_1P(Order)
 
-ex lsolve(ex const &eqns, ex const &symbols);
+/** Polylogarithm and multiple polylogarithm. */
+DECLARE_FUNCTION_2P(Li)
+
+/** Nielsen's generalized polylogarithm. */
+DECLARE_FUNCTION_3P(S)
+
+/** Harmonic polylogarithm. */
+DECLARE_FUNCTION_2P(H)
 
-ex ncpower(ex const &basis, unsigned exponent);
+/** Multiple zeta value. */
+DECLARE_FUNCTION_1P(mZeta)
+ 
+ex lsolve(const ex &eqns, const ex &symbols, unsigned options = solve_algo::automatic);
 
-inline bool is_order_function(ex const & e)
+/** 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);
+       return is_ex_the_function(e, Order);
 }
 
-#ifndef NO_GINAC_NAMESPACE
 } // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
 
 #endif // ndef __GINAC_INIFCNS_H__