X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fex.h;h=8ade899b06136f1479a982834547fae35503a3ba;hp=d22dc86a38aedeba4770a8a690e14028ff988525;hb=d508ca04e9c2f4ee103c9f21f33a98c87116df13;hpb=a8507b8af1c08d9b27d98d57f95c7ca1a8671e27

diff --git a/ginac/ex.h b/ginac/ex.h
index d22dc86a..8ade899b 100644
--- a/ginac/ex.h
+++ b/ginac/ex.h
@@ -1,8 +1,9 @@
 /** @file ex.h
  *
- *  Interface to GiNaC's light-weight expression handles.
- *
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  Interface to GiNaC's light-weight expression handles. */
+
+/*
+ *  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
@@ -22,261 +23,376 @@
 #ifndef __GINAC_EX_H__
 #define __GINAC_EX_H__
 
-#include <iostream>
+#include "basic.h"
+#include "operators.h"
+
+namespace GiNaC {
 
+// Sorry, this is the only constant to pollute the global scope, the other ones
+// are defined in utils.h and not visible from outside.
 class ex;
-class expand_options;
-class status_flags;
+extern const ex & _ex0(void);     ///<  single ex(numeric(0))
 
 class symbol;
 class lst;
+class scalar_products;
 
-typedef vector<ex> exvector;
-
-// enum definitions
-
-ex const & exZERO(void);
-ex const & exONE(void);
-ex const & exTWO(void);
-ex const & exTHREE(void);
-ex const & exMINUSONE(void);
-ex const & exHALF(void);
-ex const & exMINUSHALF(void);
-
-#define INLINE_EX_CONSTRUCTORS
-
-/** Lightweight interface to GiNaC's symbolic objects. Basically all it does is
+/** Lightweight wrapper for GiNaC's symbolic objects.  Basically all it does is
  *  to hold a pointer to the other objects, manage the reference counting and
- *  provide methods for manipulation of these objects. */
+ *  provide methods for manipulation of these objects.  (Some people call such
+ *  a thing a proxy class.) */
 class ex
 {
-    friend class basic;
-
+	friend class basic;
+	
 // member functions
-
-    // default constructor, destructor, copy constructor assignment operator and helpers
+	
+	// default ctor, dtor, copy ctor assignment operator and helpers
 public:
-    ex()
-#ifdef INLINE_EX_CONSTRUCTORS
-    : bp(exZERO().bp)
-        {
-            debugmsg("ex default constructor",LOGLEVEL_CONSTRUCT);
-            ASSERT(exZERO().bp!=0);
-            ASSERT(exZERO().bp->flags & status_flags::dynallocated);
-            ASSERT(bp!=0);
-            ++bp->refcount;
-        }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-
-    ~ex()
-#ifdef INLINE_EX_CONSTRUCTORS
-        {
-            debugmsg("ex destructor",LOGLEVEL_DESTRUCT);
-            ASSERT(bp!=0);
-            ASSERT(bp->flags & status_flags::dynallocated);
-            if (--bp->refcount == 0) {
-                delete bp;
-            }
-        }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-        
-    ex(ex const & other)
-#ifdef INLINE_EX_CONSTRUCTORS
-    : bp(other.bp)
-        {
-            debugmsg("ex copy constructor",LOGLEVEL_CONSTRUCT);
-            ASSERT(bp!=0);
-            ASSERT((bp->flags) & status_flags::dynallocated);
-            ++bp->refcount;
-        }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-        
-    ex const & operator=(ex const & other)
-#ifdef INLINE_EX_CONSTRUCTORS
-        {
-            debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT);
-            ASSERT(bp!=0);
-            ASSERT(bp->flags & status_flags::dynallocated);
-            ASSERT(other.bp!=0);
-            ASSERT(other.bp->flags & status_flags::dynallocated);
-            ++other.bp->refcount;
-            basic * tmpbp=other.bp;
-            if (--bp->refcount==0) {
-                delete bp;
-            }
-            bp=tmpbp;
-            return *this;
-        }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-
-    // other constructors
+	ex();
+	~ex();
+	ex(const ex & other);
+	const ex & operator=(const ex & other);
+	// other ctors
 public:
