* Interface to GiNaC's symbolic objects. */
/*
- * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ * 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
*
* 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__
#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
{
- 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
- };
-
+ GINAC_DECLARE_REGISTERED_CLASS(symbol, basic)
+
+ friend class realsymbol;
+ friend class possymbol;
+
// member functions
- // default ctor, dtor, copy ctor assignment operator and helpers
+ // other constructors
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
-public:
- explicit symbol(const std::string & initname);
- explicit symbol(const std::string & initname, const std::string & texname);
+ 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 print(const print_context & c, unsigned level = 0) const;
bool info(unsigned inf) const;
- int degree(const ex & s) const;
- int ldegree(const ex & s) const;
- ex coeff(const ex & 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 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:
ex derivative(const symbol & s) const;
- int compare_same_type(const basic & other) const;
bool is_equal_same_type(const basic & other) const;
- unsigned calchash(void) const;
+ unsigned calchash() const;
// non-virtual functions in this class
public:
- void assign(const ex & value);
- void unassign(void);
void set_name(const std::string & n) { name = n; }
- std::string get_name(void) const { return name; }
+ 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:
- std::string & autoname_prefix(void);
- std::string default_TeX_name(void) const;
+ std::string & autoname_prefix();
+ std::string default_TeX_name() 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
- std::string TeX_name; ///< LaTeX name of this symbol
+ 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;
};
-// utility functions
+/** 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);
+};
+
-/** Return the symbol object handled by an ex. Deprecated: use ex_to<symbol>().
- * This is unsafe: you need to check the type first. */
-inline const symbol &ex_to_symbol(const ex &e)
+/** Specialization of symbol to real domain */
+class possymbol : public symbol
{
- return static_cast<const symbol &>(*e.bp);
-}
+ // 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);
+};
-inline symbol &ex_to_nonconst_symbol(const ex &e)
+
+// utility functions
+
+/** Specialization of is_exactly_a<realsymbol>(obj) for realsymbol objects. */
+template<> inline bool is_exactly_a<realsymbol>(const basic & obj)
{
- return static_cast<symbol &>(*e.bp);
+ 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<symbol>(obj) for symbol objects. */
-template<> inline bool is_exactly_a<symbol>(const basic & obj)
+/** Specialization of is_exactly_a<possymbol>(obj) for possymbol objects. */
+template<> inline bool is_exactly_a<possymbol>(const basic & obj)
{
- return obj.tinfo()==TINFO_symbol;
+ if (!is_a<symbol>(obj))
+ return false;
+ unsigned domain = static_cast<const symbol &>(obj).get_domain();
+ return domain == domain::positive;
}
-// wrapper functions around member functions
-inline void unassign(symbol & symarg)
-{ symarg.unassign(); }
-
-inline int degree(const symbol & a, const ex & s)
-{ return a.degree(s); }
-
-inline int ldegree(const symbol & a, const ex & s)
-{ return a.ldegree(s); }
-
} // namespace GiNaC
#endif // ndef __GINAC_SYMBOL_H__
git://www.ginac.de / ginac.git / blobdiff