]> www.ginac.de Git - ginac.git/blobdiff - ginac/symbol.h
Add support for Texinfo-5.0.
[ginac.git] / ginac / symbol.h
index 425f85b953d427685b20975d2e74337b569f8671..519980f857dcededb579715ee1dbd9ff96ce3dac 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's symbolic objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  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
  *
  *  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 <string>
 #include "basic.h"
 #include "ex.h"
+#include "ptr.h"
+#include "archive.h"
+
+#include <string>
+#include <typeinfo>
 
 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
 {
-       GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(symbol, basic)
-       
-// types
-       
-       /** Symbols as keys to expressions - this is deprecated. */
-       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;      ///< Reference counter
-       };
-       
-// 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
+       GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
+       // other constructors
 public:
        explicit symbol(const std::string & initname);
+       symbol(const std::string & initname, const std::string & texname);
        
        // functions overriding virtual functions from base classes
 public:
-       basic * duplicate() const;
-       void print(std::ostream & os, unsigned upper_precedence = 0) const;
-       void printraw(std::ostream & os) const;
-       void printtree(std::ostream & os, unsigned indent) const;
-       void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence = 0) const;
        bool info(unsigned inf) const;
-       ex expand(unsigned options = 0) const;
-       bool has(const ex & other) const;
-       int degree(const symbol & s) const;
-       int ldegree(const symbol & s) const;
-       ex coeff(const symbol & s, int n = 1) const;
-       ex eval(int level = 0) 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 normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
-       ex to_rational(lst &repl_lst) const;
-       ex subs(const lst & ls, const lst & lr) 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:
        ex derivative(const symbol & s) const;
-       int compare_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);
-       void unassign(void);
-       void setname(const std::string & n) { name = n; }
-       std::string getname(void) const { return name; }
-private:
-       std::string & autoname_prefix(void);
+       void set_name(const std::string & n) { name = n; }
+       void set_TeX_name(const std::string & n) { TeX_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;   ///< ptr to assigned expression, deprecated
-       unsigned serial;    ///< unique serial number for comparison
-       std::string name;   ///< printname of this symbol
+       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;
 };
+GINAC_DECLARE_UNARCHIVER(symbol);
 
 
-// utility functions
-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);
-}
+public:
+       realsymbol();
+       explicit realsymbol(const std::string & initname);
+       realsymbol(const std::string & initname, const std::string & texname);
+
+       unsigned get_domain() const { return domain::real; }
+
+       ex conjugate() const { return *this; }
+       ex real_part() const { return *this; }
+       ex imag_part() const { return 0; }
 
+       realsymbol* duplicate() const { return new realsymbol(*this); }
+};
+GINAC_DECLARE_UNARCHIVER(realsymbol);
 
-// wrapper functions around member functions
-inline void unassign(symbol & symarg)
-{ symarg.unassign(); }
 
-inline int degree(const symbol & a, const symbol & s)
-{ return a.degree(s); }
+/** 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 ldegree(const symbol & a, const symbol & s)
-{ return a.ldegree(s); }
+       unsigned get_domain() const { return domain::positive; }
+
+       possymbol* duplicate() const { return new possymbol(*this); }
+};
+GINAC_DECLARE_UNARCHIVER(possymbol);
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_SYMBOL_H__
+#endif // ndef GINAC_SYMBOL_H