-    ex(basic const & other)
-#ifdef INLINE_EX_CONSTRUCTORS
-    {
-        debugmsg("ex constructor from basic",LOGLEVEL_CONSTRUCT);
-        construct_from_basic(other);
-    }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-    
-    ex(int const i);
-    ex(unsigned int const i);
-    ex(long const i);
-    ex(unsigned long const i);
-    ex(double const d);
-
-    // functions overriding virtual functions from bases classes
-    // none
-    
-    // new virtual functions which can be overridden by derived classes
-    // none
-
-    // non-virtual functions in this class
+	ex(const basic & other);
+	ex(int i);
+	ex(unsigned int i);
+	ex(long i);
+	ex(unsigned long i);
+	ex(double const d);
+	/** Construct ex from string and a list of symbols. The input grammar is
+	 *  similar to the GiNaC output format. All symbols to be used in the
+	 *  expression must be specified in a lst in the second argument. Undefined
+	 *  symbols and other parser errors will throw an exception. */
+	ex(const std::string &s, const ex &l);
+	
+	// functions overriding virtual functions from bases classes
+	// none
+	
+	// new virtual functions which can be overridden by derived classes
+	// none
+
+	// non-virtual functions in this class
 public:
-    void swap(ex & other);
-    void printraw(ostream & os) const;
-    void printtree(ostream & os, unsigned indent=0) const;
-    void print(ostream & os, unsigned upper_precedence=0) const;
-    void printcsrc(ostream & os, unsigned type, const char *var_name) const;
-    void dbgprint(void) const;
-    void dbgprinttree(void) const;
-    bool info(unsigned inf) const;
-    int nops() 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 lcoeff(symbol const & s) const { return coeff(s, degree(s)); }
-    ex tcoeff(symbol const & s) const { return coeff(s, ldegree(s)); }
-    ex numer(bool normalize = true) const;
-    ex denom(bool normalize = true) const;
-    ex unit(const symbol &x) const;
-    ex content(const symbol &x) const;
-    numeric integer_content(void) const;
-    ex primpart(const symbol &x) const;
-    ex primpart(const symbol &x, const ex &cont) const;
-    ex normal(int level = 0) const;
-    ex smod(const numeric &xi) const;
-    numeric max_coefficient(void) const;
-    ex collect(symbol const & s) const;
-    ex eval(int level = 0) const;
-    ex evalf(int level = 0) const;
-    ex diff(symbol const & s, unsigned nth = 1) const;
-    ex series(symbol const & s, ex const & point, int order = 6) const;
-    ex subs(lst const & ls, lst const & lr) const;
-    ex subs(ex const & e) const;
-    exvector get_indices(void) const;
-    ex simplify_ncmul(exvector const & v) const;
-    ex operator[](ex const & index) const;
-    ex operator[](int const i) const;
-    ex op(int const i) const;
-    ex & let_op(int const i);
-    int compare(ex const & other) const
-#ifdef INLINE_EX_CONSTRUCTORS
-        {
-            ASSERT(bp!=0);
-            ASSERT(other.bp!=0);
-            if (bp==other.bp) {
-                // special case: both expression point to same basic, trivially equal
-                return 0; 
-            }
-            return bp->compare(*other.bp);
-        }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-    bool is_equal(ex const & other) const
-#ifdef INLINE_EX_CONSTRUCTORS
-        {
-            ASSERT(bp!=0);
-            ASSERT(other.bp!=0);
-            if (bp==other.bp) {
-                // special case: both expression point to same basic, trivially equal
-                return true; 
-            }
-            return bp->is_equal(*other.bp);
-        }
-#else
-;
-#endif // def INLINE_EX_CONSTRUCTORS
-    bool is_zero(void) const {return compare(exZERO()) == 0;};
-        
-    unsigned return_type(void) const;
-    unsigned return_type_tinfo(void) const;
-    unsigned gethash(void) const;
-
-    ex exadd(ex const & rh) const;
-    ex exmul(ex const & rh) const;
-    ex exncmul(ex const & rh) const;
+	void swap(ex & other);
+	void print(const print_context & c, unsigned level = 0) const;
+	void printtree(std::ostream & os) const;
+	void dbgprint(void) const;
+	void dbgprinttree(void) const;
+	bool info(unsigned inf) const { return bp->info(inf); }
+	unsigned nops() const { return bp->nops(); }
+	ex expand(unsigned options=0) const;
+	bool has(const ex & other) const { return bp->has(other); }
+	int degree(const ex & s) const { return bp->degree(s); }
+	int ldegree(const ex & s) const { return bp->ldegree(s); }
+	ex coeff(const ex & s, int n = 1) const { return bp->coeff(s, n); }
+	ex lcoeff(const ex & s) const { return coeff(s, degree(s)); }
+	ex tcoeff(const ex & s) const { return coeff(s, ldegree(s)); }
+	ex numer(void) const;
+	ex denom(void) const;
+	ex unit(const symbol &x) const;
+	ex content(const symbol &x) const;
+	numeric integer_content(void) const;
+	ex primpart(const symbol &x) const;
+	ex primpart(const symbol &x, const ex &cont) const;
+	ex normal(int level = 0) const;
+	ex to_rational(lst &repl_lst) const;
+	ex smod(const numeric &xi) const;
+	numeric max_coefficient(void) const;
+	ex collect(const ex & s, bool distributed = false) const { return bp->collect(s, distributed); }
+	ex eval(int level = 0) const { return bp->eval(level); }
+	ex evalf(int level = 0) const { return bp->evalf(level); }
+	ex diff(const symbol & s, unsigned nth = 1) const;
+	ex series(const ex & r, int order, unsigned options = 0) const;
+	ex subs(const lst & ls, const lst & lr) const { return bp->subs(ls, lr); }
+	ex subs(const ex & e) const { return bp->subs(e); }
+	exvector get_free_indices(void) const { return bp->get_free_indices(); }
+	ex simplify_indexed(void) const;
+	ex simplify_indexed(const scalar_products & sp) const;
+	ex simplify_ncmul(const exvector & v) const { return bp->simplify_ncmul(v); }
+	ex operator[](const ex & index) const;
+	ex operator[](int i) const;
+	ex op(int i) const { return bp->op(i); }
+	ex & let_op(int i);
+	ex lhs(void) const;
+	ex rhs(void) const;
+	int compare(const ex & other) const;
+	bool is_equal(const ex & other) const;
+	bool is_zero(void) const { return is_equal(_ex0()); }
+	
+	unsigned return_type(void) const { return bp->return_type(); }
+	unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); }
+	unsigned gethash(void) const { return bp->gethash(); }
+	
+	ex exadd(const ex & rh) const;
+	ex exmul(const ex & rh) const;
 private:
