Add support for Texinfo-5.0.
[ginac.git] / ginac / constant.cpp
index 688d2288b45769087fef264178f33b213b3ae804..b2308609d774a7cfa769054de76e27610d36fa4b 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's constant types and some special constants. */
 
 /*
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2011 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
  *
  *  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
  */
 
-#include <string>
-#include <stdexcept>
-
 #include "constant.h"
 #include "numeric.h"
 #include "ex.h"
 #include "archive.h"
-#include "debugmsg.h"
+#include "utils.h"
+#include "inifcns.h"
+
+#include <iostream>
+#include <stdexcept>
+#include <string>
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
-GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
+GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(constant, basic,
+  print_func<print_context>(&constant::do_print).
+  print_func<print_latex>(&constant::do_print_latex).
+  print_func<print_tree>(&constant::do_print_tree).
+  print_func<print_python_repr>(&constant::do_print_python_repr))
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default constructor
 //////////
 
 // public
 
-constant::constant() :
-       basic(TINFO_constant), name(""), ef(0),
-       number(0), serial(next_serial++)
-{
-       debugmsg("constant default constructor",LOGLEVEL_CONSTRUCT);
-}
-
-constant::~constant()
-{
-       debugmsg("constant destructor",LOGLEVEL_DESTRUCT);
-       destroy(0);
-}
-
-constant::constant(const constant & other)
+constant::constant() : ef(0), serial(next_serial++), domain(domain::complex)
 {
-       debugmsg("constant copy constructor",LOGLEVEL_CONSTRUCT);
-       copy(other);
-}
-
-// protected
-
-void constant::copy(const constant & other)
-{
-       basic::copy(other);
-       name=other.name;
-       serial=other.serial;
-       ef=other.ef;
-       if (other.number != 0) {
-               number = new numeric(*other.number);
-       } else {
-               number = 0;
-       }
-       // fct_assigned=other.fct_assigned;
-}
-
-void constant::destroy(bool call_parent)
-{
-       delete number;
-       if (call_parent)
-               basic::destroy(call_parent);
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
 //////////
@@ -89,51 +56,49 @@ void constant::destroy(bool call_parent)
 
 // public
 
-constant::constant(const std::string & initname, evalffunctype efun) :
-       basic(TINFO_constant), name(initname), ef(efun),
-       // number(0), fct_assigned(true), serial(next_serial++)
-       number(0), serial(next_serial++)
+constant::constant(const std::string & initname, evalffunctype efun, const std::string & texname, unsigned dm)
+  : name(initname), ef(efun), serial(next_serial++), domain(dm)
 {
-       debugmsg("constant constructor from string, function",LOGLEVEL_CONSTRUCT);
+       if (texname.empty())
+               TeX_name = "\\mathrm{" + name + "}";
+       else
+               TeX_name = texname;
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
-constant::constant(const std::string & initname, const numeric & initnumber) :
-       basic(TINFO_constant), name(initname), ef(0),
-       number(new numeric(initnumber)), /* fct_assigned(false),*/ serial(next_serial++)
+constant::constant(const std::string & initname, const numeric & initnumber, const std::string & texname, unsigned dm)
+  : name(initname), ef(0), number(initnumber), serial(next_serial++), domain(dm)
 {
-       debugmsg("constant constructor from string, numeric",LOGLEVEL_CONSTRUCT);
+       if (texname.empty())
+               TeX_name = "\\mathrm{" + name + "}";
+       else
+               TeX_name = texname;
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
 //////////
 // archiving
 //////////
 
-/** Construct object from archive_node. */
-constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
-{
-       debugmsg("constant constructor from archive_node", LOGLEVEL_CONSTRUCT);
-}
-
-/** Unarchive the object. */
-ex constant::unarchive(const archive_node &n, const lst &sym_lst)
+void constant::read_archive(const archive_node &n, lst &sym_lst)
 {
        // Find constant by name (!! this is bad: 'twould be better if there
        // was a list of all global constants that we could search)
        std::string s;
        if (n.find_string("name", s)) {
                if (s == Pi.name)
-                       return Pi;
+                       *this = Pi;
                else if (s == Catalan.name)
-                       return Catalan;
+                       *this = Catalan;
                else if (s == Euler.name)
-                       return Euler;
+                       *this = Euler;
                else
                        throw (std::runtime_error("unknown constant '" + s + "' in archive"));
        } else
                throw (std::runtime_error("unnamed constant in archive"));
 }
+GINAC_BIND_UNARCHIVER(constant);
 
-/** Archive the object. */
 void constant::archive(archive_node &n) const
 {
        inherited::archive(n);
@@ -141,80 +106,121 @@ void constant::archive(archive_node &n) const
 }
 
 //////////
-// functions overriding virtual functions from bases classes
+// functions overriding virtual functions from base classes
 //////////
 
 // public
 
-basic * constant::duplicate() const
+void constant::do_print(const print_context & c, unsigned level) const
 {
-       debugmsg("constant duplicate",LOGLEVEL_DUPLICATE);
-       return new constant(*this);
+       c.s << name;
 }
 
-void constant::print(std::ostream & os, unsigned upper_precedence) const
+void constant::do_print_tree(const print_tree & c, unsigned level) const
 {
-       debugmsg("constant print",LOGLEVEL_PRINT);
-       os << name;
+       c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
+           << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+           << std::endl;
 }
 
-void constant::printraw(std::ostream & os) const
+void constant::do_print_latex(const print_latex & c, unsigned level) const
 {
-       debugmsg("constant printraw",LOGLEVEL_PRINT);
-       os << "constant(" << name << ")";
+       c.s << TeX_name;
 }
 
-void constant::printtree(std::ostream & os, unsigned indent) const
+void constant::do_print_python_repr(const print_python_repr & c, unsigned level) const
 {
-       debugmsg("constant printtree",LOGLEVEL_PRINT);
-       os << std::string(indent,' ') << name
-          << ", type=" << class_name()
-          << ", hash=" << hashvalue
-          << " (0x" << std::hex << hashvalue << std::dec << ")"
-          << ", flags=" << flags << std::endl;
+       c.s << class_name() << "('" << name << "'";
+       if (TeX_name != "\\mathrm{" + name + "}")
+               c.s << ",TeX_name='" << TeX_name << "'";
+       c.s << ')';
 }
 
-void constant::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
+bool constant::info(unsigned inf) const
 {
-       debugmsg("constant print csrc",LOGLEVEL_PRINT);
-       os << name;
+       if (inf == info_flags::polynomial)
+               return true;
+       if (inf == info_flags::real)
+               return domain==domain::real || domain==domain::positive ;
+       if (inf==info_flags::positive || inf==info_flags::nonnegative)
+               return domain == domain::positive;
+       else
+               return inherited::info(inf);
 }
 
 ex constant::evalf(int level) const
 {
        if (ef!=0) {
                return ef();
-       } else if (number != 0) {
-               return *number;
+       } else {
+               return number.evalf();
        }
        return *this;
 }
 
+bool constant::is_polynomial(const ex & var) const
+{
+       return true;
+}
+
+ex constant::conjugate() const
+{
+       if ( domain==domain::real || domain==domain::positive )
+               return *this;
+       return conjugate_function(*this).hold();
+}
+
+ex constant::real_part() const
+{
+       if ( domain==domain::real || domain==domain::positive )
+               return *this;
+       return real_part_function(*this).hold();
+}
+
+ex constant::imag_part() const
+{
+       if ( domain==domain::real || domain==domain::positive )
+               return 0;
+       return imag_part_function(*this).hold();
+}
+
 // protected
 
-/** Implementation of ex::diff() for a constant. It always returns 0.
+/** Implementation of ex::diff() for a constant always returns 0.
  *
  *  @see ex::diff */
 ex constant::derivative(const symbol & s) const
 {
-       return _ex0();
+       return _ex0;
 }
 
 int constant::compare_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_exactly_of_type(other, constant));
-       // const constant & o=static_cast<constant &>(const_cast<basic &>(other));
-       // return name.compare(o.name);
-       const constant *o = static_cast<const constant *>(&other);
-       if (serial==o->serial) return 0;
-       return serial < o->serial ? -1 : 1;
+       GINAC_ASSERT(is_exactly_a<constant>(other));
+       const constant &o = static_cast<const constant &>(other);
+
+       if (serial == o.serial)
+               return 0;
+       else
+               return serial < o.serial ? -1 : 1;
 }
 
 bool constant::is_equal_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_exactly_of_type(other, constant));
