]> www.ginac.de Git - ginac.git/blobdiff - ginac/function.pl
added function::get_name() to return a function's print name
[ginac.git] / ginac / function.pl
index b583a76b639c896a0e65624b2e5b08c34013687d..b6c15814bb97e091f00044a0399a2ddd6ea69283 100755 (executable)
@@ -34,7 +34,7 @@ sub generate {
        return generate_from_to($template,$seq_template1,$seq_template2,1,$maxargs);
 }
 
-$declare_function_macro_namespace = <<'END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO_NAMESPACE';
+$declare_function_macro = <<'END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO';
 #define DECLARE_FUNCTION_1P(NAME) \
 extern const unsigned function_index_##NAME; \
 inline GiNaC::function NAME(const GiNaC::ex & p1) { \
@@ -46,41 +46,17 @@ inline GiNaC::function NAME(const GiNaC::ex & p1, const GiNaC::ex & p2) { \
        return GiNaC::function(function_index_##NAME, p1, p2); \
 }
 
-END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO_NAMESPACE
+END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO
 
-$declare_function_macro_namespace .= generate_from_to(
-       <<'END_OF_DECLARE_FUNCTION_MACRO_NAMESPACE','const GiNaC::ex & p${N}','p${N}',3,$maxargs);
+$declare_function_macro .= generate_from_to(
+       <<'END_OF_DECLARE_FUNCTION_MACRO','const GiNaC::ex & p${N}','p${N}',3,$maxargs);
 #define DECLARE_FUNCTION_${N}P(NAME) \\
 extern const unsigned function_index_##NAME; \\
 inline GiNaC::function NAME(${SEQ1}) { \\
        return GiNaC::function(function_index_##NAME, ${SEQ2}); \\
 }
 
-END_OF_DECLARE_FUNCTION_MACRO_NAMESPACE
-
-$declare_function_macro_no_namespace = <<'END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO_NO_NAMESPACE';
-#define DECLARE_FUNCTION_1P(NAME) \
-extern const unsigned function_index_##NAME; \
-inline function NAME(const ex & p1) { \
-       return function(function_index_##NAME, p1); \
-}
-#define DECLARE_FUNCTION_2P(NAME) \
-extern const unsigned function_index_##NAME; \
-inline function NAME(const ex & p1, const ex & p2) { \
-       return function(function_index_##NAME, p1, p2); \
-}
-
-END_OF_DECLARE_FUNCTION_1_AND_2P_MACRO_NO_NAMESPACE
-
-$declare_function_macro_no_namespace .= generate_from_to(
-       <<'END_OF_DECLARE_FUNCTION_MACRO_NO_NAMESPACE','const ex & p${N}','p${N}',3,$maxargs);
-#define DECLARE_FUNCTION_${N}P(NAME) \\
-extern const unsigned function_index_##NAME; \\
-inline function NAME(${SEQ1}) { \\
-       return function(function_index_##NAME, ${SEQ2}); \\
-}
-
-END_OF_DECLARE_FUNCTION_MACRO_NO_NAMESPACE
+END_OF_DECLARE_FUNCTION_MACRO
 
 $typedef_eval_funcp=generate(
 'typedef ex (* eval_funcp_${N})(${SEQ1});'."\n",
@@ -115,7 +91,7 @@ $constructors_implementation=generate(
 function::function(unsigned ser, ${SEQ1})
        : exprseq(${SEQ2}), serial(ser)
 {
-       debugmsg(\"function constructor from unsigned,${N}*ex\",LOGLEVEL_CONSTRUCT);
+       debugmsg(\"function ctor from unsigned,${N}*ex\",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 END_OF_CONSTRUCTORS_IMPLEMENTATION
@@ -200,7 +176,7 @@ $interface=<<END_OF_INTERFACE;
  *  Please do not modify it directly, edit the perl script instead!
  *  function.pl options: \$maxargs=${maxargs}
  *
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2001 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
@@ -228,22 +204,10 @@ $interface=<<END_OF_INTERFACE;
 
 #include "exprseq.h"
 
-#ifndef NO_NAMESPACE_GINAC
-
-// the following lines have been generated for max. ${maxargs} parameters
-$declare_function_macro_namespace
-// end of generated lines
-
-#else // ndef NO_NAMESPACE_GINAC
-
 // the following lines have been generated for max. ${maxargs} parameters
-$declare_function_macro_no_namespace
+$declare_function_macro
 // end of generated lines
 
-#endif // ndef NO_NAMESPACE_GINAC
-
-#ifndef NO_NAMESPACE_GINAC
-
 #define REGISTER_FUNCTION(NAME,OPT) \\
 const unsigned function_index_##NAME= \\
        GiNaC::function::register_new(GiNaC::function_options(#NAME).OPT);
@@ -256,22 +220,6 @@ const unsigned function_index_##NAME= \\
                                      derivative_func(D). \\
                                      series_func(S));
 
-#else // ndef NO_NAMESPACE_GINAC
-
-#define REGISTER_FUNCTION(NAME,OPT) \\
-const unsigned function_index_##NAME= \\
-       function::register_new(function_options(#NAME).OPT);
-
-#define REGISTER_FUNCTION_OLD(NAME,E,EF,D,S) \\
-const unsigned function_index_##NAME= \\
-       function::register_new(function_options(#NAME). \\
-                              eval_func(E). \\
-                              evalf_func(EF). \\
-                              derivative_func(D). \\
-                              series_func(S));
-
-#endif // ndef NO_NAMESPACE_GINAC
-
 #define BEGIN_TYPECHECK \\
 bool automatic_typecheck=true;
 
@@ -280,31 +228,18 @@ if (!is_ex_exactly_of_type(VAR,TYPE)) { \\
        automatic_typecheck=false; \\
 } else
 
-#ifndef NO_NAMESPACE_GINAC
-
 #define TYPECHECK_INTEGER(VAR) \\
 if (!(VAR).info(GiNaC::info_flags::integer)) { \\
        automatic_typecheck=false; \\
 } else
 
-#else // ndef NO_NAMESPACE_GINAC
-
-#define TYPECHECK_INTEGER(VAR) \\
-if (!(VAR).info(info_flags::integer)) { \\
-       automatic_typecheck=false; \\
-} else
-
-#endif // ndef NO_NAMESPACE_GINAC
-
 #define END_TYPECHECK(RV) \\
 {} \\
 if (!automatic_typecheck) { \\
        return RV.hold(); \\
 }
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 class function;
 
@@ -386,17 +321,7 @@ class function : public exprseq
 
 // member functions
 
-       // default constructor, destructor, copy constructor assignment operator and helpers
-public:
-       function();
-       ~function();
-       function(const function & other);
-       const function & operator=(const function & other);
-protected:
-       void copy(const function & other);
-       void destroy(bool call_parent);
-
-       // other constructors
+       // other ctors
 public:
        function(unsigned ser);
        // the following lines have been generated for max. ${maxargs} parameters
@@ -408,20 +333,19 @@ $constructors_interface
 
        // functions overriding virtual functions from bases classes
 public:
-       basic * duplicate() const;
-       void printraw(std::ostream & os) const; 
-       void print(std::ostream & os, unsigned upper_precedence=0) const;
-       void printtree(std::ostream & os, unsigned indent) const;
-       void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
+       void print(const print_context & c, unsigned level = 0) const;
+       int degree(const ex & s) const;
+       int ldegree(const ex & s) const;
+       ex coeff(const ex & s, int n = 1) const;
        ex expand(unsigned options=0) const;
        ex eval(int level=0) const;
        ex evalf(int level=0) const;
+       unsigned calchash(void) const;
        ex series(const relational & r, int order, unsigned options = 0) const;
        ex thisexprseq(const exvector & v) const;
        ex thisexprseq(exvector * vp) const;
 protected:
        ex derivative(const symbol & s) const;
-       int compare_same_type(const basic & other) const;
        bool is_equal_same_type(const basic & other) const;
        unsigned return_type(void) const;
        unsigned return_type_tinfo(void) const;
@@ -439,6 +363,7 @@ public:
        static unsigned register_new(function_options const & opt);
        static unsigned find_function(const std::string &name, unsigned nparams);
        unsigned getserial(void) const {return serial;}
+       std::string get_name(void) const;
        
 // member variables
 
@@ -452,26 +377,10 @@ inline const function &ex_to_function(const ex &e)
        return static_cast<const function &>(*e.bp);
 }
 
-#ifndef NO_NAMESPACE_GINAC
-
 #define is_ex_the_function(OBJ, FUNCNAME) \\
        (is_ex_exactly_of_type(OBJ, function) && static_cast<GiNaC::function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
 
-#else // ndef NO_NAMESPACE_GINAC
-
-#define is_ex_the_function(OBJ, FUNCNAME) \\
-       (is_ex_exactly_of_type(OBJ, function) && static_cast<function *>(OBJ.bp)->getserial() == function_index_##FUNCNAME)
-
-#endif // ndef NO_NAMESPACE_GINAC
-
-// global constants
-
-extern const function some_function;
-extern const std::type_info & typeid_function;
-
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_FUNCTION_H__
 
@@ -487,7 +396,7 @@ $implementation=<<END_OF_IMPLEMENTATION;
  *  Please do not modify it directly, edit the perl script instead!
  *  function.pl options: \$maxargs=${maxargs}
  *
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2001 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
@@ -511,15 +420,14 @@ $implementation=<<END_OF_IMPLEMENTATION;
 #include "function.h"
 #include "ex.h"
 #include "lst.h"
+#include "print.h"
 #include "archive.h"
 #include "inifcns.h"
 #include "utils.h"
 #include "debugmsg.h"
 #include "remember.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 //////////
 // helper class function_options
@@ -619,39 +527,17 @@ void function_options::test_and_set_nparams(unsigned n)
 GINAC_IMPLEMENT_REGISTERED_CLASS(function, exprseq)
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default ctor, dtor, copy ctor assignment operator and helpers
 //////////
 
 // public
 
 function::function() : serial(0)
 {
-       debugmsg("function default constructor",LOGLEVEL_CONSTRUCT);
+       debugmsg("function default ctor",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
-function::~function()
-{
-       debugmsg("function destructor",LOGLEVEL_DESTRUCT);
-       destroy(false);
-}
-
-function::function(const function & other)
-{
-       debugmsg("function copy constructor",LOGLEVEL_CONSTRUCT);
-       copy(other);
-}
-
-const function & function::operator=(const function & other)
-{
-       debugmsg("function operator=",LOGLEVEL_ASSIGNMENT);
-       if (this != &other) {
-               destroy(true);
-               copy(other);
-       }
-       return *this;
-}
-
 // protected
 
 void function::copy(const function & other)
@@ -666,14 +552,14 @@ void function::destroy(bool call_parent)
 }
 
 //////////
-// other constructors
+// other ctors
 //////////
 
 // public
 
 function::function(unsigned ser) : serial(ser)
 {
-       debugmsg("function constructor from unsigned",LOGLEVEL_CONSTRUCT);
+       debugmsg("function ctor from unsigned",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
@@ -683,21 +569,21 @@ $constructors_implementation
 
 function::function(unsigned ser, const exprseq & es) : exprseq(es), serial(ser)
 {
-       debugmsg("function constructor from unsigned,exprseq",LOGLEVEL_CONSTRUCT);
+       debugmsg("function ctor from unsigned,exprseq",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
 function::function(unsigned ser, const exvector & v, bool discardable) 
   : exprseq(v,discardable), serial(ser)
 {
-       debugmsg("function constructor from string,exvector,bool",LOGLEVEL_CONSTRUCT);
+       debugmsg("function ctor from string,exvector,bool",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
 function::function(unsigned ser, exvector * vp) 
   : exprseq(vp), serial(ser)
 {
-       debugmsg("function constructor from unsigned,exvector *",LOGLEVEL_CONSTRUCT);
+       debugmsg("function ctor from unsigned,exvector *",LOGLEVEL_CONSTRUCT);
        tinfo_key = TINFO_function;
 }
 
@@ -708,7 +594,7 @@ function::function(unsigned ser, exvector * vp)
 /** Construct object from archive_node. */
 function::function(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("function constructor from archive_node", LOGLEVEL_CONSTRUCT);
+       debugmsg("function ctor from archive_node", LOGLEVEL_CONSTRUCT);
 
        // Find serial number by function name
        std::string s;
@@ -747,82 +633,69 @@ void function::archive(archive_node &n) const
 
 // public
 
-basic * function::duplicate() const
-{
-       debugmsg("function duplicate",LOGLEVEL_DUPLICATE);
-       return new function(*this);
-}
-
-void function::printraw(std::ostream & os) const
+void function::print(const print_context & c, unsigned level) const
 {
-       debugmsg("function printraw",LOGLEVEL_PRINT);
+       debugmsg("function print", LOGLEVEL_PRINT);
 
        GINAC_ASSERT(serial<registered_functions().size());
 
-       os << "function(name=" << registered_functions()[serial].name;
-       for (exvector::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
-               os << ",";
-               (*it).bp->print(os);
+       if (is_of_type(c, print_tree)) {
+
+               c.s << std::string(level, ' ') << class_name() << " "
+                   << registered_functions()[serial].name
+                   << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+                   << ", nops=" << nops()
+                   << std::endl;
+               unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
+               for (unsigned i=0; i<nops(); ++i)
+                       seq[i].print(c, level + delta_indent);
+               c.s << std::string(level + delta_indent, ' ') << "=====" << std::endl;
+
+       } else if (is_of_type(c, print_csrc)) {
+
+               // Print function name in lowercase
+               std::string lname = registered_functions()[serial].name;
+               for (unsigned i=0; i<lname.size(); i++)
+                       lname[i] = tolower(lname[i]);
+               c.s << lname << "(";
+
+               // Print arguments, separated by commas
+               exvector::const_iterator it = seq.begin(), itend = seq.end();
+               while (it != itend) {
+                       it->print(c);
+                       it++;
+                       if (it != itend)
+                               c.s << ",";
+               }
+               c.s << ")";
+
+       } else {
+               c.s << registered_functions()[serial].name;
+               printseq(c, '(', ',', ')', exprseq::precedence, function::precedence);
        }
-       os << ")";
 }
 
-void function::print(std::ostream & os, unsigned upper_precedence) const
+ex function::expand(unsigned options) const
 {
-       debugmsg("function print",LOGLEVEL_PRINT);
-
-       GINAC_ASSERT(serial<registered_functions().size());
-
-       os << registered_functions()[serial].name;
-       printseq(os,'(',',',')',exprseq::precedence,function::precedence);
+       return this->setflag(status_flags::expanded);
 }
 
-void function::printtree(std::ostream & os, unsigned indent) const
+int function::degree(const ex & s) const
 {
-       debugmsg("function printtree",LOGLEVEL_PRINT);
-
-       GINAC_ASSERT(serial<registered_functions().size());
-
-       os << std::string(indent,' ') << "function "
-          << registered_functions()[serial].name
-          << ", hash=" << hashvalue 
-          << " (0x" << std::hex << hashvalue << std::dec << ")"
-          << ", flags=" << flags
-          << ", nops=" << nops() << std::endl;
-       for (unsigned i=0; i<nops(); ++i) {
-               seq[i].printtree(os,indent+delta_indent);
-       }
-       os << std::string(indent+delta_indent,' ') << "=====" << std::endl;
+       return is_equal(*s.bp) ? 1 : 0;
 }
 
-void function::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
+int function::ldegree(const ex & s) const
 {
-       debugmsg("function print csrc",LOGLEVEL_PRINT);
-
-       GINAC_ASSERT(serial<registered_functions().size());
-
-       // Print function name in lowercase
-       std::string lname;
-       lname=registered_functions()[serial].name;
-       for (unsigned i=0; i<lname.size(); i++)
-               lname[i] = tolower(lname[i]);
-       os << lname << "(";
-
-       // Print arguments, separated by commas
-       exvector::const_iterator it = seq.begin();
-       exvector::const_iterator itend = seq.end();
-       while (it != itend) {
-               it->bp->printcsrc(os, type, 0);
-               it++;
-               if (it != itend)
-                       os << ",";
-       }
-       os << ")";
+       return is_equal(*s.bp) ? 1 : 0;
 }
 
-ex function::expand(unsigned options) const
+ex function::coeff(const ex & s, int n) const
 {
-       return this->setflag(status_flags::expanded);
+       if (is_equal(*s.bp))
+               return n==1 ? _ex1() : _ex0();
+       else
+               return n==0 ? ex(*this) : _ex0();
 }
 
 ex function::eval(int level) const
@@ -874,6 +747,21 @@ ${evalf_switch_statement}
        throw(std::logic_error("function::evalf(): invalid nparams"));
 }
 
+unsigned function::calchash(void) const
+{
+       unsigned v = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial);
+       for (unsigned i=0; i<nops(); i++) {
+               v = rotate_left_31(v);
+               v ^= this->op(i).gethash();
+       }
+       v &= 0x7FFFFFFFU;
+       if (flags & status_flags::evaluated) {
+               setflag(status_flags::hash_calculated);
+               hashvalue = v;
+       }
+       return v;
+}
+
 ex function::thisexprseq(const exvector & v) const
 {
        return function(serial,v);
@@ -1070,22 +958,14 @@ unsigned function::find_function(const std::string &name, unsigned nparams)
        throw (std::runtime_error("no function '" + name + "' with " + ToString(nparams) + " parameters defined"));
 }
 
-//////////
-// static member variables
-//////////
-
-// none
-
-//////////
-// global constants
-//////////
-
-const function some_function;
-const std::type_info & typeid_function=typeid(some_function);
+/** Return the print name of the function. */
+std::string function::get_name(void) const
+{
+       GINAC_ASSERT(serial<registered_functions().size());
+       return registered_functions()[serial].name;
+}
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
 
 END_OF_IMPLEMENTATION