X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fsymbol.h;h=51164a972de73971d7f51b99d08f5a6800bbb626;hp=8b8e9a76cff9ac457f63cd25fbdadb64ea74edaa;hb=eddd1f843746065177daf1965a1ccd1a3d82a3fe;hpb=a8507b8af1c08d9b27d98d57f95c7ca1a8671e27 diff --git a/ginac/symbol.h b/ginac/symbol.h index 8b8e9a76..51164a97 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-2004 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 @@ -23,6 +24,11 @@ #define __GINAC_SYMBOL_H__ #include +#include "basic.h" +#include "ex.h" +#include "ptr.h" + +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 @@ -32,92 +38,109 @@ * 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 + GINAC_DECLARE_REGISTERED_CLASS(symbol, basic) - // default constructor, destructor, copy constructor assignment operator and helpers -public: - symbol(); - ~symbol(); - symbol(symbol const & other); -protected: - void copy(symbol const & other); - void destroy(bool call_parent); + friend class realsymbol; - // other constructors -public: - explicit symbol(string const & initname); +// types + + /** Symbols as keys to expressions - only for ginsh. */ + class assigned_ex_info : public refcounted { + public: + assigned_ex_info() throw(); ///< Default ctor + bool is_assigned; ///< True if there is an expression assigned + ex assigned_expression; ///< The actual expression + }; - // functions overriding virtual functions from base classes +// member functions + + // other constructors 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; + explicit symbol(const std::string & initname, unsigned domain = domain::complex); + symbol(const std::string & initname, const std::string & texname, unsigned domain = domain::complex); + symbol(const std::string & initname, unsigned rt, unsigned rtt, unsigned domain = domain::complex); + symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned rtt, unsigned domain = domain::complex); + + // functions overriding virtual functions from base classes +public: + bool info(unsigned inf) const; + ex eval(int level = 0) const; + 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; + unsigned return_type() const { return ret_type; } + unsigned return_type_tinfo() const { return ret_type_tinfo; } + ex conjugate() const; 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;} + void assign(const ex & value); + void unassign(); + void set_name(const std::string & n) { name = n; } + std::string get_name() const { return name; } + unsigned get_domain() const { return domain; } +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; private: - string & autoname_prefix(void); + std::string & autoname_prefix(); + std::string default_TeX_name() const; // member variables protected: - assigned_ex_info * asexinfop; - unsigned serial; //!< unique serial number for comparision - string name; + ptr asexinfop; ///< assigned expression, only for private use by ginsh + unsigned serial; ///< unique serial number for comparison + std::string name; ///< printname of this symbol + std::string TeX_name; ///< LaTeX name of this symbol + unsigned domain; ///< domain of symbol, complex (default) or real + unsigned ret_type; ///< value returned by return_type() + unsigned ret_type_tinfo; ///< value returned by return_type_tinfo() private: - static unsigned next_serial; + static unsigned next_serial; +}; + + +/** Specialization of symbol to real domain */ +class realsymbol : public symbol +{ + // constructors +public: + realsymbol(); + explicit realsymbol(const std::string & initname, unsigned domain = domain::real); + realsymbol(const std::string & initname, const std::string & texname, unsigned domain = domain::real); + realsymbol(const std::string & initname, unsigned rt, unsigned rtt, unsigned domain = domain::real); + realsymbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned rtt, unsigned domain = domain::real); }; -// global constants -extern const symbol some_symbol; -extern type_info const & typeid_symbol; +// utility functions -// macros +/** Specialization of is_exactly_a(obj) for symbol objects. */ +template<> inline bool is_exactly_a(const basic & obj) +{ + return obj.tinfo() == TINFO_symbol; +} -#define ex_to_symbol(X) static_cast(*(X).bp) +/** Specialization of is_exactly_a(obj) for realsymbol objects. */ +template<> inline bool is_exactly_a(const basic & obj) +{ + return (obj.tinfo() == TINFO_symbol) && (static_cast(obj).get_domain() == domain::real); +} // wrapper functions around member functions inline void unassign(symbol & symarg) -{ return symarg.unassign(); } - -inline int degree(symbol const & a, symbol const & s) -{ return a.degree(s); } +{ symarg.unassign(); } -inline int ldegree(symbol const & a, symbol const & s) -{ return a.ldegree(s); } +} // namespace GiNaC #endif // ndef __GINAC_SYMBOL_H__