]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.cpp
synced to 1.2 (bogus assertion and evaluated symmetry nodes)
[ginac.git] / ginac / basic.cpp
index e2bbc3cceb0d9b03ea9a8ca688c0a2c430020535..3a2768418c5705aa0e7cb8078e88fc70834c7254 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2004 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
 #include "relational.h"
 #include "operators.h"
 #include "wildcard.h"
-#include "print.h"
 #include "archive.h"
 #include "utils.h"
 
 namespace GiNaC {
 
-GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
+GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(basic, void,
+  print_func<print_context>(&basic::do_print).
+  print_func<print_tree>(&basic::do_print_tree).
+  print_func<print_python_repr>(&basic::do_print_python_repr))
 
 //////////
 // default constructor, destructor, copy constructor and assignment operator
@@ -53,9 +55,8 @@ GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
 /** basic copy constructor: implicitly assumes that the other class is of
  *  the exact same type (as it's used by duplicate()), so it can copy the
  *  tinfo_key and the hash value. */
-basic::basic(const basic & other) : tinfo_key(other.tinfo_key), flags(other.flags & ~status_flags::dynallocated), hashvalue(other.hashvalue), refcount(0)
+basic::basic(const basic & other) : tinfo_key(other.tinfo_key), flags(other.flags & ~status_flags::dynallocated), hashvalue(other.hashvalue)
 {
-       GINAC_ASSERT(typeid(*this) == typeid(other));
 }
 
 /** basic assignment operator: the other object might be of a derived class. */
@@ -66,13 +67,13 @@ const basic & basic::operator=(const basic & other)
                // The other object is of a derived class, so clear the flags as they
                // might no longer apply (especially hash_calculated). Oh, and don't
                // copy the tinfo_key: it is already set correctly for this object.
-               flags = 0;
+               fl &= ~(status_flags::evaluated | status_flags::expanded | status_flags::hash_calculated);
        } else {
                // The objects are of the exact same class, so copy the hash value.
                hashvalue = other.hashvalue;
        }
        flags = fl;
-       refcount = 0;
+       set_refcount(0);
        return *this;
 }
 
@@ -91,7 +92,7 @@ const basic & basic::operator=(const basic & other)
 //////////
 
 /** Construct object from archive_node. */
