normal() uses an additional reverse lookup map
[ginac.git] / ginac / symbol.h
index 9905f3c861efe501dd2a365ed795f98bbf36427a..55f2826ccc8073c2749b9cee6db1e6a18770c20a 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's symbolic objects. */
 
 /*
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 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
@@ -24,8 +24,9 @@
 #define __GINAC_SYMBOL_H__
 
 #include <string>
-#include <ginac/basic.h>
-#include <ginac/ex.h>
+#include "basic.h"
+#include "ex.h"
+#include "ptr.h"
 
 namespace GiNaC {
 
@@ -37,94 +38,82 @@ namespace GiNaC {
  *  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);
+// types
+       
+       /** Symbols as keys to expressions - only for ginsh. */
+       class assigned_ex_info {
+               friend class ptr<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
+       private:
+               size_t refcount;        ///< Reference counter, managed by ptr<assigned_ex_info>
+       };
 
-    // other constructors
+// member functions
+       
+       // other constructors
 public:
-    explicit symbol(string const & initname);
-
-    // functions overriding virtual functions from base classes
+       explicit symbol(const std::string & initname);
+       explicit symbol(const std::string & initname, const std::string & texname);
+       
+       // 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;
+       void print(const print_context & c, unsigned level = 0) const;
+       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(lst &repl_lst) const;
+       ex to_polynomial(lst &repl_lst) 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; }
 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<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
 private:
-    static unsigned next_serial;
+       static unsigned next_serial;
 };
 
-// global constants
-
-extern const symbol some_symbol;
-extern type_info const & typeid_symbol;
 
 // utility functions
-inline const symbol &ex_to_symbol(const ex &e)
+
+/** Specialization of is_exactly_a<symbol>(obj) for symbol objects. */
+template<> inline bool is_exactly_a<symbol>(const basic & obj)
 {
-       return static_cast<const symbol &>(*e.bp);
+       return obj.tinfo()==TINFO_symbol;
 }
 
 // wrapper functions around member functions
 inline void unassign(symbol & symarg)
-{ return symarg.unassign(); }
+{ symarg.unassign(); }
 
-inline int degree(symbol const & a, symbol const & s)
+inline int degree(const symbol & a, const ex & s)
 { return a.degree(s); }
 
-inline int ldegree(symbol const & a, symbol const & s)
+inline int ldegree(const symbol & a, const ex & s)
 { return a.ldegree(s); }
 
 } // namespace GiNaC