X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fsymbol.cpp;h=ba0cccd1004b20754a2def09bfa47bd3904ded44;hp=6822dc49abb9a091091343ce36fa29680e60685f;hb=708e9e647029af699333fceffc0a76bef70a4709;hpb=6b3768e8c544739ae53321539cb4d1e3112ded1b;ds=sidebyside diff --git a/ginac/symbol.cpp b/ginac/symbol.cpp index 6822dc49..ba0cccd1 100644 --- a/ginac/symbol.cpp +++ b/ginac/symbol.cpp @@ -2,75 +2,138 @@ * * Implementation of GiNaC's symbolic objects. */ +/* + * 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 + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + #include #include -#include "ginac.h" +#include "symbol.h" +#include "lst.h" +#include "print.h" +#include "archive.h" +#include "debugmsg.h" #include "utils.h" +namespace GiNaC { + +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() : basic(TINFO_SYMBOL) +symbol::symbol() : inherited(TINFO_symbol), serial(next_serial++) { - debugmsg("symbol default constructor",LOGLEVEL_CONSTRUCT); - serial=next_serial++; - name=autoname_prefix()+ToString(serial); - asexinfop=new assigned_ex_info; - setflag(status_flags::evaluated); + debugmsg("symbol default ctor", LOGLEVEL_CONSTRUCT); + name = TeX_name = autoname_prefix()+ToString(serial); + asexinfop = new assigned_ex_info; + setflag(status_flags::evaluated | status_flags::expanded); } -symbol::~symbol() +/** For use by copy ctor and assignment operator. */ +void symbol::copy(const symbol & other) { - debugmsg("symbol destructor",LOGLEVEL_DESTRUCT); - destroy(0); + inherited::copy(other); + name = other.name; + TeX_name = other.TeX_name; + serial = other.serial; + asexinfop = other.asexinfop; + ++asexinfop->refcount; } -symbol::symbol(symbol const & other) +void symbol::destroy(bool call_parent) { - debugmsg("symbol copy constructor",LOGLEVEL_CONSTRUCT); - copy(other); + if (--asexinfop->refcount == 0) + delete asexinfop; + if (call_parent) + inherited::destroy(call_parent); } -void symbol::copy(symbol const & other) +////////// +// other ctors +////////// + +// public + +symbol::symbol(const symbol & other) { - basic::copy(other); - name=other.name; - serial=other.serial; - asexinfop=other.asexinfop; - ++asexinfop->refcount; + debugmsg("symbol copy ctor", LOGLEVEL_CONSTRUCT); + copy(other); } -void symbol::destroy(bool call_parent) +symbol::symbol(const std::string & initname) : inherited(TINFO_symbol) { - if (--asexinfop->refcount == 0) { - delete asexinfop; - } - if (call_parent) { - basic::destroy(call_parent); - } + 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 | status_flags::expanded); } -// how should the following be interpreted? -// symbol x; -// symbol y; -// x=y; -// probably as: x=ex(y); +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); +} ////////// -// other constructors +// archiving ////////// -// public +/** 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); +} + +/** Unarchive the object. */ +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.op(i)).name == ex_to(s).name)) + return sym_lst.op(i); + } + return s; +} -symbol::symbol(string const & initname) : basic(TINFO_SYMBOL) +/** Archive the object. */ +void symbol::archive(archive_node &n) const { - debugmsg("symbol constructor from string",LOGLEVEL_CONSTRUCT); - name=initname; - serial=next_serial++; - asexinfop=new assigned_ex_info; - setflag(status_flags::evaluated); + inherited::archive(n); + n.add_string("name", name); + if (TeX_name != default_TeX_name()) + n.add_string("TeX_name", TeX_name); } ////////// @@ -79,121 +142,124 @@ symbol::symbol(string const & initname) : basic(TINFO_SYMBOL) // public -basic * symbol::duplicate() const +basic *symbol::duplicate() const { - debugmsg("symbol duplicate",LOGLEVEL_DUPLICATE); - return new symbol(*this); + debugmsg("symbol duplicate", LOGLEVEL_DUPLICATE); + return new symbol(*this); } -bool symbol::info(unsigned inf) const +void symbol::print(const print_context & c, unsigned level) const { - if (inf==info_flags::symbol) return true; - if (inf==info_flags::polynomial || inf==info_flags::integer_polynomial || inf==info_flags::rational_polynomial || inf==info_flags::rational_function) { - return true; - } else { - return basic::info(inf); - } -} + debugmsg("symbol print", LOGLEVEL_PRINT); -ex symbol::expand(unsigned options) const -{ - return this->hold(); + if (is_of_type(c, print_tree)) { + + 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_of_type(c, print_latex)) + c.s << TeX_name; + else + c.s << name; } -bool symbol::has(ex const & other) const +bool symbol::info(unsigned inf) const { - if (is_equal(*other.bp)) return true; - return false; + 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); } -int symbol::degree(symbol const & s) const +int symbol::degree(const ex & s) const { - return compare_same_type(s)==0 ? 1 : 0; + return is_equal(*s.bp) ? 1 : 0; } -int symbol::ldegree(symbol const & s) const +int symbol::ldegree(const ex & s) const { - return compare_same_type(s)==0 ? 1 : 0; + return is_equal(*s.bp) ? 1 : 0; } -ex symbol::coeff(symbol const & s, int const n) const +ex symbol::coeff(const ex & s, int n) const { - if (compare_same_type(s)==0) { - return n==1 ? exONE() : exZERO(); - } else { - return n==0 ? *this : exZERO(); - } + 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) { - 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(); - } + 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(lst const & ls, lst const & lr) const +// protected + +/** Implementation of ex::diff() for single differentiation of a symbol. + * It returns 1 or 0. + * + * @see ex::diff */ +ex symbol::derivative(const symbol & s) const { - ASSERT(ls.nops()==lr.nops()); -#ifdef DOASSERT - for (int i=0; i(&other); - if (serial==o->serial) return 0; - return serial < o->serial ? -1 : 1; + GINAC_ASSERT(is_of_type(other,symbol)); + const symbol *o = static_cast(&other); + if (serial==o->serial) return 0; + return serial < o->serial ? -1 : 1; } -bool symbol::is_equal_same_type(basic const & other) const +bool symbol::is_equal_same_type(const basic & other) const { - ASSERT(is_of_type(other,symbol)); - const symbol *o = static_cast(&other); - return serial==o->serial; + GINAC_ASSERT(is_of_type(other,symbol)); + const symbol *o = static_cast(&other); + return serial==o->serial; } unsigned symbol::return_type(void) const { - return return_types::commutative; + return return_types::commutative; } unsigned symbol::return_type_tinfo(void) const { - return tinfo_key; + 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; + // 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; } ////////// @@ -208,28 +274,52 @@ unsigned symbol::calchash(void) const // public -void symbol::assign(ex const & value) +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=exZERO(); - } - setflag(status_flags::evaluated); + if (asexinfop->is_assigned) { + asexinfop->is_assigned = 0; + 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(void) { - static string * s=new string("symbol"); - return *s; + 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; } ////////// @@ -238,16 +328,7 @@ string & symbol::autoname_prefix(void) // private -unsigned symbol::next_serial=0; - -// string const symbol::autoname_prefix="symbol"; - -////////// -// global constants -////////// - -const symbol some_symbol; -type_info const & typeid_symbol=typeid(some_symbol); +unsigned symbol::next_serial = 0; ////////// // subclass assigned_ex_info @@ -257,3 +338,5 @@ type_info const & typeid_symbol=typeid(some_symbol); symbol::assigned_ex_info::assigned_ex_info(void) : is_assigned(0), refcount(1) { } + +} // namespace GiNaC