]> www.ginac.de Git - ginac.git/blobdiff - ginac/constant.cpp
* Added output-support for Python bindings and LaTeX printing for
[ginac.git] / ginac / constant.cpp
index 6ea13a00ffa0fac69c88f8327c28295cf04829ca..beabc9669369794061c8a29816dd4f86d347b057 100644 (file)
@@ -1,8 +1,9 @@
 /** @file constant.cpp
  *
- *  Implementation of GiNaC's constant types and some special constants.
- *
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  Implementation of GiNaC's constant types and some special constants. */
+
+/*
+ *  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
 
 #include <string>
 #include <stdexcept>
+#include <iostream>
 
 #include "constant.h"
 #include "numeric.h"
 #include "ex.h"
+#include "print.h"
+#include "archive.h"
+#include "utils.h"
+
+namespace GiNaC {
+
+GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default ctor, dtor, copy ctor, assignment operator and helpers
 //////////
 
 // public
 
-constant::~constant()
+constant::constant() : basic(TINFO_constant), ef(0), number(0), serial(next_serial++) {}
+
+// protected
+
+/** For use by copy ctor and assignment operator. */
+void constant::copy(const constant & other)
 {
-    debugmsg("constant destructor",LOGLEVEL_DESTRUCT);
-    destroy(0);
+       inherited::copy(other);
+       name = other.name;
+       TeX_name = other.TeX_name;
+       serial = other.serial;
+       ef = other.ef;
+       if (other.number != 0)
+               number = new numeric(*other.number);
+       else
+               number = 0;
 }
 
-constant::constant(constant const & other)
+void constant::destroy(bool call_parent)
 {
-    debugmsg("constant copy constructor",LOGLEVEL_CONSTRUCT);
-    copy(other);
+       delete number;
+       if (call_parent)
+               inherited::destroy(call_parent);
 }
 
-// protected
+//////////
+// other ctors
+//////////
+
+// public
 
-void constant::copy(constant const & other)
+constant::constant(const std::string & initname, evalffunctype efun, const std::string & texname)
+  : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
 {
-    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;
+       if (texname.empty())
+               TeX_name = "\\mbox{" + name + "}";
+       else
+               TeX_name = texname;
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
-void constant::destroy(bool call_parent)
+constant::constant(const std::string & initname, const numeric & initnumber, const std::string & texname)
+  : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
 {
-    delete number;
-    if (call_parent)
-        basic::destroy(call_parent);
+       if (texname.empty())
+               TeX_name = "\\mbox{" + name + "}";
+       else
+               TeX_name = texname;
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
 //////////
-// other constructors
+// archiving
 //////////
 
-// public
+constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) {}
 
-constant::constant(string const & initname, ex (*efun)()) :
-    basic(TINFO_constant), name(initname), ef(efun),
-    number(0), fct_assigned(true), serial(next_serial++)
+ex constant::unarchive(const archive_node &n, const lst &sym_lst)
 {
-    debugmsg("constant constructor from string, function",LOGLEVEL_CONSTRUCT);
+       // 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;
+               else if (s == Catalan.name)
+                       return Catalan;
+               else if (s == Euler.name)
+                       return Euler;
+               else
+                       throw (std::runtime_error("unknown constant '" + s + "' in archive"));
+       } else
+               throw (std::runtime_error("unnamed constant in archive"));
 }
 
-constant::constant(string const & initname, numeric const & initnumber) :
-    basic(TINFO_constant), name(initname), ef(0),
-    number(new numeric(initnumber)), fct_assigned(false), serial(next_serial++)
+void constant::archive(archive_node &n) const
 {
-    debugmsg("constant constructor from string, numeric",LOGLEVEL_CONSTRUCT);
+       inherited::archive(n);
+       n.add_string("name", name);
 }
 
 //////////
-// functions overriding virtual functions from bases classes
+// functions overriding virtual functions from base classes
 //////////
 
 // public
 
-basic * constant::duplicate() const
+void constant::print(const print_context & c, unsigned level) const
 {
-    debugmsg("constant duplicate",LOGLEVEL_DUPLICATE);
-    return new constant(*this);
+       if (is_a<print_tree>(c)) {
+               c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
+                   << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+                   << std::endl;
+       } else if (is_a<print_latex>(c)) {
+               c.s << TeX_name;
+       } else if (is_a<print_python_repr>(c)) {
+               c.s << class_name() << "('" << name << "'";
+               if (TeX_name != "\\mbox{" + name + "}")
+                       c.s << ",TeX_name='" << TeX_name << "'";
+               c.s << ')';
+       } else
+               c.s << name;
+}
+
+int constant::degree(const ex & s) const
+{
+       return is_equal(ex_to<basic>(s)) ? 1 : 0;
+}
+
+int constant::ldegree(const ex & s) const
+{
+       return is_equal(ex_to<basic>(s)) ? 1 : 0;
+}
+
+ex constant::coeff(const ex & s, int n) const
+{
+       if (is_equal(ex_to<basic>(s)))
+               return n==1 ? _ex1 : _ex0;
+       else
+               return n==0 ? *this : _ex0;
 }
 
 ex constant::evalf(int level) const
 {
-    if (fct_assigned) {
-        return ef();
-    } else if (number != 0) {
-        return *number;
-    }
-    return *this;
+       if (ef!=0) {
+               return ef();
+       } else if (number != 0) {
+               return number->evalf();
+       }
+       return *this;
 }
 
 // protected
 
-int constant::compare_same_type(basic const & other) const
+/** Implementation of ex::diff() for a constant always returns 0.
+ *
+ *  @see ex::diff */
+ex constant::derivative(const symbol & s) const
+{
+       return _ex0;
+}
+
+int constant::compare_same_type(const basic & other) const
 {
-    ASSERT(is_exactly_of_type(other, constant));
-    // constant const & 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(basic const & other) const
+bool constant::is_equal_same_type(const basic & other) const
 {
-    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(void) const
+{
+       hashvalue = golden_ratio_hash(tinfo() ^ serial);
+       // mask out numeric hashes:
+       hashvalue &= 0x7FFFFFFFU;
+       
+       setflag(status_flags::hash_calculated);
+       
+       return hashvalue;
 }
 
 //////////
@@ -144,19 +229,20 @@ bool constant::is_equal_same_type(basic const & other) const
 // static member variables
 //////////
 
-unsigned constant::next_serial=0;
+unsigned constant::next_serial = 0;
 
 //////////
 // global constants
 //////////
 
-const constant some_constant("",0);
-type_info const & typeid_constant=typeid(some_constant);
-
 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
-const constant Pi("Pi", PiEvalf);
-/** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
-const constant EulerGamma("EulerGamma", EulerGammaEvalf);
+const constant Pi("Pi", PiEvalf, "\\pi");
+
 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
  *  Diverts straight into CLN for evalf(). */
-const constant Catalan("Catalan", CatalanEvalf);
+const constant Euler("Euler", EulerEvalf, "\\gamma_E");
+
+/** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
+const constant Catalan("Catalan", CatalanEvalf, "G");
+
+} // namespace GiNaC