* Interface to GiNaC's symbolic objects. */
/*
- * GiNaC Copyright (C) 1999-2006 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2015 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
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef __GINAC_SYMBOL_H__
-#define __GINAC_SYMBOL_H__
+#ifndef GINAC_SYMBOL_H
+#define GINAC_SYMBOL_H
-#include <string>
#include "basic.h"
#include "ex.h"
#include "ptr.h"
+#include "archive.h"
+
+#include <string>
+#include <typeinfo>
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(symbol, basic)
-
- friend class realsymbol;
-
-// types
-
- /** Symbols as keys to expressions - only for ginsh. */
- class assigned_ex_info : public refcounted {
- public:
- assigned_ex_info() throw(); ///< Default ctor
- bool is_assigned; ///< True if there is an expression assigned
- ex assigned_expression; ///< The actual expression
- };
-
-// member functions
-
// other constructors
public:
- explicit symbol(const std::string & initname, unsigned domain = domain::complex);
- symbol(const std::string & initname, unsigned rt, unsigned domain);
- symbol(const std::string & initname, const std::string & texname, unsigned domain = domain::complex);
- symbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned domain);
+ explicit symbol(const std::string & initname);
+ symbol(const std::string & initname, const std::string & texname);
// functions overriding virtual functions from base classes
public:
- 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(exmap & repl) const;
- ex to_polynomial(exmap & repl) const;
- unsigned return_type() const { return ret_type; }
- ex conjugate() const;
+ bool info(unsigned inf) const override;
+ ex eval() const override { return *this; } // for performance reasons
+ ex evalf(int level = 0) const override { return *this; } // overwrites basic::evalf() for performance reasons
+ ex series(const relational & s, int order, unsigned options = 0) const override;
+ ex subs(const exmap & m, unsigned options = 0) const override { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
+ ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const override;
+ ex to_rational(exmap & repl) const override;
+ ex to_polynomial(exmap & repl) const override;
+ ex conjugate() const override;
+ ex real_part() const override;
+ ex imag_part() const override;
+ bool is_polynomial(const ex & var) const override;
+ /** Save (a.k.a. serialize) object into archive. */
+ void archive(archive_node& n) const override;
+ /** Read (a.k.a. deserialize) object from archive. */
+ void read_archive(const archive_node& n, lst& syms) override;
protected:
- ex derivative(const symbol & s) const;
- bool is_equal_same_type(const basic & other) const;
- unsigned calchash() const;
+ ex derivative(const symbol & s) const override;
+ bool is_equal_same_type(const basic & other) const override;
+ unsigned calchash() const override;
+
+ // new virtual functions which can be overridden by derived classes
+public:
+ virtual unsigned get_domain() const { return domain::complex; }
// non-virtual functions in this class
public:
- void assign(const ex & value);
- void unassign();
void set_name(const std::string & n) { name = n; }
- std::string get_name() const { return name; }
- unsigned get_domain() const { return domain; }
+ void set_TeX_name(const std::string & n) { TeX_name = n; }
+ std::string get_name() const;
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();
- std::string default_TeX_name() const;
// member variables
protected:
- 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
+ mutable 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
- unsigned ret_type; ///< value returned by return_type()
private:
static unsigned next_serial;
};
+GINAC_DECLARE_UNARCHIVER(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);
- realsymbol(const std::string & initname, unsigned rt, unsigned domain = domain::real);
- realsymbol(const std::string & initname, const std::string & texname, unsigned rt, unsigned domain = domain::real);
-};
+ explicit realsymbol(const std::string & initname);
+ realsymbol(const std::string & initname, const std::string & texname);
+ unsigned get_domain() const override { return domain::real; }
-// utility functions
+ ex conjugate() const override { return *this; }
+ ex real_part() const override { return *this; }
+ ex imag_part() const override { return 0; }
-/** Specialization of is_exactly_a<realsymbol>(obj) for realsymbol objects. */
-template<> inline bool is_exactly_a<realsymbol>(const basic & obj)
-{
- return (obj.tinfo() == &symbol::tinfo_static) && (static_cast<const symbol &>(obj).get_domain() == domain::real);
-}
+ realsymbol* duplicate() const override
+ {
+ realsymbol * bp = new realsymbol(*this);
+ bp->setflag(status_flags::dynallocated);
+ return bp;
+ }
+};
+GINAC_DECLARE_UNARCHIVER(realsymbol);
-// wrapper functions around member functions
-inline void unassign(symbol & symarg)
-{ symarg.unassign(); }
+
+/** Specialization of symbol to real positive domain */
+class possymbol : public realsymbol
+{
+public:
+ possymbol();
+ explicit possymbol(const std::string & initname);
+ possymbol(const std::string & initname, const std::string & texname);
+
+ unsigned get_domain() const override { return domain::positive; }
+
+ possymbol* duplicate() const override
+ {
+ possymbol * bp = new possymbol(*this);
+ bp->setflag(status_flags::dynallocated);
+ return bp;
+ }
+};
+GINAC_DECLARE_UNARCHIVER(possymbol);
} // namespace GiNaC
-#endif // ndef __GINAC_SYMBOL_H__
+#endif // ndef GINAC_SYMBOL_H