-    void construct_from_basic(basic const & other);
-    void makewriteable();
+	void construct_from_basic(const basic & other);
+	void construct_from_int(int i);
+	void construct_from_uint(unsigned int i);
+	void construct_from_long(long i);
+	void construct_from_ulong(unsigned long i);
+	void construct_from_double(double d);
+	void construct_from_string_and_lst(const std::string &s, const ex &l);
+	void makewriteable();
+
+#ifdef OBSCURE_CINT_HACK
+public:
+	static bool last_created_or_assigned_bp_can_be_converted_to_ex(void)
+	{
+		if (last_created_or_assigned_bp==0) return false;
+		if ((last_created_or_assigned_bp->flags &
+			 status_flags::dynallocated)==0) return false;
+		if ((last_created_or_assigned_bp->flags &
+			 status_flags::evaluated)==0) return false;
+		return true;
+	}
+protected:
+	void update_last_created_or_assigned_bp(void)
+	{
+		if (last_created_or_assigned_bp!=0) {
+			if (--last_created_or_assigned_bp->refcount == 0) {
+				delete last_created_or_assigned_bp;
+			}
+		}
+		last_created_or_assigned_bp = bp;
+		++last_created_or_assigned_bp->refcount;
+		last_created_or_assigned_exp = (long)(void *)(this);
+	}
+#endif // def OBSCURE_CINT_HACK
 
 // member variables
 
 public:
