]> www.ginac.de Git - ginac.git/blobdiff - ginac/symbol.cpp
- added find() (like has(), but returns list of all occurrences)
[ginac.git] / ginac / symbol.cpp
index 1e2561ab7eff7550b3e9303bacc3b31df09368fe..ba0cccd1004b20754a2def09bfa47bd3904ded44 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's symbolic objects. */
 
 /*
- *  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
 
 #include "symbol.h"
 #include "lst.h"
-#include "idx.h"
+#include "print.h"
 #include "archive.h"
 #include "debugmsg.h"
 #include "utils.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
-GINAC_IMPLEMENT_REGISTERED_CLASS(symbol, basic)
+GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(symbol, basic)
 
 //////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default ctor, dtor, copy ctor assignment operator and helpers
 //////////
 
-symbol::symbol() : inherited(TINFO_symbol)
+symbol::symbol() : inherited(TINFO_symbol), serial(next_serial++)
 {
-       debugmsg("symbol default constructor", LOGLEVEL_CONSTRUCT);
-       serial = next_serial++;
-       name = autoname_prefix()+ToString(serial);
+       debugmsg("symbol default ctor", LOGLEVEL_CONSTRUCT);
+       name = TeX_name = autoname_prefix()+ToString(serial);
        asexinfop = new assigned_ex_info;
-       setflag(status_flags::evaluated);
-}
-
-symbol::~symbol()
-{
-       debugmsg("symbol destructor", LOGLEVEL_DESTRUCT);
-       destroy(0);
-}
-
-symbol::symbol(const symbol & other)
-{
-       debugmsg("symbol copy constructor", LOGLEVEL_CONSTRUCT);
-       copy(other);
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
+/** For use by copy ctor and assignment operator. */
 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;
@@ -72,33 +59,42 @@ void symbol::copy(const symbol & other)
 
 void symbol::destroy(bool call_parent)
 {
-       if (--asexinfop->refcount == 0) {
+       if (--asexinfop->refcount == 0)
                delete asexinfop;
-       }
-       if (call_parent) {
+       if (call_parent)
                inherited::destroy(call_parent);
-       }
 }
 
-// how should the following be interpreted?
-// symbol x;
-// symbol y;
-// x=y;
-// probably as: x=ex(y);
-
 //////////
-// other constructors
+// other ctors
 //////////
 
 // public
 
+symbol::symbol(const symbol & other)
+{
+       debugmsg("symbol copy ctor", LOGLEVEL_CONSTRUCT);
+       copy(other);
+}
+
 symbol::symbol(const std::string & initname) : inherited(TINFO_symbol)
 {
-       debugmsg("symbol constructor from string", LOGLEVEL_CONSTRUCT);
+       debugmsg("symbol ctor from string", LOGLEVEL_CONSTRUCT);
        name = initname;
+       TeX_name = default_TeX_name();
        serial = next_serial++;
        asexinfop = new assigned_ex_info;
-       setflag(status_flags::evaluated);
+       setflag(status_flags::evaluated | status_flags::expanded);
+}
+
+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);
 }
 
 //////////
@@ -108,10 +104,12 @@ 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 constructor from archive_node", LOGLEVEL_CONSTRUCT);
+       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);
 }
@@ -120,10 +118,10 @@ symbol::symbol(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst
 ex symbol::unarchive(const archive_node &n, const lst &sym_lst)
 {
        ex s = (new symbol(n, sym_lst))->setflag(status_flags::dynallocated);
-
+       
        // 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;
@@ -134,6 +132,8 @@ 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);
 }
 
 //////////
@@ -148,116 +148,71 @@ basic *symbol::duplicate() const
        return new symbol(*this);
 }
 
-void symbol::print(std::ostream & os, unsigned upper_precedence) const
+void symbol::print(const print_context & c, unsigned level) const
 {
-       debugmsg("symbol print",LOGLEVEL_PRINT);
-       os << name;
-}
+       debugmsg("symbol print", LOGLEVEL_PRINT);
 
-void symbol::printraw(std::ostream & os) const
-{
-       debugmsg("symbol printraw",LOGLEVEL_PRINT);
-       os << "symbol(" << "name=" << name << ",serial=" << serial
-          << ",hash=" << hashvalue << ",flags=" << flags << ")";
-}
+       if (is_of_type(c, print_tree)) {
 
-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;
-}
+               c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
+                   << ", serial=" << serial
+                   << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+                   << std::endl;
 
-void symbol::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
-{
-       debugmsg("symbol print csrc", LOGLEVEL_PRINT);
-       os << name;
+       } else if (is_of_type(c, print_latex))
+               c.s << TeX_name;
+       else
+               c.s << name;
 }
 
 bool symbol::info(unsigned inf) const
 {
        if (inf==info_flags::symbol) return true;
        if (inf==info_flags::polynomial ||
-               inf==info_flags::integer_polynomial ||
-               inf==info_flags::cinteger_polynomial ||
-               inf==info_flags::rational_polynomial ||
-               inf==info_flags::crational_polynomial ||
-               inf==info_flags::rational_function) {
+           inf==info_flags::integer_polynomial ||
+           inf==info_flags::cinteger_polynomial ||
+           inf==info_flags::rational_polynomial ||
+           inf==info_flags::crational_polynomial ||
+           inf==info_flags::rational_function)
                return true;
-       } else {
+       else
                return inherited::info(inf);
-       }
-}
-
-ex symbol::expand(unsigned options) const
-{
-       return this->hold();
 }
 