-       const constant *o = static_cast<const constant *>(&other);
-       return serial==o->serial;
+       GINAC_ASSERT(is_exactly_a<constant>(other));
+       const constant &o = static_cast<const constant &>(other);
+
+       return serial == o.serial;
+}
+
+unsigned constant::calchash() const
+{
+       const void* typeid_this = (const void*)typeid(*this).name();
+       hashvalue = golden_ratio_hash((p_int)typeid_this ^ serial);
+
+       setflag(status_flags::hash_calculated);
+
+       return hashvalue;
 }
 
 //////////
@@ -233,23 +239,20 @@ bool constant::is_equal_same_type(const basic & other) const
 // static member variables
 //////////
 
-unsigned constant::next_serial=0;
+unsigned constant::next_serial = 0;
 
 //////////
 // global constants
 //////////
 
-const constant some_constant;
-const type_info & typeid_constant=typeid(some_constant);
-
 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
-const constant Pi("Pi", PiEvalf);
+const constant Pi("Pi", PiEvalf, "\\pi", domain::positive);
+
 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
  *  Diverts straight into CLN for evalf(). */
-const constant Euler("Euler", EulerEvalf);
+const constant Euler("Euler", EulerEvalf, "\\gamma_E", domain::positive);
+
 /** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
-const constant Catalan("Catalan", CatalanEvalf);
+const constant Catalan("Catalan", CatalanEvalf, "G", domain::positive);
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC