Made class possymbol for positive symbols and documented it.

[ginac.git] / ginac / symbol.h

diff --git a/ginac/symbol.h b/ginac/symbol.h
index 3231e73b7f49394af11a061b49df6f6f32e83188..2a5ae5cc57c0f72a1af29362c3ce4d4b62960b92 100644 (file)
--- a/ginac/symbol.h
+++ b/ginac/symbol.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's symbolic objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2006 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
@@ -17,7 +17,7 @@
  *
  *  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__
@@ -41,6 +41,7 @@ class symbol : public basic
        GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
 
        friend class realsymbol;
+       friend class possymbol;
 
 // types
        
@@ -58,8 +59,9 @@ class symbol : public basic
 public:
        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);
+       symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned domain);
+       symbol(const std::string & initname, unsigned rt, tinfo_t rtt, unsigned domain = domain::complex);
+       symbol(const std::string & initname, const std::string & texname, unsigned rt, tinfo_t rtt, unsigned domain = domain::complex);
        
        // functions overriding virtual functions from base classes
 public:
@@ -72,8 +74,11 @@ public:
        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; }
+       tinfo_t return_type_tinfo() const { return ret_type_tinfo; }
        ex conjugate() const;
+       ex real_part() const;
+       ex imag_part() const;
+       bool is_polynomial(const ex & var) const;
 protected:
        ex derivative(const symbol & s) const;
        bool is_equal_same_type(const basic & other) const;
@@ -104,7 +109,7 @@ protected:
        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()
+       tinfo_t ret_type_tinfo;         ///< value returned by return_type_tinfo()
 private:
        static unsigned next_serial;
 };
@@ -118,23 +123,42 @@ 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);
+       realsymbol(const std::string & initname, unsigned rt, tinfo_t rtt, unsigned domain = domain::real);
+       realsymbol(const std::string & initname, const std::string & texname, unsigned rt, tinfo_t rtt, unsigned domain = domain::real);
+};
+
+
+/** Specialization of symbol to real domain */
+class possymbol : public symbol
+{
+       // constructors
+public:
+       possymbol();
+       explicit possymbol(const std::string & initname, unsigned domain = domain::positive);
+       possymbol(const std::string & initname, const std::string & texname, unsigned domain = domain::positive);
+       possymbol(const std::string & initname, unsigned rt, tinfo_t rtt, unsigned domain = domain::positive);
+       possymbol(const std::string & initname, const std::string & texname, unsigned rt, tinfo_t rtt, unsigned domain = domain::positive);
 };
 
 
 // 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<realsymbol>(obj) for realsymbol objects. */
+template<> inline bool is_exactly_a<realsymbol>(const basic & obj)
 {
-       return obj.tinfo() == TINFO_symbol;
+       if (obj.tinfo() != &symbol::tinfo_static)
+               return false;
+       unsigned domain = static_cast<const symbol &>(obj).get_domain();
+       return domain==domain::real || domain==domain::positive;
 }
 
-/** Specialization of is_exactly_a<realsymbol>(obj) for realsymbol objects. */
-template<> inline bool is_exactly_a<realsymbol>(const basic & obj)
+/** Specialization of is_exactly_a<possymbol>(obj) for possymbol objects. */
+template<> inline bool is_exactly_a<possymbol>(const basic & obj)
 {
-       return (obj.tinfo() == TINFO_symbol) && (static_cast<const symbol &>(obj).get_domain() == domain::real);
+       if (obj.tinfo() != &symbol::tinfo_static)
+               return false;
+       unsigned domain = static_cast<const symbol &>(obj).get_domain();
+       return domain == domain::positive;
 }
 
 // wrapper functions around member functions