normal() uses an additional reverse lookup map
[ginac.git] / ginac / symbol.h
index 21b7e41122d16dad954e1fd3c6ed85f8f4039d7f..55f2826ccc8073c2749b9cee6db1e6a18770c20a 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-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
 #include <string>
 #include "basic.h"
 #include "ex.h"
+#include "ptr.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_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
@@ -39,97 +38,84 @@ namespace GiNaC {
  *  first place. */
 class symbol : public basic
 {
-       GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(symbol, basic)
+       GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
 
 // types
-
-       /** Symbols as keys to expressions. */
+       
+       /** 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
-               unsigned refcount;      //!< Yet another refcounter. PLEASE EXPLAIN!
+               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>
        };
-       
-// member functions
-
-       // default constructor, destructor, copy constructor assignment operator and helpers
-public:
-       symbol();
-       ~symbol();
-       symbol(const symbol & other);
-protected:
-       void copy(const symbol & other); 
-       void destroy(bool call_parent);
 
+// member functions
+       
        // other constructors
 public:
        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 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;
+       void print(const print_context & c, unsigned level = 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 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 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 subs(const lst & ls, const lst & lr) const;
+       ex to_polynomial(lst &repl_lst) 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;
-       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; }
+       void unassign();
+       void set_name(const std::string & n) { name = n; }
+       std::string get_name() const { return name; }
 private:
-       std::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
-       std::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;
 };
 
+
 // 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)
 { symarg.unassign(); }
 
-inline int degree(const symbol & a, const symbol & s)
+inline int degree(const symbol & a, const ex & s)
 { return a.degree(s); }
 
-inline int ldegree(const symbol & a, const symbol & s)
+inline int ldegree(const symbol & a, const ex & s)
 { return a.ldegree(s); }
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC
 
 #endif // ndef __GINAC_SYMBOL_H__