-    basic *bp;
-
+	basic *bp;      ///< pointer to basic object managed by this
+#ifdef OBSCURE_CINT_HACK
+	static basic * last_created_or_assigned_bp;
+	static basic * dummy_bp;
+	static long last_created_or_assigned_exp;
+#endif // def OBSCURE_CINT_HACK
 };
 
+
+// performance-critical inlined method implementations
+
+inline
+ex::ex() : bp(_ex0().bp)
+{
+	/*debugmsg("ex default ctor",LOGLEVEL_CONSTRUCT);*/
+	GINAC_ASSERT(_ex0().bp!=0);
+	GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated);
+	GINAC_ASSERT(bp!=0);
+	++bp->refcount;
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::~ex()
+{
+	/*debugmsg("ex dtor",LOGLEVEL_DESTRUCT);*/
+	GINAC_ASSERT(bp!=0);
+	GINAC_ASSERT(bp->flags & status_flags::dynallocated);
+	if (--bp->refcount == 0)
+		delete bp;
+}
+
+inline
+ex::ex(const ex & other) : bp(other.bp)
+{
+	/*debugmsg("ex copy ctor",LOGLEVEL_CONSTRUCT);*/
+	GINAC_ASSERT(bp!=0);
+	GINAC_ASSERT((bp->flags) & status_flags::dynallocated);
+	++bp->refcount;
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+const ex & ex::operator=(const ex & other)
+{
+	/*debugmsg("ex operator=",LOGLEVEL_ASSIGNMENT);*/
+	GINAC_ASSERT(bp!=0);
+	GINAC_ASSERT(bp->flags & status_flags::dynallocated);
+	GINAC_ASSERT(other.bp!=0);
+	GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
+	if (--bp->refcount==0)
+		delete bp;
+	++other.bp->refcount;
+	bp = other.bp;
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+	return *this;
+}
+
+inline
+ex::ex(const basic & other)
+{
+	/*debugmsg("ex ctor from basic",LOGLEVEL_CONSTRUCT);*/
+	construct_from_basic(other);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::ex(int i)
+{
+	/*debugmsg("ex ctor from int",LOGLEVEL_CONSTRUCT);*/
+	construct_from_int(i);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::ex(unsigned int i)
+{
+	/*debugmsg("ex ctor from unsigned int",LOGLEVEL_CONSTRUCT);*/
+	construct_from_uint(i);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::ex(long i)
+{
+	/*debugmsg("ex ctor from long",LOGLEVEL_CONSTRUCT);*/
+	construct_from_long(i);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::ex(unsigned long i)
+{
+	/*debugmsg("ex ctor from unsigned long",LOGLEVEL_CONSTRUCT);*/
+	construct_from_ulong(i);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::ex(double const d)
+{
+	/*debugmsg("ex ctor from double",LOGLEVEL_CONSTRUCT);*/
+	construct_from_double(d);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+ex::ex(const std::string &s, const ex &l)
+{
+	/*debugmsg("ex ctor from string,lst",LOGLEVEL_CONSTRUCT);*/
+	construct_from_string_and_lst(s, l);
+#ifdef OBSCURE_CINT_HACK
+	update_last_created_or_assigned_bp();
+#endif // def OBSCURE_CINT_HACK
+}
+
+inline
+int ex::compare(const ex & other) const
+{
+	GINAC_ASSERT(bp!=0);
+	GINAC_ASSERT(other.bp!=0);
+	if (bp==other.bp)  // trivial case: both expressions point to same basic
+		return 0;
+	return bp->compare(*other.bp);
+}
+
+inline
+bool ex::is_equal(const ex & other) const
+{
+	GINAC_ASSERT(bp!=0);
+	GINAC_ASSERT(other.bp!=0);
+	if (bp==other.bp)  // trivial case: both expressions point to same basic
+		return true;
+	return bp->is_equal(*other.bp);
+}
+
+
+// utility functions
+inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
+{
+	return e1.bp == e2.bp;
+}
+
 // wrapper functions around member functions
-inline int nops(ex const & thisex)
+inline unsigned nops(const ex & thisex)
 { return thisex.nops(); }
 
-inline ex expand(ex const & thisex, unsigned options = 0)
+inline ex expand(const ex & thisex, unsigned options = 0)
 { return thisex.expand(options); }
 
-inline bool has(ex const & thisex, ex const & other)
+inline bool has(const ex & thisex, const ex & other)
 { return thisex.has(other); }
 
-inline int degree(ex const & thisex, symbol const & s)
+inline int degree(const ex & thisex, const ex & s)
 { return thisex.degree(s); }
 
-inline int ldegree(ex const & thisex, symbol const & s)
+inline int ldegree(const ex & thisex, const ex & s)
 { return thisex.ldegree(s); }
 
-inline ex coeff(ex const & thisex, symbol const & s, int const n=1)
+inline ex coeff(const ex & thisex, const ex & s, int n=1)
 { return thisex.coeff(s, n); }
 
-inline ex numer(ex const & thisex, bool normalize = true)
-{ return thisex.numer(normalize); }
+inline ex numer(const ex & thisex)
+{ return thisex.numer(); }
 
-inline ex denom(ex const & thisex, bool normalize = true)
-{ return thisex.denom(normalize); }
+inline ex denom(const ex & thisex)
+{ return thisex.denom(); }
 
-inline ex normal(ex const & thisex, int level=0)
+inline ex normal(const ex & thisex, int level=0)
 { return thisex.normal(level); }
 
-inline ex collect(ex const & thisex, symbol const & s)
-{ return thisex.collect(s); }
+inline ex to_rational(const ex & thisex, lst & repl_lst)
+{ return thisex.to_rational(repl_lst); }
+
+inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
+{ return thisex.collect(s, distributed); }
 
-inline ex eval(ex const & thisex, int level = 0)
+inline ex eval(const ex & thisex, int level = 0)
 { return thisex.eval(level); }
 
-inline ex evalf(ex const & thisex, int level = 0)
+inline ex evalf(const ex & thisex, int level = 0)
 { return thisex.evalf(level); }
 
-inline ex diff(ex const & thisex, symbol const & s, unsigned nth = 1)
+inline ex diff(const ex & thisex, const symbol & s, unsigned nth = 1)
 { return thisex.diff(s, nth); }
 
-inline ex subs(ex const & thisex, ex const & e)
+inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
+{ return thisex.series(r, order, options); }
+
+inline ex subs(const ex & thisex, const ex & e)
 { return thisex.subs(e); }
 
-inline ex subs(ex const & thisex, lst const & ls, lst const & lr)
+inline ex subs(const ex & thisex, const lst & ls, const lst & lr)
 { return thisex.subs(ls, lr); }
 
+inline ex op(const ex & thisex, int i)
+{ return thisex.op(i); }
+
+inline ex lhs(const ex & thisex)
+{ return thisex.lhs(); }
+
+inline ex rhs(const ex & thisex)
+{ return thisex.rhs(); }
+
+inline bool is_zero(const ex & thisex)
+{ return thisex.is_zero(); }
+
 inline void swap(ex & e1, ex & e2)
 { e1.swap(e2); }
 
+} // namespace GiNaC
+
 #endif // ndef __GINAC_EX_H__