X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fsymbol.h;h=6036318ffacb3a8d2f0cb279b4ece30abf1bc470;hp=8b8e9a76cff9ac457f63cd25fbdadb64ea74edaa;hb=a06a27122b0a9087e9c64743940016c7e0176ce2;hpb=a8507b8af1c08d9b27d98d57f95c7ca1a8671e27 diff --git a/ginac/symbol.h b/ginac/symbol.h index 8b8e9a76..6036318f 100644 --- a/ginac/symbol.h +++ b/ginac/symbol.h @@ -1,8 +1,9 @@ /** @file symbol.h * - * Interface to GiNaC's symbolic objects. - * - * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany + * Interface to GiNaC's symbolic objects. */ + +/* + * GiNaC Copyright (C) 1999-2011 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 @@ -16,108 +17,111 @@ * * 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 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef __GINAC_SYMBOL_H__ -#define __GINAC_SYMBOL_H__ +#ifndef GINAC_SYMBOL_H +#define GINAC_SYMBOL_H + +#include "basic.h" +#include "ex.h" +#include "ptr.h" +#include "archive.h" #include +#include + +namespace GiNaC { /** Basic CAS symbol. It has a name because it must know how to output itself. - * It may be assigned an expression, but this feature is only intended for - * programs like 'ginsh' that want to associate symbols with expressions. - * If you want to replace symbols by expressions in your code, you should - * use ex::subs() or use objects of class ex instead of class symbol in the - * first place. */ + */ class symbol : public basic { -// types - /** Symbols as keys to expressions. */ - class assigned_ex_info { - public: - assigned_ex_info(); //!< Default ctor - bool is_assigned; //!< True if there is an expression assigned - ex assigned_expression; //!< The actual expression - unsigned refcount; //!< Yet another refcounter. PLEASE EXPLAIN! - }; - -// member functions - - // default constructor, destructor, copy constructor assignment operator and helpers + GINAC_DECLARE_REGISTERED_CLASS(symbol, basic) + // other constructors public: - symbol(); - ~symbol(); - symbol(symbol const & other); -protected: - void copy(symbol const & other); - void destroy(bool call_parent); - - // other constructors + explicit symbol(const std::string & initname); + symbol(const std::string & initname, const std::string & texname); + + // functions overriding virtual functions from base classes public: - explicit symbol(string const & initname); - - // functions overriding virtual functions from base classes -public: - basic * duplicate() const; - void printraw(ostream & os) const; - void printtree(ostream & os, unsigned indent) const; - void print(ostream & os, unsigned upper_precedence=0) const; - void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const; - bool info(unsigned inf) const; - ex expand(unsigned options=0) const; - bool has(ex const & other) const; - int degree(symbol const & s) const; - int ldegree(symbol const & s) const; - ex coeff(symbol const & s, int const n = 1) const; - ex eval(int level = 0) const; - ex diff(symbol const & s) const; - ex normal(lst &sym_lst, lst &repl_lst, int level=0) const; - ex subs(lst const & ls, lst const & lr) const; + bool info(unsigned inf) const; + ex eval(int level = 0) const { return *this; } // for performance reasons + ex evalf(int level = 0) const { return *this; } // overwrites basic::evalf() for performance reasons + ex series(const relational & s, int order, unsigned options = 0) const; + ex subs(const exmap & m, unsigned options = 0) const { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons + ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const; + ex to_rational(exmap & repl) const; + ex to_polynomial(exmap & repl) const; + ex conjugate() const; + ex real_part() const; + ex imag_part() const; + bool is_polynomial(const ex & var) const; + /** Save (a.k.a. serialize) object into archive. */ + void archive(archive_node& n) const; + /** Read (a.k.a. deserialize) object from archive. */ + void read_archive(const archive_node& n, lst& syms); protected: - int compare_same_type(basic const & other) const; - bool is_equal_same_type(basic const & other) const; - unsigned return_type(void) const; - unsigned return_type_tinfo(void) const; - unsigned calchash(void) const; - - // non-virtual functions in this class + ex derivative(const symbol & s) const; + bool is_equal_same_type(const basic & other) const; + unsigned calchash() const; + + // non-virtual functions in this class public: - void assign(ex const & value); - void unassign(void); - ex diff(symbol const & s, unsigned nth) const; - void setname(string const & n) {name=n;} - string getname(void) const {return name;} -private: - string & autoname_prefix(void); + void set_name(const std::string & n) { name = n; } + std::string get_name() const; + virtual unsigned get_domain() const { return domain::complex; } +protected: + void do_print(const print_context & c, unsigned level) const; + void do_print_latex(const print_latex & c, unsigned level) const; + void do_print_tree(const print_tree & c, unsigned level) const; + void do_print_python_repr(const print_python_repr & c, unsigned level) const; // member variables protected: - assigned_ex_info * asexinfop; - unsigned serial; //!< unique serial number for comparision - string name; + unsigned serial; ///< unique serial number for comparison + mutable std::string name; ///< printname of this symbol + std::string TeX_name; ///< LaTeX name of this symbol private: - static unsigned next_serial; + static unsigned next_serial; }; +GINAC_DECLARE_UNARCHIVER(symbol); + + +/** Specialization of symbol to real domain */ +class realsymbol : public symbol +{ +public: + realsymbol(); + explicit realsymbol(const std::string & initname); + realsymbol(const std::string & initname, const std::string & texname); -// global constants + unsigned get_domain() const { return domain::real; } -extern const symbol some_symbol; -extern type_info const & typeid_symbol; + ex conjugate() const { return *this; } + ex real_part() const { return *this; } + ex imag_part() const { return 0; } -// macros + realsymbol* duplicate() const { return new realsymbol(*this); } +}; +GINAC_DECLARE_UNARCHIVER(realsymbol); -#define ex_to_symbol(X) static_cast(*(X).bp) -// wrapper functions around member functions -inline void unassign(symbol & symarg) -{ return symarg.unassign(); } +/** Specialization of symbol to real positive domain */ +class possymbol : public realsymbol +{ +public: + possymbol(); + explicit possymbol(const std::string & initname); + possymbol(const std::string & initname, const std::string & texname); -inline int degree(symbol const & a, symbol const & s) -{ return a.degree(s); } + unsigned get_domain() const { return domain::positive; } + + possymbol* duplicate() const { return new possymbol(*this); } +}; +GINAC_DECLARE_UNARCHIVER(possymbol); -inline int ldegree(symbol const & a, symbol const & s) -{ return a.ldegree(s); } +} // namespace GiNaC -#endif // ndef __GINAC_SYMBOL_H__ +#endif // ndef GINAC_SYMBOL_H