X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fbasic.cpp;h=0d9f989b9c8c6a22b2fa492c09dfb2033b067616;hp=1c8814d44f89bb8d50579551cbb3a01382916402;hb=2565309dd7c38635c191eacf2a4af9b23fc0d310;hpb=9eab44408b9213d8909b7a9e525f404ad06064dd

diff --git a/ginac/basic.cpp b/ginac/basic.cpp
index 1c8814d4..0d9f989b 100644
--- a/ginac/basic.cpp
+++ b/ginac/basic.cpp
@@ -3,7 +3,7 @@
  *  Implementation of GiNaC's ABC. */
 
 /*
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2000 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
@@ -31,10 +31,15 @@
 #include "symbol.h"
 #include "lst.h"
 #include "ncmul.h"
+#include "archive.h"
 #include "utils.h"
 #include "debugmsg.h"
 
+#ifndef NO_GINAC_NAMESPACE
 namespace GiNaC {
+#endif // ndef NO_GINAC_NAMESPACE
+
+GINAC_IMPLEMENT_REGISTERED_CLASS(basic, void)
 
 //////////
 // default constructor, destructor, copy constructor assignment operator and helpers
@@ -45,27 +50,27 @@ namespace GiNaC {
 #ifndef INLINE_BASIC_CONSTRUCTORS
 basic::basic() : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
 {
-    debugmsg("basic default constructor",LOGLEVEL_CONSTRUCT);
+    debugmsg("basic default constructor", LOGLEVEL_CONSTRUCT);
     // nothing to do
 }
 
 basic::~basic() 
 {
-    debugmsg("basic destructor",LOGLEVEL_DESTRUCT);
+    debugmsg("basic destructor", LOGLEVEL_DESTRUCT);
     destroy(0);
-    ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
+    GINAC_ASSERT((!(flags & status_flags::dynallocated))||(refcount==0));
 }
 
-basic::basic(basic const & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
+basic::basic(const basic & other) : flags(0), refcount(0), tinfo_key(TINFO_BASIC)
 {
-    debugmsg("basic copy constructor",LOGLEVEL_CONSTRUCT);
+    debugmsg("basic copy constructor", LOGLEVEL_CONSTRUCT);
     copy(other);
 }
 #endif
 
-basic const & basic::operator=(basic const & other)
+const basic & basic::operator=(const basic & other)
 {
-    debugmsg("basic operator=",LOGLEVEL_ASSIGNMENT);
+    debugmsg("basic operator=", LOGLEVEL_ASSIGNMENT);
     if (this != &other) {
         destroy(1);
         copy(other);
@@ -76,7 +81,7 @@ basic const & basic::operator=(basic const & other)
 // protected
 
 #if 0
-void basic::copy(basic const & other)
+void basic::copy(const basic & other)
 {
     flags=other.flags & ~ status_flags::dynallocated;
     hashvalue=other.hashvalue;
@@ -91,11 +96,40 @@ void basic::copy(basic const & other)
 #ifndef INLINE_BASIC_CONSTRUCTORS
 basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
 {
-    debugmsg("basic constructor with tinfo_key",LOGLEVEL_CONSTRUCT);
+    debugmsg("basic constructor with tinfo_key", LOGLEVEL_CONSTRUCT);
     // nothing to do
 }
 #endif
 
+//////////
+// archiving
+//////////
+
+/** 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);
+
+    // 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"));
+}
+
+/** Unarchive the object. */
+ex basic::unarchive(const archive_node &n, const lst &sym_lst)
+{
+    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());
+}
+
 //////////
 // functions overriding virtual functions from bases classes
 //////////
@@ -108,6 +142,59 @@ basic::basic(unsigned ti) : flags(0), refcount(0), tinfo_key(ti)
 
 // public
 
+/** Output to stream formatted to be useful as ginsh input. */
+void basic::print(ostream & os, unsigned upper_precedence) const
+{
+    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
+{
+    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
+{
+    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);
+    }
+}
+
+/** Output to stream formatted as C-source.
+ *
+ *  @param os a stream for output
+ *  @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
+{
+    debugmsg("basic print csrc", LOGLEVEL_PRINT);
+}
+
+/** Little wrapper arount print to be called within a debugger. */
+void basic::dbgprint(void) const
+{
+    print(cerr);
+    cerr << endl;
+}
+
+/** Little wrapper arount printtree to be called within a debugger. */
+void basic::dbgprinttree(void) const
+{
+    printtree(cerr,0);
+}
+
 basic * basic::duplicate() const
 {
     debugmsg("basic duplicate",LOGLEVEL_DUPLICATE);
@@ -119,62 +206,62 @@ bool basic::info(unsigned inf) const
     return false; // all possible properties are false for basic objects
 }
 
-int basic::nops() const
+unsigned basic::nops() const
 {
     return 0;
 }
 
-ex basic::op(int const i) const
+ex basic::op(int i) const
 {
     return (const_cast<basic *>(this))->let_op(i);
 }
 
-ex & basic::let_op(int const i)
+ex & basic::let_op(int i)
 {
     throw(std::out_of_range("op() out of range"));
 }
 
