* Implementation of GiNaC's symbolic objects. */
/*
- * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2003 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 "archive.h"
-#include "debugmsg.h"
+#include "tostring.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_OPT(symbol, basic,
+ print_func<print_context>(&symbol::do_print).
+ print_func<print_latex>(&symbol::do_print_latex).
+ print_func<print_tree>(&symbol::do_print_tree).
+ print_func<print_python_repr>(&symbol::do_print_python_repr))
//////////
-// default constructor, destructor, copy constructor assignment operator and helpers
+// default constructor
//////////
-symbol::symbol() : inherited(TINFO_symbol)
+symbol::symbol()
+ : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(autoname_prefix() + ToString(serial)), TeX_name(name), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol)
{
- debugmsg("symbol default constructor", LOGLEVEL_CONSTRUCT);
- serial = next_serial++;
- name = autoname_prefix()+ToString(serial);
- asexinfop = new assigned_ex_info;
- setflag(status_flags::evaluated);
+ setflag(status_flags::evaluated | status_flags::expanded);
}
-symbol::~symbol()
-{
- debugmsg("symbol destructor", LOGLEVEL_DESTRUCT);
- destroy(0);
-}
+//////////
+// other constructors
+//////////
+
+// public
-symbol::symbol(const symbol & other)
+symbol::symbol(const std::string & initname)
+ : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(default_TeX_name()), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol)
{
- debugmsg("symbol copy constructor", LOGLEVEL_CONSTRUCT);
- copy(other);
+ setflag(status_flags::evaluated | status_flags::expanded);
}
-void symbol::copy(const symbol & other)
+symbol::symbol(const std::string & initname, const std::string & texname)
+ : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(texname), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol)
{
- inherited::copy(other);
- name = other.name;
- serial = other.serial;
- asexinfop = other.asexinfop;
- ++asexinfop->refcount;
+ setflag(status_flags::evaluated | status_flags::expanded);
}
-void symbol::destroy(bool call_parent)
+symbol::symbol(const std::string & initname, unsigned rt, unsigned rtt)
+ : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(default_TeX_name()), ret_type(rt), ret_type_tinfo(rtt)
{
- if (--asexinfop->refcount == 0) {
- delete asexinfop;
- }
- if (call_parent) {
- inherited::destroy(call_parent);
- }
+ setflag(status_flags::evaluated | status_flags::expanded);
}
-// how should the following be interpreted?
-// symbol x;
-// symbol y;
-// x=y;
-// probably as: x=ex(y);
-
-//////////
-// other constructors
-//////////
-
-// public
-
-symbol::symbol(const string & initname) : inherited(TINFO_symbol)
+symbol::symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned rtt)
+ : inherited(TINFO_symbol), asexinfop(new assigned_ex_info), serial(next_serial++), name(initname), TeX_name(texname), ret_type(rt), ret_type_tinfo(rtt)
{
- debugmsg("symbol constructor from string", LOGLEVEL_CONSTRUCT);
- name = initname;
- serial = next_serial++;
- asexinfop = new assigned_ex_info;
- setflag(status_flags::evaluated);
+ setflag(status_flags::evaluated | status_flags::expanded);
}
//////////
//////////
/** Construct object from archive_node. */
-symbol::symbol(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
+symbol::symbol(const archive_node &n, lst &sym_lst)
+ : inherited(n, sym_lst), asexinfop(new assigned_ex_info), serial(next_serial++), ret_type(return_types::commutative), ret_type_tinfo(TINFO_symbol)
{
- debugmsg("symbol constructor from archive_node", LOGLEVEL_CONSTRUCT);
- serial = next_serial++;
- if (!(n.find_string("name", name)))
- name = autoname_prefix() + ToString(serial);
- asexinfop = new assigned_ex_info;
- setflag(status_flags::evaluated);
+ 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("return_type", ret_type))
+ ret_type = return_types::commutative;
+ if (!n.find_unsigned("return_type_tinfo", ret_type_tinfo))
+ ret_type_tinfo = TINFO_symbol;
+ setflag(status_flags::evaluated | status_flags::expanded);
}
/** Unarchive the object. */
-ex symbol::unarchive(const archive_node &n, const lst &sym_lst)
+ex symbol::unarchive(const archive_node &n, 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))
- return sym_lst.op(i);
- }
- return s;
+ ex s = (new symbol(n, sym_lst))->setflag(status_flags::dynallocated);
+
+ // 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;
+ }
+
+ // Otherwise add new symbol to list and return it
+ sym_lst.append(s);
+ return s;
}
/** Archive the object. */
void symbol::archive(archive_node &n) const
{
- inherited::archive(n);
- n.add_string("name", name);
+ inherited::archive(n);
+ n.add_string("name", name);
+ if (TeX_name != default_TeX_name())
+ n.add_string("TeX_name", TeX_name);
+ if (ret_type != return_types::commutative)
+ n.add_unsigned("return_type", ret_type);
+ if (ret_type_tinfo != TINFO_symbol)
+ n.add_unsigned("return_type_tinfo", ret_type_tinfo);
}
//////////
-// 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(ostream & os, unsigned upper_precedence) const
+void symbol::do_print(const print_context & c, unsigned level) const
{
- debugmsg("symbol print",LOGLEVEL_PRINT);
- os << name;
+ c.s << name;
}
-void symbol::printraw(ostream & os) const
+void symbol::do_print_latex(const print_latex & c, unsigned level) const
{
- debugmsg("symbol printraw",LOGLEVEL_PRINT);
- os << "symbol(" << "name=" << name << ",serial=" << serial
- << ",hash=" << hashvalue << ",flags=" << flags << ")";
+ c.s << TeX_name;
}
-void symbol::printtree(ostream & os, unsigned indent) const
+void symbol::do_print_tree(const print_tree & c, unsigned level) const
{
- debugmsg("symbol printtree",LOGLEVEL_PRINT);
- os << string(indent,' ') << name << " (symbol): "
- << "serial=" << serial
- << ", hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
- << ", flags=" << flags << endl;
+ c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
+ << ", serial=" << serial
+ << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
+ << std::endl;
}
-void symbol::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
+void symbol::do_print_python_repr(const print_python_repr & c, unsigned level) const
{
- debugmsg("symbol print csrc", LOGLEVEL_PRINT);
- os << name;
+ c.s << class_name() << "('" << name;
+ if (TeX_name != default_TeX_name())
+ c.s << "','" << TeX_name;
+ c.s << "')";
}
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) {
- return true;
- } else {
- return inherited::info(inf);
- }
-}
-
-ex symbol::expand(unsigned options) const
-{
- return this->hold();
-}
-
-bool symbol::has(const ex & other) const
-{
- if (is_equal(*other.bp)) return true;
- return false;
-}
-
-int symbol::degree(const symbol & s) const
-{
- return compare_same_type(s)==0 ? 1 : 0;
-}
-
-int symbol::ldegree(const symbol & s) const
-{
- return compare_same_type(s)==0 ? 1 : 0;
-}
-
-ex symbol::coeff(const symbol & s, int n) const
-{
- if (compare_same_type(s)==0) {
- return n==1 ? _ex1() : _ex0();
- } else {
- return n==0 ? *this : _ex0();
- }
+ 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)
+ return true;
+ else
+ return inherited::info(inf);
}
ex symbol::eval(int level) const
{
- if (level == -max_recursion_level) {
- throw(std::runtime_error("max recursion level reached"));
- }
-
- if (asexinfop->is_assigned) {
- setflag(status_flags::evaluated);
- if (level==1) {
- return (asexinfop->assigned_expression);
- } 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;
+ if (level == -max_recursion_level)
+ throw(std::runtime_error("max recursion level reached"));
+
+ if (asexinfop->is_assigned) {
+ setflag(status_flags::evaluated);
+ if (level==1)
+ return (asexinfop->assigned_expression);
+ else
+ return (asexinfop->assigned_expression).eval(level);
+ } else {
+ return this->hold();
+ }
}
// protected
* @see ex::diff */
ex symbol::derivative(const symbol & s) const
{
- if (compare_same_type(s)) {
- return _ex0();
- } else {
- return _ex1();
- }
+ if (compare_same_type(s))
+ return _ex0;
+ else
+ return _ex1;
}
int symbol::compare_same_type(const basic & other) const
{
- GINAC_ASSERT(is_of_type(other,symbol));
- const symbol *o = static_cast<const symbol *>(&other);
- if (serial==o->serial) return 0;
- return serial < o->serial ? -1 : 1;
+ 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;
}
bool symbol::is_equal_same_type(const basic & other) const
{
- GINAC_ASSERT(is_of_type(other,symbol));
- const symbol *o = static_cast<const symbol *>(&other);
- return serial==o->serial;
+ GINAC_ASSERT(is_a<symbol>(other));
+ const symbol *o = static_cast<const symbol *>(&other);
+ return serial==o->serial;
}
-unsigned symbol::return_type(void) const
+unsigned symbol::calchash() const
{
- return return_types::commutative;
-}
-
-unsigned symbol::return_type_tinfo(void) const
-{
- return tinfo_key;
-}
-
-unsigned symbol::calchash(void) const
-{
- // return golden_ratio_hash(tinfo()) ^ serial;
- hashvalue=golden_ratio_hash(golden_ratio_hash(0x55555555U ^ serial));
- setflag(status_flags::hash_calculated);
- return hashvalue;
+ hashvalue = golden_ratio_hash(tinfo() ^ serial);
+ setflag(status_flags::hash_calculated);
+ return hashvalue;
}
//////////
void symbol::assign(const ex & value)
{
- asexinfop->is_assigned=1;
- asexinfop->assigned_expression=value;
- clearflag(status_flags::evaluated);
+ asexinfop->is_assigned = true;
+ asexinfop->assigned_expression = value;
+ clearflag(status_flags::evaluated | status_flags::expanded);
}
-void symbol::unassign(void)
+void symbol::unassign()
{
- if (asexinfop->is_assigned) {
- asexinfop->is_assigned=0;
- asexinfop->assigned_expression=_ex0();
- }
- setflag(status_flags::evaluated);
+ if (asexinfop->is_assigned) {
+ asexinfop->is_assigned = false;
+ asexinfop->assigned_expression = _ex0;
+ }
+ setflag(status_flags::evaluated | status_flags::expanded);
}
// private
-string & symbol::autoname_prefix(void)
+/** Symbols not constructed with a string get one assigned using this
+ * prefix and a number. */
+std::string & symbol::autoname_prefix()
+{
+ 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() const
{
- static string * s=new string("symbol");
- return *s;
+ 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;
}
//////////
// private
-unsigned symbol::next_serial=0;
-
-// 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
//////////
/** Default ctor. Defaults to unassigned. */
-symbol::assigned_ex_info::assigned_ex_info(void) : is_assigned(0), refcount(1)
+symbol::assigned_ex_info::assigned_ex_info() throw() : is_assigned(false)
{
}
-#ifndef NO_NAMESPACE_GINAC
} // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
git://www.ginac.de / ginac.git / blobdiff