]> www.ginac.de Git - ginac.git/blobdiff - ginac/symbol.cpp
documentation update
[ginac.git] / ginac / symbol.cpp
index 09e4192b689cdf27ed3f6fb5c52958bdb44011e7..f099967cb095c349cba4a1b19320391c0b6fa2ad 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's symbolic objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2002 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 "symbol.h"
 #include "lst.h"
+#include "print.h"
 #include "archive.h"
-#include "debugmsg.h"
+#include "tostring.h"
 #include "utils.h"
 
 namespace GiNaC {
 
-GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(symbol, basic)
+GINAC_IMPLEMENT_REGISTERED_CLASS(symbol, basic)
 
 //////////
-// default ctor, dtor, copy ctor assignment operator and helpers
+// default ctor, dtor, copy ctor, assignment operator and helpers
 //////////
 
 symbol::symbol() : inherited(TINFO_symbol), serial(next_serial++)
 {
-       debugmsg("symbol default ctor", LOGLEVEL_CONSTRUCT);
-       name = autoname_prefix()+ToString(serial);
+       name = TeX_name = autoname_prefix()+ToString(serial);
        asexinfop = new assigned_ex_info;
        setflag(status_flags::evaluated | status_flags::expanded);
 }
@@ -50,9 +50,10 @@ void symbol::copy(const symbol & other)
 {
        inherited::copy(other);
        name = other.name;
+       TeX_name = other.TeX_name;
        serial = other.serial;
        asexinfop = other.asexinfop;
-       ++asexinfop->refcount;
+       ++(asexinfop->refcount);
 }
 
 void symbol::destroy(bool call_parent)
@@ -69,16 +70,19 @@ void symbol::destroy(bool call_parent)
 
 // public
 
-symbol::symbol(const symbol & other)
+symbol::symbol(const std::string & initname) : inherited(TINFO_symbol)
 {
-       debugmsg("symbol copy ctor", LOGLEVEL_CONSTRUCT);
-       copy(other);
+       name = initname;
+       TeX_name = default_TeX_name();
+       serial = next_serial++;
+       asexinfop = new assigned_ex_info;
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
-symbol::symbol(const std::string & initname) : inherited(TINFO_symbol)
+symbol::symbol(const std::string & initname, const std::string & texname) : inherited(TINFO_symbol)
 {
-       debugmsg("symbol ctor from string", LOGLEVEL_CONSTRUCT);
        name = initname;
+       TeX_name = texname;
        serial = next_serial++;
        asexinfop = new assigned_ex_info;
        setflag(status_flags::evaluated | status_flags::expanded);
@@ -91,10 +95,11 @@ symbol::symbol(const std::string & initname) : inherited(TINFO_symbol)
 /** Construct object from archive_node. */
 symbol::symbol(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 {
-       debugmsg("symbol ctor from archive_node", LOGLEVEL_CONSTRUCT);
        serial = next_serial++;
        if (!(n.find_string("name", name)))
                name = autoname_prefix() + ToString(serial);
+       if (!(n.find_string("TeXname", TeX_name)))
+               TeX_name = default_TeX_name();
        asexinfop = new assigned_ex_info;
        setflag(status_flags::evaluated);
 }
@@ -106,7 +111,7 @@ ex symbol::unarchive(const archive_node &n, const lst &sym_lst)
        
        // If symbol is in sym_lst, return the existing symbol
        for (unsigned i=0; i<sym_lst.nops(); i++) {
-               if (is_ex_of_type(sym_lst.op(i), symbol) && (ex_to_symbol(sym_lst.op(i)).name == ex_to_symbol(s).name))
+               if (is_ex_of_type(sym_lst.op(i), symbol) && (ex_to<symbol>(sym_lst.op(i)).name == ex_to<symbol>(s).name))
                        return sym_lst.op(i);
        }
        return s;
@@ -117,47 +122,34 @@ void symbol::archive(archive_node &n) const
 {
        inherited::archive(n);
        n.add_string("name", name);
+       if (TeX_name != default_TeX_name())
+               n.add_string("TeX_name", TeX_name);
 }
 
 //////////
-// functions overriding virtual functions from bases classes
+// functions overriding virtual functions from base classes
 //////////
 
 // public
 
-basic *symbol::duplicate() const
-{
-       debugmsg("symbol duplicate", LOGLEVEL_DUPLICATE);
-       return new symbol(*this);
-}
-
-void symbol::print(std::ostream & os, unsigned upper_precedence) const
-{
-       debugmsg("symbol print",LOGLEVEL_PRINT);
-       os << name;
-}
-
-void symbol::printraw(std::ostream & os) const
+void symbol::print(const print_context & c, unsigned level) const
 {
-       debugmsg("symbol printraw",LOGLEVEL_PRINT);
-       os << class_name() << "(" << "name=" << name << ",serial=" << serial
-          << ",hash=" << hashvalue << ",flags=" << flags << ")";
-}
-
-void symbol::printtree(std::ostream & os, unsigned indent) const
-{
-       debugmsg("symbol printtree",LOGLEVEL_PRINT);
-       os << std::string(indent,' ') << name << " (symbol): "
-          << "serial=" << serial
-          << ", hash=" << hashvalue
-          << " (0x" << std::hex << hashvalue << std::dec << ")"
-          << ", flags=" << flags << std::endl;
-}
-
-void symbol::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
-{
-       debugmsg("symbol print csrc", LOGLEVEL_PRINT);
-       os << name;
+       if (is_a<print_tree>(c)) {
+
+               c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
+                   << ", serial=" << serial
+                   << 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 != default_TeX_name())
+                       c.s << "','" << TeX_name;
+               c.s << "')";
+       } else
+               c.s << name;
 }
 
 bool symbol::info(unsigned inf) const
@@ -174,37 +166,6 @@ bool symbol::info(unsigned inf) const
                return inherited::info(inf);
 }
 
-ex symbol::expand(unsigned options) const
-{
-       return this->hold();
-}
-
-bool symbol::has(const ex & other) const
-{
-       if (this->is_equal(*other.bp))
-               return true;
-       else
-               return false;
-}
-
-int symbol::degree(const ex & s) const
-{
-       return is_equal(*s.bp) ? 1 : 0;
-}
-
-int symbol::ldegree(const ex & s) const
-{
-       return is_equal(*s.bp) ? 1 : 0;
-}
-
-ex symbol::coeff(const ex & s, int n) const
-{
-       if (is_equal(*s.bp))
-               return n==1 ? _ex1() : _ex0();
-       else
-               return n==0 ? *this : _ex0();
-}
-
 ex symbol::eval(int level) const
 {
        if (level == -max_recursion_level)
@@ -230,14 +191,14 @@ ex symbol::eval(int level) const
 ex symbol::derivative(const symbol & s) const
 {
        if (compare_same_type(s))
-               return _ex0();
+               return _ex0;
        else
-               return _ex1();
+               return _ex1;
 }
 
 int symbol::compare_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_of_type(other,symbol));
+       GINAC_ASSERT(is_a<symbol>(other));
        const symbol *o = static_cast<const symbol *>(&other);
        if (serial==o->serial) return 0;
        return serial < o->serial ? -1 : 1;
@@ -245,21 +206,11 @@ int symbol::compare_same_type(const basic & other) const
 
 bool symbol::is_equal_same_type(const basic & other) const
 {
-       GINAC_ASSERT(is_of_type(other,symbol));
+       GINAC_ASSERT(is_a<symbol>(other));
        const symbol *o = static_cast<const symbol *>(&other);
        return serial==o->serial;
 }
 
-unsigned symbol::return_type(void) const
-{
-       return return_types::commutative;
-}
-   
-unsigned symbol::return_type_tinfo(void) const
-{
-       return tinfo_key;
-}
-
 unsigned symbol::calchash(void) const
 {
        // this is where the schoolbook method
@@ -293,7 +244,7 @@ void symbol::unassign(void)
 {
        if (asexinfop->is_assigned) {
                asexinfop->is_assigned = 0;
-               asexinfop->assigned_expression = _ex0();
+               asexinfop->assigned_expression = _ex0;
        }
        setflag(status_flags::evaluated | status_flags::expanded);
 }
@@ -308,6 +259,28 @@ std::string & symbol::autoname_prefix(void)
        return *s;
 }
 
+/** Return default TeX name for symbol. This recognizes some greek letters. */
+std::string symbol::default_TeX_name(void) const
+{
+       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;
+       else
+               return name;
+}
+
 //////////
 // static member variables
 //////////