-basic::basic(const archive_node &n, lst &sym_lst) : flags(0), refcount(0)
+basic::basic(const archive_node &n, lst &sym_lst) : flags(0)
 {
        // Reconstruct tinfo_key from class name
        std::string class_name;
@@ -116,23 +117,85 @@ void basic::archive(archive_node &n) const
 
 // public
 
-/** Output to stream.
+/** Output to stream. This performs double dispatch on the dynamic type of
+ *  *this and the dynamic type of the supplied print context.
  *  @param c print context object that describes the output formatting
  *  @param level value that is used to identify the precedence or indentation
  *               level for placing parentheses and formatting */
 void basic::print(const print_context & c, unsigned level) const
 {
-       if (is_a<print_tree>(c)) {
+       print_dispatch(get_class_info(), c, level);
+}
+
+/** Like print(), but dispatch to the specified class. Can be used by
+ *  implementations of print methods to dispatch to the method of the
+ *  superclass.
+ *
+ *  @see basic::print */
+void basic::print_dispatch(const registered_class_info & ri, const print_context & c, unsigned level) const
+{
+       // Double dispatch on object type and print_context type
+       const registered_class_info * reg_info = &ri;
+       const print_context_class_info * pc_info = &c.get_class_info();
 
-               c.s << std::string(level, ' ') << class_name()
-                   << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
-                   << ", nops=" << nops()
-                   << std::endl;
-               for (size_t i=0; i<nops(); ++i)
-                       op(i).print(c, level + static_cast<const print_tree &>(c).delta_indent);
+next_class:
+       const std::vector<print_functor> & pdt = reg_info->options.get_print_dispatch_table();
 
-       } else
-               c.s << "[" << class_name() << " object]";
+next_context:
+       unsigned id = pc_info->options.get_id();
+       if (id >= pdt.size() || !(pdt[id].is_valid())) {
+
+               // Method not found, try parent print_context class
+               const print_context_class_info * parent_pc_info = pc_info->get_parent();
+               if (parent_pc_info) {
+                       pc_info = parent_pc_info;
+                       goto next_context;
+               }
+
+               // Method still not found, try parent class
+               const registered_class_info * parent_reg_info = reg_info->get_parent();
+               if (parent_reg_info) {
+                       reg_info = parent_reg_info;
+                       pc_info = &c.get_class_info();
+                       goto next_class;
+               }
+
+               // Method still not found. This shouldn't happen because basic (the
+               // base class of the algebraic hierarchy) registers a method for
+               // print_context (the base class of the print context hierarchy),
+               // so if we end up here, there's something wrong with the class
+               // registry.
+               throw (std::runtime_error(std::string("basic::print(): method for ") + class_name() + "/" + c.class_name() + " not found"));
+
+       } else {
+
+               // Call method
+               pdt[id](*this, c, level);
+       }
+}
+
+/** Default output to stream. */
+void basic::do_print(const print_context & c, unsigned level) const
+{
+       c.s << "[" << class_name() << " object]";
+}
+
+/** Tree output to stream. */
+void basic::do_print_tree(const print_tree & c, unsigned level) const
+{
+       c.s << std::string(level, ' ') << class_name() << " @" << this
+           << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec;
+       if (nops())
+               c.s << ", nops=" << nops();
+       c.s << std::endl;
+       for (size_t i=0; i<nops(); ++i)
+               op(i).print(c, level + c.delta_indent);
+}
+
+/** Python parsable output to stream. */
+void basic::do_print_python_repr(const print_python_repr & c, unsigned level) const
+{
+       c.s << class_name() << "()";
 }
 
 /** Little wrapper around print to be called within a debugger.
@@ -156,7 +219,7 @@ void basic::dbgprinttree() const
        this->print(print_tree(std::cerr));
 }
 
-/** Return relative operator precedence (for parenthizing output). */
+/** Return relative operator precedence (for parenthezing output). */
 unsigned basic::precedence() const
 {
        return 70;
@@ -243,12 +306,23 @@ ex basic::map(map_function & f) const
        if (num == 0)
                return *this;
 
-       basic *copy = duplicate();
-       copy->setflag(status_flags::dynallocated);
-       copy->clearflag(status_flags::hash_calculated | status_flags::expanded);
-       for (size_t i=0; i<num; i++)
-               copy->let_op(i) = f(copy->op(i));
-       return *copy;
+       basic *copy = NULL;
+       for (size_t i=0; i<num; i++) {
+               const ex & o = op(i);
+               const ex & n = f(o);
+               if (!are_ex_trivially_equal(o, n)) {
+                       if (copy == NULL)
+                               copy = duplicate();
+                       copy->let_op(i) = n;
+               }
+       }
+
+       if (copy) {
+               copy->setflag(status_flags::dynallocated);
+               copy->clearflag(status_flags::hash_calculated | status_flags::expanded);
+               return *copy;
+       } else
+               return *this;
 }
 
 /** Return degree of highest power in object s. */
@@ -422,7 +496,7 @@ ex basic::eval_indexed(const basic & i) const
  *  (or a subclass) and their indices are compatible. This function is used
  *  internally by simplify_indexed().
  *
- *  @param self First indexed expression; it's base object is *this
+ *  @param self First indexed expression; its base object is *this
  *  @param other Second indexed expression
  *  @return sum of self and other 
  *  @see ex::simplify_indexed() */
@@ -434,7 +508,7 @@ ex basic::add_indexed(const ex & self, const ex & other) const
 /** Multiply an indexed expression with a scalar. This function is used
  *  internally by simplify_indexed().
  *
- *  @param self Indexed expression; it's base object is *this
+ *  @param self Indexed expression; its base object is *this
  *  @param other Numeric value
  *  @return product of self and other
  *  @see ex::simplify_indexed() */
@@ -450,7 +524,7 @@ ex basic::scalar_mul_indexed(const ex & self, const numeric & other) const
  *  and that at least one dummy index has been found. This functions is
  *  used internally by simplify_indexed().
  *
- *  @param self Pointer to first indexed expression; it's base object is *this
+ *  @param self Pointer to first indexed expression; its base object is *this
  *  @param other Pointer to second indexed expression
  *  @param v The complete vector of factors
  *  @return true if the contraction was successful, false otherwise
@@ -485,8 +559,8 @@ bool basic::match(const ex & pattern, lst & repl_lst) const
        if (is_exactly_a<wildcard>(pattern)) {
 
                // Wildcard matches anything, but check whether we already have found
-               // a match for that wildcard first (if so, it the earlier match must
-               // be the same expression)
+               // a match for that wildcard first (if so, the earlier match must be
+               // the same expression)
                for (lst::const_iterator it = repl_lst.begin(); it != repl_lst.end(); ++it) {
                        if (it->op(0).is_equal(pattern))
                                return is_equal(ex_to<basic>(it->op(1)));
@@ -610,6 +684,11 @@ exvector basic::get_free_indices() const
        return exvector(); // return an empty exvector
 }
 
+ex basic::conjugate() const
+{
+       return *this;
+}
+
 ex basic::eval_ncmul(const exvector & v) const
 {
        return hold_ncmul(v);
@@ -696,7 +775,7 @@ unsigned basic::calchash() const
        unsigned v = golden_ratio_hash(tinfo());
        for (size_t i=0; i<nops(); i++) {
                v = rotate_left(v);
-               v ^= (const_cast<basic *>(this))->op(i).gethash();
+               v ^= this->op(i).gethash();
        }
 
        // store calculated hash value only if object is already evaluated
@@ -712,7 +791,7 @@ unsigned basic::calchash() const
 struct expand_map_function : public map_function {
        unsigned options;
        expand_map_function(unsigned o) : options(o) {}
-       ex operator()(const ex & e) { return expand(e, options); }
+       ex operator()(const ex & e) { return e.expand(options); }
 };
 
 /** Expand expression, i.e. multiply it out and return the result as a new
@@ -739,10 +818,16 @@ ex basic::expand(unsigned options) const
  *  1 greater. */
 int basic::compare(const basic & other) const
 {
+#ifdef GINAC_COMPARE_STATISTICS
+       compare_statistics.total_basic_compares++;
+#endif
        const unsigned hash_this = gethash();
        const unsigned hash_other = other.gethash();
        if (hash_this<hash_other) return -1;
        if (hash_this>hash_other) return 1;
+#ifdef GINAC_COMPARE_STATISTICS
+       compare_statistics.compare_same_hashvalue++;
+#endif
 
        const unsigned typeid_this = tinfo();
        const unsigned typeid_other = other.tinfo();
@@ -758,6 +843,9 @@ int basic::compare(const basic & other) const
 //                     std::cout << std::endl;
 //             }
 //             return cmpval;
+#ifdef GINAC_COMPARE_STATISTICS
+               compare_statistics.compare_same_type++;
+#endif
                return compare_same_type(other);
        } else {
 //             std::cout << "hash collision, different types: " 
@@ -778,13 +866,22 @@ int basic::compare(const basic & other) const
  *  @see is_equal_same_type */
 bool basic::is_equal(const basic & other) const
 {
+#ifdef GINAC_COMPARE_STATISTICS
+       compare_statistics.total_basic_is_equals++;
+#endif
        if (this->gethash()!=other.gethash())
                return false;
+#ifdef GINAC_COMPARE_STATISTICS
+       compare_statistics.is_equal_same_hashvalue++;
+#endif
        if (this->tinfo()!=other.tinfo())
                return false;
        
        GINAC_ASSERT(typeid(*this)==typeid(other));
        
+#ifdef GINAC_COMPARE_STATISTICS
+       compare_statistics.is_equal_same_type++;
+#endif
        return is_equal_same_type(other);
 }
 
@@ -802,7 +899,7 @@ const basic & basic::hold() const
  *  is not the case. */
 void basic::ensure_if_modifiable() const
 {
-       if (refcount > 1)
+       if (get_refcount() > 1)
                throw(std::runtime_error("cannot modify multiply referenced object"));
        clearflag(status_flags::hash_calculated | status_flags::evaluated);
 }
@@ -813,4 +910,27 @@ void basic::ensure_if_modifiable() const
 
 int max_recursion_level = 1024;
 
+
+#ifdef GINAC_COMPARE_STATISTICS
+compare_statistics_t::~compare_statistics_t()
+{
+       std::clog << "ex::compare() called " << total_compares << " times" << std::endl;
+       std::clog << "nontrivial compares: " << nontrivial_compares << " times" << std::endl;
+       std::clog << "basic::compare() called " << total_basic_compares << " times" << std::endl;
+       std::clog << "same hashvalue in compare(): " << compare_same_hashvalue << " times" << std::endl;
+       std::clog << "compare_same_type() called " << compare_same_type << " times" << std::endl;
+       std::clog << std::endl;
+       std::clog << "ex::is_equal() called " << total_is_equals << " times" << std::endl;
+       std::clog << "nontrivial is_equals: " << nontrivial_is_equals << " times" << std::endl;
+       std::clog << "basic::is_equal() called " << total_basic_is_equals << " times" << std::endl;
+       std::clog << "same hashvalue in is_equal(): " << is_equal_same_hashvalue << " times" << std::endl;
+       std::clog << "is_equal_same_type() called " << is_equal_same_type << " times" << std::endl;
+       std::clog << std::endl;
+       std::clog << "basic::gethash() called " << total_gethash << " times" << std::endl;
+       std::clog << "used cached hashvalue " << gethash_cached << " times" << std::endl;
+}
+
+compare_statistics_t compare_statistics;
+#endif
+
 } // namespace GiNaC