fixed is_exactly_a<symbol>
[ginac.git] / ginac / symbol.h
index 76b87720b02b1f9a1dec31870b38c518784e55ea..51164a972de73971d7f51b99d08f5a6800bbb626 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's symbolic objects. */
 
 /*
  *  Interface to GiNaC's symbolic objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  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
  *
  *  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
@@ -26,6 +26,7 @@
 #include <string>
 #include "basic.h"
 #include "ex.h"
 #include <string>
 #include "basic.h"
 #include "ex.h"
+#include "ptr.h"
 
 namespace GiNaC {
 
 
 namespace GiNaC {
 
@@ -37,113 +38,109 @@ namespace GiNaC {
  *  first place. */
 class symbol : public basic
 {
  *  first place. */
 class symbol : public basic
 {
-       GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(symbol, basic)
-       
+       GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
+
+       friend class realsymbol;
+
 // types
        
 // types
        
-       /** Symbols as keys to expressions - this is deprecated. */
-       class assigned_ex_info {
+       /** Symbols as keys to expressions - only for ginsh. */
+       class assigned_ex_info : public refcounted {
        public:
        public:
-               assigned_ex_info();     ///< Default ctor
-               bool is_assigned;       ///< True if there is an expression assigned
-               ex assigned_expression; ///< The actual expression
-               unsigned refcount;      ///< Reference counter
+               assigned_ex_info() throw();  ///< Default ctor
+               bool is_assigned;            ///< True if there is an expression assigned
+               ex assigned_expression;      ///< The actual expression
        };
        };
-       
+
 // member functions
        
 // member functions
        
-       // default ctor, dtor, copy ctor assignment operator and helpers
-public:
-       symbol();
-       ~symbol()
-       {
-               /*debugmsg("symbol dtor", LOGLEVEL_DESTRUCT);*/
-               destroy(false);
-       }
-       symbol(const symbol & other);
-protected:
-       void copy(const symbol & other); 
-       void destroy(bool call_parent);
-       
-       // other ctors
+       // other constructors
 public:
 public:
-       explicit symbol(const std::string & initname);
-       explicit symbol(const std::string & initname, const std::string & texname);
+       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:
        
        // functions overriding virtual functions from base classes
 public:
-       basic * duplicate() const;
-       void print(const print_context & c, unsigned level = 0) const;
        bool info(unsigned inf) const;
        bool info(unsigned inf) const;
-       bool has(const ex & other) const;
-       int degree(const ex & s) const;
-       int ldegree(const ex & s) const;
-       ex coeff(const ex & s, int n = 1) 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 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 normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
-       ex to_rational(lst &repl_lst) 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:
        ex derivative(const symbol & s) const;
 protected:
        ex derivative(const symbol & s) const;
-       int compare_same_type(const basic & other) const;
        bool is_equal_same_type(const basic & other) const;
        bool is_equal_same_type(const basic & other) const;
-       unsigned return_type(void) const;
-       unsigned return_type_tinfo(void) const;
-       unsigned calchash(void) const;
+       unsigned calchash() const;
        
        // non-virtual functions in this class
 public:
        void assign(const ex & value);
        
        // non-virtual functions in this class
 public:
        void assign(const ex & value);
-       void unassign(void);
+       void unassign();
        void set_name(const std::string & n) { name = n; }
        void set_name(const std::string & n) { name = n; }
-       std::string get_name(void) const { return name; }
+       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:
 private:
-       std::string & autoname_prefix(void);
-       std::string default_TeX_name(void) const;
+       std::string & autoname_prefix();
+       std::string default_TeX_name() const;
 
 // member variables
 
 protected:
 
 // member variables
 
 protected:
-       assigned_ex_info * asexinfop;   ///< ptr to assigned expression, deprecated
-       unsigned serial;       ///< unique serial number for comparison
-       std::string name;      ///< printname of this symbol
-       std::string TeX_name;  ///< LaTeX name of this symbol
+       ptr<assigned_ex_info> 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;
 };
 
 
 private:
        static unsigned next_serial;
 };
 
 
-// utility functions
-
-/** Return the symbol object handled by an ex.  Deprecated: use ex_to<symbol>().
- *  This is unsafe: you need to check the type first. */
-inline const symbol &ex_to_symbol(const ex &e)
+/** Specialization of symbol to real domain */
+class realsymbol : public symbol
 {
 {
-       return static_cast<const symbol &>(*e.bp);
-}
+       // 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);
+};
 
 
-inline symbol &ex_to_nonconst_symbol(const ex &e)
-{
-       return static_cast<symbol &>(*e.bp);
-}
+
+// utility functions
 
 /** Specialization of is_exactly_a<symbol>(obj) for symbol objects. */
 template<> inline bool is_exactly_a<symbol>(const basic & obj)
 {
 
 /** Specialization of is_exactly_a<symbol>(obj) for symbol objects. */
 template<> inline bool is_exactly_a<symbol>(const basic & obj)
 {
-       return obj.tinfo()==TINFO_symbol;
+       return obj.tinfo() == TINFO_symbol;
+}
+
+/** Specialization of is_exactly_a<realsymbol>(obj) for realsymbol objects. */
+template<> inline bool is_exactly_a<realsymbol>(const basic & obj)
+{
+       return (obj.tinfo() == TINFO_symbol) && (static_cast<const symbol &>(obj).get_domain() == domain::real);
 }
 
 // wrapper functions around member functions
 inline void unassign(symbol & symarg)
 { symarg.unassign(); }
 
 }
 
 // wrapper functions around member functions
 inline void unassign(symbol & symarg)
 { symarg.unassign(); }
 
-inline int degree(const symbol & a, const ex & s)
-{ return a.degree(s); }
-
-inline int ldegree(const symbol & a, const ex & s)
-{ return a.ldegree(s); }
-
 } // namespace GiNaC
 
 #endif // ndef __GINAC_SYMBOL_H__
 } // namespace GiNaC
 
 #endif // ndef __GINAC_SYMBOL_H__