*
* Interface to GiNaC's symbolic objects. */
-#ifndef _SYMBOL_H_
-#define _SYMBOL_H_
-
-#include <string>
+/*
+ * GiNaC Copyright (C) 1999-2008 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
-class symbol;
+#ifndef __GINAC_SYMBOL_H__
+#define __GINAC_SYMBOL_H__
+#include <string>
+#include <typeinfo>
#include "basic.h"
#include "ex.h"
+#include "ptr.h"
+
+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
{
-// 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);
+ friend class realsymbol;
+ friend class possymbol;
- // 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, unsigned domain = domain::complex);
+ symbol(const std::string & initname, const std::string & texname, unsigned domain = domain::complex);
+
+ // 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;
+ bool info(unsigned inf) 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 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;
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 set_name(const std::string & n) { name = n; }
+ std::string get_name() const { return name; }
+ unsigned get_domain() const { return domain; }
+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;
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;
+ unsigned serial; ///< unique serial number for comparison
+ std::string name; ///< printname of this symbol
+ std::string TeX_name; ///< LaTeX name of this symbol
+ unsigned domain; ///< domain of symbol, complex (default) or real
private:
- static unsigned next_serial;
+ static unsigned next_serial;
};
-// global constants
-extern const symbol some_symbol;
-extern type_info const & typeid_symbol;
+/** Specialization of symbol to real domain */
+class realsymbol : public symbol
+{
+ // constructors
+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);
+};
-// macros
-#define ex_to_symbol(X) static_cast<symbol const &>(*(X).bp)
+/** 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);
+};
+
-// wrapper functions around member functions
-inline void unassign(symbol & symarg)
-{ return symarg.unassign(); }
+// utility functions
-inline int degree(symbol const & a, symbol const & s)
-{ return a.degree(s); }
+/** Specialization of is_exactly_a<realsymbol>(obj) for realsymbol objects. */
+template<> inline bool is_exactly_a<realsymbol>(const basic & obj)
+{
+ if (!is_a<symbol>(obj))
+ return false;
+ unsigned domain = static_cast<const symbol &>(obj).get_domain();
+ return domain==domain::real || domain==domain::positive;
+}
+
+/** Specialization of is_exactly_a<possymbol>(obj) for possymbol objects. */
+template<> inline bool is_exactly_a<possymbol>(const basic & obj)
+{
+ if (!is_a<symbol>(obj))
+ return false;
+ unsigned domain = static_cast<const symbol &>(obj).get_domain();
+ return domain == domain::positive;
+}
-inline int ldegree(symbol const & a, symbol const & s)
-{ return a.ldegree(s); }
+} // namespace GiNaC
-#endif // ndef _SYMBOL_H_
+#endif // ndef __GINAC_SYMBOL_H__
git://www.ginac.de / ginac.git / blobdiff