- prepared for 1.0.13 release
[ginac.git] / ginac / ex.h
index aefb6af..208151d 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's light-weight expression handles. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 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
 #ifndef __GINAC_EX_H__
 #define __GINAC_EX_H__
 
+#include <iosfwd>
+#include <functional>
+
 #include "basic.h"
 #include "operators.h"
 
-#include <functional>
-
 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;
-extern const ex & _ex0(void);     ///<  single ex(numeric(0))
+/** Helper class to initialize the library.  There must be one static object
+ *  of this class in every object file that makes use of our flyweights in
+ *  order to guarantee proper initialization.  Hence we put it into this
+ *  file which is included by every relevant file anyways.  This is modeled
+ *  after section 27.4.2.1.6 of the C++ standard, where cout and friends are
+ *  set up.
+ *
+ *  @see utils.cpp */
+class library_init {
+public:
+       library_init();
+       ~library_init();
+private:
+       static int count;
+};
+/** For construction of flyweights, etc. */
+static library_init library_initializer;
+
+// Current versions of Cint don't link data declared extern within functions.
+// FIXME: Fix Cint and later remove this from here.
+#if defined(G__CINTVERSION)
+extern const class numeric *_num0_p;
+#endif
+
 
 class symbol;
 class lst;
@@ -46,11 +67,15 @@ class scalar_products;
  *  a thing a proxy class.) */
 class ex
 {
-       friend class basic;
+       friend class archive_node;
+       friend bool are_ex_trivially_equal(const ex &, const ex &);
+       template<class T> friend const T &ex_to(const ex &);
+       template<class T> friend bool is_a(const ex &);
+       template<class T> friend bool is_exactly_a(const ex &);
        
 // member functions
        
-       // default ctor, dtor, copy ctor assignment operator and helpers
+       // default ctor, dtor, copy ctor, assignment operator and helpers
 public:
        ex();
        ~ex();
@@ -64,15 +89,28 @@ public:
        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. */
+        *  similar to the GiNaC output format. All symbols and indices 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);
        
        // non-virtual functions in this class
 public:
-       void swap(ex & other);
+       /** Efficiently swap the contents of two expressions. */
+       void swap(ex & other)
+       {
+               GINAC_ASSERT(bp!=0);
+               GINAC_ASSERT(bp->flags & status_flags::dynallocated);
+               GINAC_ASSERT(other.bp!=0);
+               GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
+       
+               basic * tmpbp = bp;
+               bp = other.bp;
+               other.bp = tmpbp;
+       }
+
        void print(const print_context & c, unsigned level = 0) const;
        void printtree(std::ostream & os) const;
        void dbgprint(void) const;
@@ -129,7 +167,7 @@ public:
        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()); }
+       bool is_zero(void) const { extern const ex _ex0; return is_equal(_ex0); }
        
        unsigned return_type(void) const { return bp->return_type(); }
        unsigned return_type_tinfo(void) const { return bp->return_type_tinfo(); }
@@ -172,7 +210,7 @@ protected:
 // member variables
 
 public:
-       basic *bp;      ///< pointer to basic object managed by this
+       basic *bp;      ///< pointer to basic object managed by this, direct manipulation deprecated
 #ifdef OBSCURE_CINT_HACK
        static basic * last_created_or_assigned_bp;
        static basic * dummy_bp;
@@ -184,12 +222,12 @@ public:
 // performance-critical inlined method implementations
 
 inline
-ex::ex() : bp(_ex0().bp)
+ex::ex()
 {
-       /*debugmsg("ex default ctor",LOGLEVEL_CONSTRUCT);*/
-       GINAC_ASSERT(_ex0().bp!=0);
-       GINAC_ASSERT(_ex0().bp->flags & status_flags::dynallocated);
+       extern const class numeric *_num0_p;
+       bp = (basic*)_num0_p;
        GINAC_ASSERT(bp!=0);
+       GINAC_ASSERT(bp->flags & status_flags::dynallocated);
        ++bp->refcount;
 #ifdef OBSCURE_CINT_HACK
        update_last_created_or_assigned_bp();
@@ -199,7 +237,6 @@ ex::ex() : bp(_ex0().bp)
 inline
 ex::~ex()
 {
-       /*debugmsg("ex dtor",LOGLEVEL_DESTRUCT);*/
        GINAC_ASSERT(bp!=0);
        GINAC_ASSERT(bp->flags & status_flags::dynallocated);
        if (--bp->refcount == 0)
@@ -209,7 +246,6 @@ ex::~ex()
 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;
@@ -221,7 +257,6 @@ ex::ex(const ex & other) : bp(other.bp)
 inline
 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);
@@ -240,7 +275,6 @@ ex & ex::operator=(const ex & other)
 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();
@@ -250,7 +284,6 @@ ex::ex(const basic & other)
 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();
@@ -260,7 +293,6 @@ ex::ex(int i)
 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();
@@ -270,7 +302,6 @@ ex::ex(unsigned int i)
 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();
@@ -280,7 +311,6 @@ ex::ex(long i)
 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();
@@ -290,7 +320,6 @@ ex::ex(unsigned long i)
 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();
@@ -300,7 +329,6 @@ ex::ex(double const d)
 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();
@@ -329,6 +357,11 @@ bool ex::is_equal(const ex & other) const
 
 
 // utility functions
+
+/** Compare two objects of class quickly without doing a deep tree traversal.
+ *  @return "true" if they are equal
+ *          "false" if equality cannot be established quickly (e1 and e2 may
+ *          still be equal, in this case. */
 inline bool are_ex_trivially_equal(const ex &e1, const ex &e2)
 {
        return e1.bp == e2.bp;
@@ -437,6 +470,10 @@ inline bool is_zero(const ex & thisex)
 inline void swap(ex & e1, ex & e2)
 { e1.swap(e2); }
 
+// This makes STL algorithms use the more efficient swap operation for ex objects
+inline void iter_swap(std::vector<ex>::iterator i1, std::vector<ex>::iterator i2)
+{ i1->swap(*i2); }
+
 
 /* Function objects for STL sort() etc. */
 struct ex_is_less : public std::binary_function<ex, ex, bool> {