-bool symbol::has(const ex & other) const
+int symbol::degree(const ex & s) const
 {
-       if (is_equal(*other.bp)) return true;
-       return false;
+       return is_equal(*s.bp) ? 1 : 0;
 }
 
-int symbol::degree(const symbol & s) const
+int symbol::ldegree(const ex & s) const
 {
-       return compare_same_type(s)==0 ? 1 : 0;
+       return is_equal(*s.bp) ? 1 : 0;
 }
 
-int symbol::ldegree(const symbol & s) const
+ex symbol::coeff(const ex & s, int n) const
 {
-       return compare_same_type(s)==0 ? 1 : 0;
-}
-
-ex symbol::coeff(const symbol & s, int n) const
-{
-       if (compare_same_type(s)==0) {
+       if (is_equal(*s.bp))
                return n==1 ? _ex1() : _ex0();
-       } else {
+       else
                return n==0 ? *this : _ex0();
-       }
 }
 
 ex symbol::eval(int level) const
 {
-       if (level == -max_recursion_level) {
+       if (level == -max_recursion_level)
                throw(std::runtime_error("max recursion level reached"));
-       }
        
        if (asexinfop->is_assigned) {
                setflag(status_flags::evaluated);
-               if (level==1) {
+               if (level==1)
                        return (asexinfop->assigned_expression);
-               } else {
+               else
                        return (asexinfop->assigned_expression).eval(level);
-               }
        } else {
                return this->hold();
        }
 }
 
-ex symbol::subs(const lst & ls, const lst & lr) const
-{
-       GINAC_ASSERT(ls.nops()==lr.nops());
-#ifdef DO_GINAC_ASSERT
-       for (unsigned i=0; i<ls.nops(); i++) {
-               GINAC_ASSERT(is_ex_exactly_of_type(ls.op(i),symbol)||
-                          is_ex_of_type(ls.op(i),idx));
-       }
-#endif // def DO_GINAC_ASSERT
-
-       for (unsigned i=0; i<ls.nops(); i++) {
-               if (is_ex_exactly_of_type(ls.op(i),symbol)) {
-                       if (compare_same_type(ex_to_symbol(ls.op(i)))==0) return lr.op(i);
-               }
-       }
-       return *this;
-}
-
 // protected
 
 /** Implementation of ex::diff() for single differentiation of a symbol.
@@ -266,11 +221,10 @@ ex symbol::subs(const lst & ls, const lst & lr) const
  *  @see ex::diff */
 ex symbol::derivative(const symbol & s) const
 {
-       if (compare_same_type(s)) {
+       if (compare_same_type(s))
                return _ex0();
-       } else {
+       else
                return _ex1();
-       }
 }
 
 int symbol::compare_same_type(const basic & other) const
@@ -300,8 +254,10 @@ unsigned symbol::return_type_tinfo(void) const
 
 unsigned symbol::calchash(void) const
 {
-       // return golden_ratio_hash(tinfo()) ^ serial;
-       hashvalue=golden_ratio_hash(golden_ratio_hash(0x55555555U ^ serial));
+       // this is where the schoolbook method
+       // (golden_ratio_hash(tinfo()) ^ serial)
+       // is not good enough yet...
+       hashvalue = golden_ratio_hash(golden_ratio_hash(tinfo()) ^ serial);
        setflag(status_flags::hash_calculated);
        return hashvalue;
 }
@@ -320,44 +276,59 @@ unsigned symbol::calchash(void) const
 
 void symbol::assign(const ex & value)
 {
-       asexinfop->is_assigned=1;
-       asexinfop->assigned_expression=value;
-       clearflag(status_flags::evaluated);
+       asexinfop->is_assigned = 1;
+       asexinfop->assigned_expression = value;
+       clearflag(status_flags::evaluated | status_flags::expanded);
 }
 
 void symbol::unassign(void)
 {
        if (asexinfop->is_assigned) {
-               asexinfop->is_assigned=0;
-               asexinfop->assigned_expression=_ex0();
+               asexinfop->is_assigned = 0;
+               asexinfop->assigned_expression = _ex0();
        }
-       setflag(status_flags::evaluated);
+       setflag(status_flags::evaluated | status_flags::expanded);
 }
 
 // private
 
+/** Symbols not constructed with a string get one assigned using this
+ *  prefix and a number. */
 std::string & symbol::autoname_prefix(void)
 {
-       static std::string * s=new std::string("symbol");
+       static std::string *s = new std::string("symbol");
        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
 //////////
 
 // private
 
-unsigned symbol::next_serial=0;
-
-// std::string const symbol::autoname_prefix="symbol";
-
-//////////
-// global constants
-//////////
-
-const symbol some_symbol;
-const type_info & typeid_symbol=typeid(some_symbol);
+unsigned symbol::next_serial = 0;
 
 //////////
 // subclass assigned_ex_info
@@ -368,6 +339,4 @@ symbol::assigned_ex_info::assigned_ex_info(void) : is_assigned(0), refcount(1)
 {
 }
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC