/** @file symbol.h
*
- * Interface to GiNaC's symbolic objects.
- *
- * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ * Interface to GiNaC's symbolic objects. */
+
+/*
+ * GiNaC Copyright (C) 1999-2001 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
#define __GINAC_SYMBOL_H__
#include <string>
+#include "basic.h"
+#include "ex.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
* first place. */
class symbol : public basic
{
+ GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(symbol, 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!
- };
-
+
+ /** 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
+ };
+
// member functions
-
- // default constructor, destructor, copy constructor assignment operator and helpers
+
+ // default ctor, dtor, copy ctor assignment operator and helpers
public:
- symbol();
- ~symbol();
- symbol(symbol const & other);
+ symbol();
+ ~symbol()
+ {
+ /*debugmsg("symbol dtor", LOGLEVEL_DESTRUCT);*/
+ destroy(false);
+ }
+ symbol(const symbol & other);
protected:
- void copy(symbol const & other);
- void destroy(bool call_parent);
-
- // other constructors
+ void copy(const symbol & other);
+ void destroy(bool call_parent);
+
+ // other ctors
public:
- explicit symbol(string const & initname);
-
- // functions overriding virtual functions from base classes
+ 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 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;
+ basic * duplicate() 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 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 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;
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;
+ 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;
+
+ // 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 assign(const ex & value);
+ void unassign(void);
+ void set_name(const std::string & n) { name = n; }
+ std::string get_name(void) const { return name; }
private:
- string & autoname_prefix(void);
+ std::string & autoname_prefix(void);
+ std::string default_TeX_name(void) const;
// member variables
protected:
- assigned_ex_info * asexinfop;
- unsigned serial; //!< unique serial number for comparision
- string name;
+ 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
private:
- static unsigned next_serial;
+ static unsigned next_serial;
};
-// global constants
-
-extern const symbol some_symbol;
-extern type_info const & typeid_symbol;
-// macros
+// utility functions
+inline const symbol &ex_to_symbol(const ex &e)
+{
+ return static_cast<const symbol &>(*e.bp);
+}
-#define ex_to_symbol(X) static_cast<symbol const &>(*(X).bp)
// wrapper functions around member functions
inline void unassign(symbol & symarg)
-{ return symarg.unassign(); }
+{ symarg.unassign(); }
-inline int degree(symbol const & a, symbol const & s)
+inline int degree(const symbol & a, const ex & s)
{ return a.degree(s); }
-inline int ldegree(symbol const & a, symbol const & 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