ginac/symbol.h

   1 /** @file symbol.h
   2  *
   3  *  Interface to GiNaC's symbolic objects. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_SYMBOL_H__
  24 #define __GINAC_SYMBOL_H__
  25
  26 #include <string>
  27 #include "basic.h"
  28 #include "ex.h"
  29 #include "ptr.h"
  30
  31 namespace GiNaC {
  32
  33 /** Basic CAS symbol.  It has a name because it must know how to output itself.
  34  *  It may be assigned an expression, but this feature is only intended for
  35  *  programs like 'ginsh' that want to associate symbols with expressions.
  36  *  If you want to replace symbols by expressions in your code, you should
  37  *  use ex::subs() or use objects of class ex instead of class symbol in the
  38  *  first place. */
  39 class symbol : public basic
  40 {
  41         GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
  42
  43 // types
  44
  45         /** Symbols as keys to expressions - only for ginsh. */
  46         class assigned_ex_info {
  47                 friend class ptr<assigned_ex_info>;
  48         public:
  49                 assigned_ex_info() throw();  ///< Default ctor
  50                 bool is_assigned;            ///< True if there is an expression assigned
  51                 ex assigned_expression;      ///< The actual expression
  52         private:
  53                 size_t refcount;             ///< Reference counter, managed by ptr<assigned_ex_info>
  54         };
  55
  56 // member functions
  57
  58         // other constructors
  59 public:
  60         explicit symbol(const std::string & initname);
  61         symbol(const std::string & initname, const std::string & texname);
  62         symbol(const std::string & initname, unsigned rt, unsigned rtt);
  63         symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned rtt);
  64
  65         // functions overriding virtual functions from base classes
  66 public:
  67         bool info(unsigned inf) const;
  68         ex eval(int level = 0) const;
  69         ex evalf(int level = 0) const { return *this; } // overwrites basic::evalf() for performance reasons
  70         ex series(const relational & s, int order, unsigned options = 0) const;
  71         ex subs(const exmap & m, unsigned options = 0) const { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
  72         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
  73         ex to_rational(lst &repl_lst) const;
  74         ex to_polynomial(lst &repl_lst) const;
  75         unsigned return_type() const { return ret_type; }
  76         unsigned return_type_tinfo() const { return ret_type_tinfo; }
  77 protected:
  78         ex derivative(const symbol & s) const;
  79         bool is_equal_same_type(const basic & other) const;
  80         unsigned calchash() const;
  81
  82         // non-virtual functions in this class
  83 public:
  84         void assign(const ex & value);
  85         void unassign();
  86         void set_name(const std::string & n) { name = n; }
  87         std::string get_name() const { return name; }
  88 protected:
  89         void do_print(const print_context & c, unsigned level) const;
  90         void do_print_latex(const print_latex & c, unsigned level) const;
  91         void do_print_tree(const print_tree & c, unsigned level) const;
  92         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
  93 private:
  94         std::string & autoname_prefix();
  95         std::string default_TeX_name() const;
  96
  97 // member variables
  98
  99 protected:
 100         ptr<assigned_ex_info> asexinfop; ///< assigned expression, only for private use by ginsh
 101         unsigned serial;                 ///< unique serial number for comparison
 102         std::string name;                ///< printname of this symbol
 103         std::string TeX_name;            ///< LaTeX name of this symbol
 104         unsigned ret_type;               ///< value returned by return_type()
 105         unsigned ret_type_tinfo;         ///< value returned by return_type_tinfo()
 106 private:
 107         static unsigned next_serial;
 108 };
 109
 110
 111 // utility functions
 112
 113 /** Specialization of is_exactly_a<symbol>(obj) for symbol objects. */
 114 template<> inline bool is_exactly_a<symbol>(const basic & obj)
 115 {
 116         return obj.tinfo()==TINFO_symbol;
 117 }
 118
 119 // wrapper functions around member functions
 120 inline void unassign(symbol & symarg)
 121 { symarg.unassign(); }
 122
 123 } // namespace GiNaC
 124
 125 #endif // ndef __GINAC_SYMBOL_H__