]> www.ginac.de Git - ginac.git/blobdiff - ginac/basic.cpp
pseries::expand(): do not generate zero terms.
[ginac.git] / ginac / basic.cpp
index 83b777bbf9f8fc8c2592d5c34eea54a19aad2581..a33433daf262863df202c7e0f231b93f1ab2398d 100644 (file)
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  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
@@ -39,7 +39,7 @@
 namespace GiNaC {
 #endif // ndef NO_NAMESPACE_GINAC
 
-GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
+GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(basic, void)
 
 //////////
 // default constructor, destructor, copy constructor assignment operator and helpers
@@ -50,32 +50,32 @@ GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
 #ifndef INLINE_BASIC_CONSTRUCTORS
 basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
 {
-    debugmsg("basic default constructor", LOGLEVEL_CONSTRUCT);
-    // nothing to do
+       debugmsg("basic default constructor", LOGLEVEL_CONSTRUCT);
+       // nothing to do
 }
 
 basic::~basic() 
 {
-    debugmsg("basic destructor", LOGLEVEL_DESTRUCT);
-    destroy(0);
-    GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
+       debugmsg("basic destructor", LOGLEVEL_DESTRUCT);
+       destroy(false);
+       GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
 }
 
 basic::basic(const basic & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
 {
-    debugmsg("basic copy constructor", LOGLEVEL_CONSTRUCT);
-    copy(other);
+       debugmsg("basic copy constructor", LOGLEVEL_CONSTRUCT);
+       copy(other);
 }
 #endif
 
 const basic & basic::operator=(const basic & other)
 {
-    debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
-    if (this != &other) {
-        destroy(1);
-        copy(other);
-    }
-    return *this;
+       debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
+       if (this != &other) {
+               destroy(true);
+               copy(other);
+       }
+       return *this;
 }
 
 // protected
@@ -89,8 +89,8 @@ const basic & basic::operator=(const basic & other)
 #ifndef INLINE_BASIC_CONSTRUCTORS
 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
 {
-    debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
-    // nothing to do
+       debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
+       // nothing to do
 }
 #endif
 
@@ -101,26 +101,26 @@ basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
 /** Construct object from archive_node. */
 basic::basic(const archive_node &n, const lst &sym_lst) : flags(0), refcount(0)
 {
-    debugmsg("basic constructor from archive_node", LOGLEVEL_CONSTRUCT);
+       debugmsg("basic constructor from archive_node", LOGLEVEL_CONSTRUCT);
 
-    // Reconstruct tinfo_key from class name
-    string class_name;
-    if (n.find_string("class", class_name))
-        tinfo_key = find_tinfo_key(class_name);
-    else
-        throw (std::runtime_error("archive node contains no class name"));
+       // Reconstruct tinfo_key from class name
+       std::string class_name;
+       if (n.find_string("class", class_name))
+               tinfo_key = find_tinfo_key(class_name);
+       else
+               throw (std::runtime_error("archive node contains no class name"));
 }
 
 /** Unarchive the object. */
 ex basic::unarchive(const archive_node &n, const lst &sym_lst)
 {
-    return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
+       return (new basic(n, sym_lst))->setflag(status_flags::dynallocated);
 }
 
 /** Archive the object. */
 void basic::archive(archive_node &n) const
 {
-    n.add_string("class", class_name());
+       n.add_string("class", class_name());
 }
 
 //////////
@@ -136,32 +136,33 @@ void basic::archive(archive_node &n) const
 // public
 
 /** Output to stream formatted to be useful as ginsh input. */
-void basic::print(ostream & os, unsigned upper_precedence) const
+void basic::print(std::ostream & os, unsigned upper_precedence) const
 {
-    debugmsg("basic print",LOGLEVEL_PRINT);
-    os << "[basic object]";
+       debugmsg("basic print",LOGLEVEL_PRINT);
+       os << "[basic object]";
 }
 
 /** Output to stream in ugly raw format, so brave developers can have a look
- * at the underlying structure. */
-void basic::printraw(ostream & os) const
+ *  at the underlying structure. */
+void basic::printraw(std::ostream & os) const
 {
-    debugmsg("basic printraw",LOGLEVEL_PRINT);
-    os << "[basic object]";
+       debugmsg("basic printraw",LOGLEVEL_PRINT);
+       os << "[basic object]";
 }
 
 /** Output to stream formatted in tree- (indented-) form, so developers can
  *  have a look at the underlying structure. */
-void basic::printtree(ostream & os, unsigned indent) const
+void basic::printtree(std::ostream & os, unsigned indent) const
 {
-    debugmsg("basic printtree",LOGLEVEL_PRINT);
-    os << string(indent,' ') << "type=" << typeid(*this).name()
-       << ", hash=" << hashvalue << " (0x" << hex << hashvalue << dec << ")"
-       << ", flags=" << flags
-       << ", nops=" << nops() << endl;
-    for (unsigned i=0; i<nops(); ++i) {
-        op(i).printtree(os,indent+delta_indent);
-    }
+       debugmsg("basic printtree",LOGLEVEL_PRINT);
+       os << std::string(indent,' ') << "type=" << class_name()
+          << ", hash=" << hashvalue
+          << " (0x" << std::hex << hashvalue << std::dec << ")"
+          << ", flags=" << flags
+          << ", nops=" << nops() << std::endl;
+       for (unsigned i=0; i<nops(); ++i) {
+               op(i).printtree(os,indent+delta_indent);
+       }
 }
 
 /** Output to stream formatted as C-source.
@@ -170,28 +171,36 @@ void basic::printtree(ostream & os, unsigned indent) const
  *  @param type variable type (one of the csrc_types)
  *  @param upper_precedence operator precedence of caller
  *  @see ex::printcsrc */
-void basic::printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const
+void basic::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
 {
-    debugmsg("basic print csrc", LOGLEVEL_PRINT);
+       debugmsg("basic print csrc", LOGLEVEL_PRINT);
 }
 
-/** Little wrapper arount print to be called within a debugger. */
+/** Little wrapper arount print to be called within a debugger.
+ *  This is needed because you cannot call foo.print(cout) from within the
+ *  debugger because it might not know what cout is.  This method can be invoked
+ *  with no argument and it will simply print to stdout.
+ *
+ *  @see basic::print*/
 void basic::dbgprint(void) const
 {
-    print(cerr);
-    cerr << endl;
+       print(std::cerr);
+       std::cerr << std::endl;
 }
 
-/** Little wrapper arount printtree to be called within a debugger. */
+/** Little wrapper arount printtree to be called within a debugger.
+ *
+ *  @see basic::dbgprint
+ *  @see basic::printtree */
 void basic::dbgprinttree(void) const
 {
-    printtree(cerr,0);
+       printtree(std::cerr,0);
 }
 
 basic * basic::duplicate() const
 {
-    debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
-    return new basic(*this);
+       debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
+       return new basic(*this);
 }
 
 /** Information about the object.
@@ -199,106 +208,106 @@ basic * basic::duplicate() const
  *  @see class info_flags */
 bool basic::info(unsigned inf) const
 {
-    return false; // all possible properties are false for basic objects
+       return false; // all possible properties are false for basic objects
 }
 
 /** Number of operands/members. */
 unsigned basic::nops() const
 {
-    // iterating from 0 to nops() on atomic objects should be an empty loop,
-    // and accessing their elements is a range error.  Container objects should
-    // override this.
-    return 0;
+       // iterating from 0 to nops() on atomic objects should be an empty loop,
+       // and accessing their elements is a range error.  Container objects should
+       // override this.
+       return 0;
 }
 
 /** Return operand/member at position i. */
 ex basic::op(int i) const
 {
-    return (const_cast<basic *>(this))->let_op(i);
+       return (const_cast<basic *>(this))->let_op(i);
 }
 
 /** Return modifyable operand/member at position i. */
 ex & basic::let_op(int i)
 {
-    throw(std::out_of_range("op() out of range"));
+       throw(std::out_of_range("op() out of range"));
 }
 
 ex basic::operator[](const ex & index) const
 {
-    if (is_exactly_of_type(*index.bp,numeric))
-        return op(static_cast<const numeric &>(*index.bp).to_int());
-    
-    throw(std::invalid_argument("non-numeric indices not supported by this type"));
+       if (is_exactly_of_type(*index.bp,numeric))
+               return op(static_cast<const numeric &>(*index.bp).to_int());
+       
+       throw(std::invalid_argument("non-numeric indices not supported by this type"));
 }
 
 ex basic::operator[](int i) const
 {
-    return op(i);
+       return op(i);
 }
 
 /** Search ocurrences.  An object  'has' an expression if it is the expression
  *  itself or one of the children 'has' it. */
 bool basic::has(const ex & other) const
 {
-    GINAC_ASSERT(other.bp!=0);
-    if (is_equal(*other.bp)) return true;
-    if (nops()>0) {
-        for (unsigned i=0; i<nops(); i++) {
-            if (op(i).has(other)) return true;
-        }
-    }
-    return false;
+       GINAC_ASSERT(other.bp!=0);
+       if (is_equal(*other.bp)) return true;
+       if (nops()>0) {
+               for (unsigned i=0; i<nops(); i++) {
+                       if (op(i).has(other)) return true;
+               }
+       }
+       return false;
 }
 
 /** Return degree of highest power in symbol s. */
 int basic::degree(const symbol & s) const
 {
-    return 0;
+       return 0;
 }
 
 /** Return degree of lowest power in symbol s. */
 int basic::ldegree(const symbol & s) const
 {
-    return 0;
+       return 0;
 }
 
 /** Return coefficient of degree n in symbol s. */
 ex basic::coeff(const symbol & s, int n) const
 {
-    return n==0 ? *this : _ex0();
+       return n==0 ? *this : _ex0();
 }
 
 /** Sort expression in terms of powers of some symbol.
  *  @param s symbol to sort in. */
 ex basic::collect(const symbol & s) const
 {
-    ex x;
-    int ldeg = this->ldegree(s);
-    int deg = this->degree(s);
-    for (int n=ldeg; n<=deg; n++) {
-        x += this->coeff(s,n)*power(s,n);
-    }
-    return x;
+       ex x;
+       int ldeg = this->ldegree(s);
+       int deg = this->degree(s);
+       for (int n=ldeg; n<=deg; n++) {
+               x += this->coeff(s,n)*power(s,n);
+       }
+       return x;
 }
 
 /* Perform automatic symbolic evaluations on expression. */
 ex basic::eval(int level) const
 {
-    // There is nothing to do for basic objects:
-    return this->hold();
+       // There is nothing to do for basic objects:
+       return this->hold();
 }
 
 /** Evaluate object numerically. */
 ex basic::evalf(int level) const
 {
-    // There is nothing to do for basic objects:
-    return *this;
+       // There is nothing to do for basic objects:
+       return *this;
 }
 
 /* Substitute a set of symbols. */
 ex basic::subs(const lst & ls, const lst & lr) const
 {
-    return *this;
+       return *this;
 }
 
 /** Default interface of nth derivative ex::diff(s, n).  It should be called
@@ -310,31 +319,31 @@ ex basic::subs(const lst & ls, const lst & lr) const
  *  @see ex::diff */
 ex basic::diff(const symbol & s, unsigned nth) const
 {
-    // trivial: zeroth derivative
-    if (!nth)
-        return ex(*this);
-    
-    // evaluate unevaluated *this before differentiating
-    if (!(flags & status_flags::evaluated))
-        return ex(*this).diff(s, nth);
-    
-    ex ndiff = derivative(s);
-    while (!ndiff.is_zero() &&    // stop differentiating zeros
-           nth>1) {
-        ndiff = ndiff.diff(s);
-        --nth;
-    }
-    return ndiff;
+       // trivial: zeroth derivative
+       if (nth==0)
+               return ex(*this);
+       
+       // evaluate unevaluated *this before differentiating
+       if (!(flags & status_flags::evaluated))
+               return ex(*this).diff(s, nth);
+       
+       ex ndiff = this->derivative(s);
+       while (!ndiff.is_zero() &&    // stop differentiating zeros
+              nth>1) {
+               ndiff = ndiff.diff(s);
+               --nth;
+       }
+       return ndiff;
 }
 
 exvector basic::get_indices(void) const
 {
-    return exvector(); // return an empty exvector
+       return exvector(); // return an empty exvector
 }
 
 ex basic::simplify_ncmul(const exvector & v) const
 {
-    return simplified_ncmul(v);
+       return simplified_ncmul(v);
 }
 
 // protected
@@ -345,14 +354,14 @@ ex basic::simplify_ncmul(const exvector & v) const
  *  @see ex::diff */
 ex basic::derivative(const symbol & s) const
 {
-    throw(std::logic_error("differentiation not supported by this type"));
+       throw(std::logic_error("differentiation not supported by this type"));
 }
 
 /** Returns order relation between two objects of same type.  Needs to be
  *  implemented by each class. */
 int basic::compare_same_type(const basic & other) const
 {
-    return compare_pointers(this, &other);
+       return compare_pointers(this, &other);
 }
 
 /** Returns true if two objects of same type are equal.  Normally needs
@@ -360,43 +369,43 @@ int basic::compare_same_type(const basic & other) const
  *  class, since it just calls complare_same_type(). */
 bool basic::is_equal_same_type(const basic & other) const
 {
-    return compare_same_type(other)==0;
+       return compare_same_type(other)==0;
 }
 
 unsigned basic::return_type(void) const
 {
-    return return_types::commutative;
+       return return_types::commutative;
 }
 
 unsigned basic::return_type_tinfo(void) const
 {
-    return tinfo();
+       return tinfo();
 }
 
 unsigned basic::calchash(void) const
 {
-    unsigned v=golden_ratio_hash(tinfo());
-    for (unsigned i=0; i<nops(); i++) {
-        v=rotate_left_31(v);
-        v ^= (const_cast<basic *>(this))->op(i).gethash();
-    }
+       unsigned v=golden_ratio_hash(tinfo());
+       for (unsigned i=0; i<nops(); i++) {
+               v=rotate_left_31(v);
+               v ^= (const_cast<basic *>(this))->op(i).gethash();
+       }
 
-    v = v & 0x7FFFFFFFU;
-    
-    // store calculated hash value only if object is already evaluated
-    if (flags & status_flags::evaluated) {
-        setflag(status_flags::hash_calculated);
-        hashvalue=v;
-    }
+       v = v & 0x7FFFFFFFU;
+       
+       // store calculated hash value only if object is already evaluated
+       if (flags & status_flags::evaluated) {
+               setflag(status_flags::hash_calculated);
+               hashvalue=v;
+       }
 
-    return v;
+       return v;
 }
 
 /** Expand expression, i.e. multiply it out and return the result as a new
  *  expression. */
 ex basic::expand(unsigned options) const
 {
-    return this->setflag(status_flags::expanded);
+       return this->setflag(status_flags::expanded);
 }
 
 
@@ -413,27 +422,27 @@ ex basic::expand(unsigned options) const
  *  In addition, an object of class idx can be used instead of a symbol. */
 ex basic::subs(const ex & e) const
 {
-    if (e.info(info_flags::relation_equal)) {
-        return subs(lst(e));
-    }
-    if (!e.info(info_flags::list)) {
-        throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
-    }
-    lst ls;
-    lst lr;
-    for (unsigned i=0; i<e.nops(); i++) {
-        if (!e.op(i).info(info_flags::relation_equal)) {
-            throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
-        }
-        if (!e.op(i).op(0).info(info_flags::symbol)) {
-            if (!e.op(i).op(0).info(info_flags::idx)) {
-                throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
-            }
-        }
-        ls.append(e.op(i).op(0));
-        lr.append(e.op(i).op(1));
-    }
-    return subs(ls,lr);
+       if (e.info(info_flags::relation_equal)) {
+               return subs(lst(e));
+       }
+       if (!e.info(info_flags::list)) {
+               throw(std::invalid_argument("basic::subs(ex): argument must be a list"));
+       }
+       lst ls;
+       lst lr;
+       for (unsigned i=0; i<e.nops(); i++) {
+               if (!e.op(i).info(info_flags::relation_equal)) {
+                       throw(std::invalid_argument("basic::subs(ex): argument must be a list or equations"));
+               }
+               if (!e.op(i).op(0).info(info_flags::symbol)) {
+                       if (!e.op(i).op(0).info(info_flags::idx)) {
+                               throw(std::invalid_argument("basic::subs(ex): lhs must be a symbol or an idx"));
+                       }
+               }
+               ls.append(e.op(i).op(0));
+               lr.append(e.op(i).op(1));
+       }
+       return subs(ls,lr);
 }
 
 /** Compare objects to establish canonical order.
@@ -441,70 +450,70 @@ ex basic::subs(const ex & e) const
  *  1 greater. */
 int basic::compare(const basic & other) const
 {
-    unsigned hash_this = gethash();
-    unsigned hash_other = other.gethash();
-
-    if (hash_this<hash_other) return -1;
-    if (hash_this>hash_other) return 1;
-
-    unsigned typeid_this = tinfo();
-    unsigned typeid_other = other.tinfo();
-
-    if (typeid_this<typeid_other) {
-        /*
-        cout << "hash collision, different types: " 
-             << *this << " and " << other << endl;
-        this->printraw(cout);
-        cout << " and ";
-        other.printraw(cout);
-        cout << endl;
-        */
-        return -1;
-    }
-    if (typeid_this>typeid_other) {
-        /*
-        cout << "hash collision, different types: " 
-             << *this << " and " << other << endl;
-        this->printraw(cout);
-        cout << " and ";
-        other.printraw(cout);
-        cout << endl;
-        */
-        return 1;
-    }
-
-    GINAC_ASSERT(typeid(*this)==typeid(other));
-
-    int cmpval=compare_same_type(other);
-    if ((cmpval!=0)&&(hash_this<0x80000000U)) {
-        /*
-        cout << "hash collision, same type: " 
-             << *this << " and " << other << endl;
-        this->printraw(cout);
-        cout << " and ";
-        other.printraw(cout);
-        cout << endl;
-        */
-    }
-    return cmpval;
+       unsigned hash_this = gethash();
+       unsigned hash_other = other.gethash();
+
+       if (hash_this<hash_other) return -1;
+       if (hash_this>hash_other) return 1;
+
+       unsigned typeid_this = tinfo();
+       unsigned typeid_other = other.tinfo();
+
+       if (typeid_this<typeid_other) {
+               /*
+               cout << "hash collision, different types: " 
+                        << *this << " and " << other << endl;
+               this->printraw(cout);
+               cout << " and ";
+               other.printraw(cout);
+               cout << endl;
+               */
+               return -1;
+       }
+       if (typeid_this>typeid_other) {
+               /*
+               cout << "hash collision, different types: " 
+                        << *this << " and " << other << endl;
+               this->printraw(cout);
+               cout << " and ";
+               other.printraw(cout);
+               cout << endl;
+               */
+               return 1;
+       }
+
+       GINAC_ASSERT(typeid(*this)==typeid(other));
+
+       int cmpval=compare_same_type(other);
+       if ((cmpval!=0)&&(hash_this<0x80000000U)) {
+               /*
+               cout << "hash collision, same type: " 
+                        << *this << " and " << other << endl;
+               this->printraw(cout);
+               cout << " and ";
+               other.printraw(cout);
+               cout << endl;
+               */
+       }
+       return cmpval;
 }
 
 /** Test for equality. */
 bool basic::is_equal(const basic & other) const
 {
-    unsigned hash_this = gethash();
-    unsigned hash_other = other.gethash();
+       unsigned hash_this = gethash();
+       unsigned hash_other = other.gethash();
 
-    if (hash_this!=hash_other) return false;
+       if (hash_this!=hash_other) return false;
 
-    unsigned typeid_this = tinfo();
-    unsigned typeid_other = other.tinfo();
+       unsigned typeid_this = tinfo();
+       unsigned typeid_other = other.tinfo();
 
-    if (typeid_this!=typeid_other) return false;
+       if (typeid_this!=typeid_other) return false;
 
-    GINAC_ASSERT(typeid(*this)==typeid(other));
+       GINAC_ASSERT(typeid(*this)==typeid(other));
 
-    return is_equal_same_type(other);
+       return is_equal_same_type(other);
 }
 
 // protected
@@ -513,14 +522,13 @@ bool basic::is_equal(const basic & other) const
  *  @see basic::eval */
 const basic & basic::hold(void) const
 {
-    return setflag(status_flags::evaluated);
+       return setflag(status_flags::evaluated);
 }
 
 void basic::ensure_if_modifiable(void) const
 {
-    if (refcount>1) {
-        throw(std::runtime_error("cannot modify multiply referenced object"));
-    }
+       if (refcount>1)
+               throw(std::runtime_error("cannot modify multiply referenced object"));
 }
 
 //////////
@@ -532,13 +540,6 @@ void basic::ensure_if_modifiable(void) const
 unsigned basic::precedence = 70;
 unsigned basic::delta_indent = 4;
 
-//////////
-// global constants
-//////////
-
-const basic some_basic;
-const type_info & typeid_basic=typeid(some_basic);
-
 //////////
 // global variables
 //////////