-ex basic::operator[](ex const & index) const
+ex basic::operator[](const ex & index) const
 {
     if (is_exactly_of_type(*index.bp,numeric)) {
-        return op(static_cast<numeric const &>(*index.bp).to_int());
+        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 const i) const
+ex basic::operator[](int i) const
 {
     return op(i);
 }
 
-bool basic::has(ex const & other) const
+bool basic::has(const ex & other) const
 {
-    ASSERT(other.bp!=0);
+    GINAC_ASSERT(other.bp!=0);
     if (is_equal(*other.bp)) return true;
     if (nops()>0) {
-        for (int i=0; i<nops(); i++) {
+        for (unsigned i=0; i<nops(); i++) {
             if (op(i).has(other)) return true;
         }
     }
     return false;
 }
 
-int basic::degree(symbol const & s) const
+int basic::degree(const symbol & s) const
 {
     return 0;
 }
 
-int basic::ldegree(symbol const & s) const
+int basic::ldegree(const symbol & s) const
 {
     return 0;
 }
 
-ex basic::coeff(symbol const & s, int const n) const
+ex basic::coeff(const symbol & s, int n) const
 {
-    return n==0 ? *this : exZERO();
+    return n==0 ? *this : _ex0();
 }
 
-ex basic::collect(symbol const & s) const
+ex basic::collect(const symbol & s) const
 {
     ex x;
     int ldeg=ldegree(s);
@@ -195,7 +282,7 @@ ex basic::evalf(int level) const
     return *this;
 }
 
-ex basic::subs(lst const & ls, lst const & lr) const
+ex basic::subs(const lst & ls, const lst & lr) const
 {
     return *this;
 }
@@ -205,19 +292,19 @@ exvector basic::get_indices(void) const
     return exvector(); // return an empty exvector
 }
 
-ex basic::simplify_ncmul(exvector const & v) const
+ex basic::simplify_ncmul(const exvector & v) const
 {
     return simplified_ncmul(v);
 }
 
 // protected
 
-int basic::compare_same_type(basic const & other) const
+int basic::compare_same_type(const basic & other) const
 {
     return compare_pointers(this, &other);
 }
 
-bool basic::is_equal_same_type(basic const & other) const
+bool basic::is_equal_same_type(const basic & other) const
 {
     return compare_same_type(other)==0;
 }
@@ -235,9 +322,9 @@ unsigned basic::return_type_tinfo(void) const
 unsigned basic::calchash(void) const
 {
     unsigned v=golden_ratio_hash(tinfo());
-    for (int i=0; i<nops(); i++) {
+    for (unsigned i=0; i<nops(); i++) {
         v=rotate_left_31(v);
-        v ^= (const_cast<basic *>(this))->let_op(i).gethash();
+        v ^= (const_cast<basic *>(this))->op(i).gethash();
     }
 
     v = v & 0x7FFFFFFFU;
@@ -262,7 +349,7 @@ ex basic::expand(unsigned options) const
 
 // public
 
-ex basic::subs(ex const & e) const
+ex basic::subs(const ex & e) const
 {
     // accept 2 types of replacement expressions:
     //   - symbol==ex
@@ -277,7 +364,7 @@ ex basic::subs(ex const & e) const
     }
     lst ls;
     lst lr;
-    for (int i=0; i<e.nops(); i++) {
+    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"));
         }
@@ -292,29 +379,10 @@ ex basic::subs(ex const & e) const
     return subs(ls,lr);
 }
 
-// compare functions to sort expressions canonically
-// all compare functions return: -1 for *this less than other, 0 equal, 1 greater
-
-/*
-int basic::compare(basic const & other) const
-{
-    const type_info & typeid_this = typeid(*this);
-    const type_info & typeid_other = typeid(other);
-
-    if (typeid_this==typeid_other) {
-        return compare_same_type(other);
-    }
-
-    // special rule: sort numeric() to end
-    if (typeid_this==typeid_numeric) return 1;
-    if (typeid_other==typeid_numeric) return -1;
-
-    // otherwise: sort according to type_info order (arbitrary, but well defined)
-    return typeid_this.before(typeid_other) ? -1 : 1;
-}
-*/
-
-int basic::compare(basic const & other) const
+/** Compare objects to establish canonical order.
+ *  All compare functions return: -1 for *this less than other, 0 equal,
+ *  1 greater. */
+int basic::compare(const basic & other) const
 {
     unsigned hash_this = gethash();
     unsigned hash_other = other.gethash();
@@ -348,7 +416,7 @@ int basic::compare(basic const & other) const
         return 1;
     }
 
-    ASSERT(typeid(*this)==typeid(other));
+    GINAC_ASSERT(typeid(*this)==typeid(other));
 
     int cmpval=compare_same_type(other);
     if ((cmpval!=0)&&(hash_this<0x80000000U)) {
@@ -364,7 +432,7 @@ int basic::compare(basic const & other) const
     return cmpval;
 }
 
-bool basic::is_equal(basic const & other) const
+bool basic::is_equal(const basic & other) const
 {
     unsigned hash_this = gethash();
     unsigned hash_other = other.gethash();
@@ -376,14 +444,14 @@ bool basic::is_equal(basic const & other) const
 
     if (typeid_this!=typeid_other) return false;
 
-    ASSERT(typeid(*this)==typeid(other));
+    GINAC_ASSERT(typeid(*this)==typeid(other));
 
     return is_equal_same_type(other);
 }
 
 // protected
 
-basic const & basic::hold(void) const
+const basic & basic::hold(void) const
 {
     return setflag(status_flags::evaluated);
 }
@@ -409,7 +477,7 @@ unsigned basic::delta_indent=4;
 //////////
 
 const basic some_basic;
-type_info const & typeid_basic=typeid(some_basic);
+const type_info & typeid_basic=typeid(some_basic);
 
 //////////
 // global variables
@@ -417,4 +485,6 @@ type_info const & typeid_basic=typeid(some_basic);
 
 int max_recursion_level=1024;
 
+#ifndef NO_GINAC_NAMESPACE
 } // namespace GiNaC
+#endif // ndef NO_GINAC_NAMESPACE