]> www.ginac.de Git - ginac.git/blobdiff - ginac/symbol.cpp
Make symbol::name be initialized lazily.
[ginac.git] / ginac / symbol.cpp
index 0bdebc0e88a514416b6032b822b4f6392dd89eed..e7eb9c92317b5d53b55e333b9ec206e4ae4605a3 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's symbolic objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2008 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2010 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
  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#include <string>
-#include <stdexcept>
-
 #include "symbol.h"
 #include "lst.h"
 #include "archive.h"
 #include "tostring.h"
 #include "utils.h"
+#include "hash_seed.h"
 #include "inifcns.h"
 
+#include <map>
+#include <stdexcept>
+#include <string>
+
 namespace GiNaC {
 
 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(symbol, basic,
@@ -44,25 +46,18 @@ GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(symbol, basic,
 
 // symbol
 
-symbol::symbol()
- : inherited(&symbol::tinfo_static), serial(next_serial++), name(autoname_prefix() + ToString(serial)), TeX_name(name), domain(domain::complex), ret_type(return_types::commutative), ret_type_tinfo(make_return_type_t<symbol>())
+symbol::symbol() : serial(next_serial++), name(""), TeX_name("")
 {
        setflag(status_flags::evaluated | status_flags::expanded);
 }
 
 // realsymbol
 
-realsymbol::realsymbol()
-{
-       domain = domain::real;
-}
+realsymbol::realsymbol() : symbol() { }
 
 // possymbol
 
-possymbol::possymbol()
-{
-       domain = domain::positive;
-}
+possymbol::possymbol() : realsymbol() { }
 
 //////////
 // other constructors
@@ -72,120 +67,114 @@ possymbol::possymbol()
 
 // symbol
 
-symbol::symbol(const std::string & initname, unsigned domain)
- : inherited(&symbol::tinfo_static), serial(next_serial++), name(initname), TeX_name(default_TeX_name()), domain(domain), ret_type(return_types::commutative), ret_type_tinfo(make_return_type_t<symbol>())
-{
-       setflag(status_flags::evaluated | status_flags::expanded);
-}
-
-symbol::symbol(const std::string & initname, unsigned rt, const return_type_t& rtt, unsigned domain)
- : inherited(&symbol::tinfo_static), serial(next_serial++), name(initname), TeX_name(default_TeX_name()), domain(domain), ret_type(rt), ret_type_tinfo(rtt)
-{
-       setflag(status_flags::evaluated | status_flags::expanded);
-}
-
-symbol::symbol(const std::string & initname, const std::string & texname, unsigned domain)
- : inherited(&symbol::tinfo_static), serial(next_serial++), name(initname), TeX_name(texname), domain(domain), ret_type(return_types::commutative), ret_type_tinfo(make_return_type_t<symbol>())
+symbol::symbol(const std::string & initname) : serial(next_serial++),
+       name(initname), TeX_name("")
 {
        setflag(status_flags::evaluated | status_flags::expanded);
 }
 
-symbol::symbol(const std::string & initname, const std::string & texname, unsigned rt, const return_type_t& rtt, unsigned domain)
: inherited(&symbol::tinfo_static),  serial(next_serial++), name(initname), TeX_name(texname), domain(domain), ret_type(rt), ret_type_tinfo(rtt)
+symbol::symbol(const std::string & initname, const std::string & texname) :
      serial(next_serial++), name(initname), TeX_name(texname)
 {
        setflag(status_flags::evaluated | status_flags::expanded);
 }
 
 // realsymbol
        
-realsymbol::realsymbol(const std::string & initname, unsigned domain)
- : symbol(initname, domain) { }
+realsymbol::realsymbol(const std::string & initname) : symbol(initname) { }
 
-realsymbol::realsymbol(const std::string & initname, const std::string & texname, unsigned domain)
- : symbol(initname, texname, domain) { }
-
-realsymbol::realsymbol(const std::string & initname, unsigned rt, const return_type_t& rtt, unsigned domain)
- : symbol(initname, rt, rtt, domain) { }
-
-realsymbol::realsymbol(const std::string & initname, const std::string & texname, unsigned rt, const return_type_t& rtt, unsigned domain)
- : symbol(initname, texname, rt, rtt, domain) { }
+realsymbol::realsymbol(const std::string & initname, const std::string & texname)
+       : symbol(initname, texname) { }
 
 // possymbol
        
-possymbol::possymbol(const std::string & initname, unsigned domain)
- : symbol(initname, domain) { }
-
-possymbol::possymbol(const std::string & initname, const std::string & texname, unsigned domain)
- : symbol(initname, texname, domain) { }
+possymbol::possymbol(const std::string & initname) : realsymbol(initname) { }
 
-possymbol::possymbol(const std::string & initname, unsigned rt, const return_type_t& rtt, unsigned domain)
- : symbol(initname, rt, rtt, domain) { }
-
-possymbol::possymbol(const std::string & initname, const std::string & texname, unsigned rt, const return_type_t& rtt, unsigned domain)
- : symbol(initname, texname, rt, rtt, domain) { }
+possymbol::possymbol(const std::string & initname, const std::string & texname) 
+       : realsymbol(initname, texname) { }
 
 //////////
 // archiving
 //////////
 
-/** Construct object from archive_node. */
-symbol::symbol(const archive_node &n, lst &sym_lst)
- : inherited(n, sym_lst), serial(next_serial++)
+/** Read object from archive_node. */
+void symbol::read_archive(const archive_node &n, lst &sym_lst)
 {
-       if (!n.find_string("name", name))
-               name = autoname_prefix() + ToString(serial);
-       if (!n.find_string("TeXname", TeX_name))
-               TeX_name = default_TeX_name();
-       if (!n.find_unsigned("domain", domain))
-               domain = domain::complex;
-       if (!n.find_unsigned("return_type", ret_type))
-               ret_type = return_types::commutative;
-       setflag(status_flags::evaluated | status_flags::expanded);
-}
-
-/** Unarchive the object. */
-ex symbol::unarchive(const archive_node &n, lst &sym_lst)
-{
-       ex s = (new symbol(n, sym_lst))->setflag(status_flags::dynallocated);
+       inherited::read_archive(n, sym_lst);
+       serial = next_serial++;
+       std::string tmp_name;
+       n.find_string("name", tmp_name);
 
        // If symbol is in sym_lst, return the existing symbol
        for (lst::const_iterator it = sym_lst.begin(); it != sym_lst.end(); ++it) {
-               if (is_a<symbol>(*it) && (ex_to<symbol>(*it).name == ex_to<symbol>(s).name))
-                       return *it;
+               if (is_a<symbol>(*it) && (ex_to<symbol>(*it).name == tmp_name)) {
+                       *this = ex_to<symbol>(*it);
+                       // XXX: This method is responsible for reading realsymbol
+                       // and possymbol objects too. But
+                       // basic::operator=(const basic& other)
+                       // resets status_flags::evaluated if other and *this are
+                       // of different types. Usually this is a good idea, but
+                       // doing this for symbols is wrong (for one, nothing is
+                       // going to set status_flags::evaluated, evaluation will
+                       // loop forever). Therefore we need to restore flags.
+                       setflag(status_flags::evaluated | status_flags::expanded);
+                       return;
+               }
        }
+       name = tmp_name;
+       if (!n.find_string("TeXname", TeX_name))
+               TeX_name = std::string("");
+       setflag(status_flags::evaluated | status_flags::expanded);
 
-       // Otherwise add new symbol to list and return it
-       sym_lst.append(s);
-       return s;
+       setflag(status_flags::dynallocated);
+       sym_lst.append(*this);
 }
 
 /** Archive the object. */
 void symbol::archive(archive_node &n) const
 {
        inherited::archive(n);
-       n.add_string("name", name);
-       if (TeX_name != default_TeX_name())
+       // XXX: we should not archive anonymous symbols.
+       if (!name.empty())
+               n.add_string("name", name);
+       if (!TeX_name.empty())
                n.add_string("TeX_name", TeX_name);
-       if (domain != domain::complex)
-               n.add_unsigned("domain", domain);
-       if (ret_type != return_types::commutative)
-               n.add_unsigned("return_type", ret_type);
 }
 
 //////////
 // functions overriding virtual functions from base classes
 //////////
 
+/** Return default TeX name for symbol. This recognizes some greek letters. */
+static const std::string& get_default_TeX_name(const std::string& name);
+
 // public
 
+std::string symbol::get_name() const
+{
+       if (name.empty()) {
+               std::ostringstream s;
+               s << "symbol" << serial;
+               name = s.str();
+       }
+       return name;
+}
+
+// protected
+
 void symbol::do_print(const print_context & c, unsigned level) const
 {
-       c.s << name;
+       c.s << get_name();
 }
 
 void symbol::do_print_latex(const print_latex & c, unsigned level) const
 {
-       c.s << TeX_name;
+       if (!TeX_name.empty())
+               c.s << TeX_name;
+       else if (!name.empty())
+               c.s << get_default_TeX_name(name);
+       else
+               c.s << "symbol" << serial;
 }
 
 void symbol::do_print_tree(const print_tree & c, unsigned level) const
@@ -193,14 +182,18 @@ void symbol::do_print_tree(const print_tree & c, unsigned level) const
        c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
            << ", serial=" << serial
            << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
-           << ", domain=" << domain
+           << ", domain=" << get_domain()
            << std::endl;
 }
 
 void symbol::do_print_python_repr(const print_python_repr & c, unsigned level) const
 {
-       c.s << class_name() << "('" << name;
-       if (TeX_name != default_TeX_name())
+       c.s << class_name() << "('";
+       if (!name.empty())
+               c.s << name;
+       else
+               c.s << "symbol" << serial;
+       if (!TeX_name.empty())
                c.s << "','" << TeX_name;
        c.s << "')";
 }
@@ -218,10 +211,10 @@ bool symbol::info(unsigned inf) const
                case info_flags::expanded:
                        return true;
                case info_flags::real:
-                       return domain == domain::real || domain == domain::positive;
+                       return get_domain() == domain::real || get_domain() == domain::positive;
                case info_flags::positive:
                case info_flags::nonnegative:
-                       return domain == domain::positive;
+                       return get_domain() == domain::positive;
                case info_flags::has_indices:
                        return false;
        }
@@ -230,24 +223,16 @@ bool symbol::info(unsigned inf) const
 
 ex symbol::conjugate() const
 {
-       if (this->domain == domain::complex) {
-               return conjugate_function(*this).hold();
-       } else {
-               return *this;
-       }
+       return conjugate_function(*this).hold();
 }
 
 ex symbol::real_part() const
 {
-       if (domain==domain::real || domain==domain::positive)
-               return *this;
        return real_part_function(*this).hold();
 }
 
 ex symbol::imag_part() const
 {
-       if (domain==domain::real || domain==domain::positive)
-               return 0;
        return imag_part_function(*this).hold();
 }
 
@@ -287,8 +272,8 @@ bool symbol::is_equal_same_type(const basic & other) const
 
 unsigned symbol::calchash() const
 {
-       const void* this_tinfo = (const void*)typeid(*this).name();
-       hashvalue = golden_ratio_hash((p_int)this_tinfo ^ serial);
+       unsigned seed = make_hash_seed(typeid(*this));
+       hashvalue = golden_ratio_hash(seed ^ serial);
        setflag(status_flags::hash_calculated);
        return hashvalue;
 }
@@ -303,38 +288,66 @@ unsigned symbol::calchash() const
 // non-virtual functions in this class
 //////////
 
-// private
-
-/** Symbols not constructed with a string get one assigned using this
- *  prefix and a number. */
-std::string& symbol::autoname_prefix()
-{
-       static std::string s("symbol");
-       return s;
-}
-
 /** Return default TeX name for symbol. This recognizes some greek letters. */
-std::string symbol::default_TeX_name() const
+static const std::string& get_default_TeX_name(const std::string& name)
 {
-       if (name=="alpha"        || name=="beta"         || name=="gamma"
-        || name=="delta"        || name=="epsilon"      || name=="varepsilon"
-        || name=="zeta"         || name=="eta"          || name=="theta"
-        || name=="vartheta"     || name=="iota"         || name=="kappa"
-        || name=="lambda"       || name=="mu"           || name=="nu"
-        || name=="xi"           || name=="omicron"      || name=="pi"
-        || name=="varpi"        || name=="rho"          || name=="varrho"
-        || name=="sigma"        || name=="varsigma"     || name=="tau"
-        || name=="upsilon"      || name=="phi"          || name=="varphi"
-        || name=="chi"          || name=="psi"          || name=="omega"
-        || name=="Gamma"        || name=="Delta"        || name=="Theta"
-        || name=="Lambda"       || name=="Xi"           || name=="Pi"
-        || name=="Sigma"        || name=="Upsilon"      || name=="Phi"
-        || name=="Psi"          || name=="Omega")
-               return "\\" + name;
+       static std::map<std::string, std::string> standard_names;
+       static bool names_initialized = false;
+       if (!names_initialized) {
+               standard_names["alpha"] = std::string("\\alpha");
+               standard_names["beta"] = std::string("\\beta");;
+               standard_names["gamma"] = std::string("\\gamma");;
+               standard_names["delta"] = std::string("\\delta");;
+               standard_names["epsilon"] = std::string("\\epsilon");
+               standard_names["varepsilon"] = std::string("\\varepsilon");
+               standard_names["zeta"] = std::string("\\zeta");
+               standard_names["eta" ] = std::string("\\eta" );
+               standard_names["theta"] = std::string("\\theta");
+               standard_names["vartheta"] = std::string("\\vartheta");
+               standard_names["iota"] = std::string("\\iota");
+               standard_names["kappa"] = std::string("\\kappa");
+               standard_names["lambda"] = std::string("\\lambda");
+               standard_names["mu"] = std::string("\\mu");
+               standard_names["nu"] = std::string("\\nu");
+               standard_names["xi"] = std::string("\\xi");
+               standard_names["omicron"] = std::string("\\omicron");
+               standard_names["pi"] = std::string("\\pi");
+               standard_names["varpi"] = std::string("\\varpi");
+               standard_names["rho"] = std::string("\\rho");
+               standard_names["varrho"] = std::string("\\varrho");
+               standard_names["sigma"] = std::string("\\sigma");
+               standard_names["varsigma"] = std::string("\\varsigma");
+               standard_names["tau"] = std::string("\\tau");
+               standard_names["upsilon"] = std::string("\\upsilon");
+               standard_names["phi"] = std::string("\\phi");
+               standard_names["varphi"] = std::string("\\varphi");
+               standard_names["chi"] = std::string("\\chi");
+               standard_names["psi"] = std::string("\\psi");
+               standard_names["omega"] = std::string("\\omega");
+               standard_names["Gamma"] = std::string("\\Gamma");
+               standard_names["Delta"] = std::string("\\Delta");
+               standard_names["Theta"] = std::string("\\Theta");
+               standard_names["Lambda"] = std::string("\\Lambda");
+               standard_names["Xi"] = std::string("\\Xi");
+               standard_names["Pi"] = std::string("\\Pi");
+               standard_names["Sigma"] = std::string("\\Sigma");
+               standard_names["Upsilon"] = std::string("\\Upsilon");
+               standard_names["Phi"] = std::string("\\Phi");
+               standard_names["Psi"] = std::string("\\Psi");
+               standard_names["Omega"] = std::string("\\Omega");
+               names_initialized = true;
+       }
+       std::map<std::string, std::string>::const_iterator it = standard_names.find(name);
+       if (it != standard_names.end())
+               return it->second;
        else
                return name;
 }
 
+GINAC_BIND_UNARCHIVER(symbol);
+GINAC_BIND_UNARCHIVER(realsymbol);
+GINAC_BIND_UNARCHIVER(possymbol);
+
 //////////
 // static member variables
 //////////