ginac/constant.cpp

   1 /** @file constant.cpp
   2  *
   3  *  Implementation of GiNaC's constant types and some special constants. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #include <string>
  24 #include <stdexcept>
  25
  26 #include "constant.h"
  27 #include "numeric.h"
  28 #include "ex.h"
  29 #include "archive.h"
  30 #include "debugmsg.h"
  31
  32 #ifndef NO_NAMESPACE_GINAC
  33 namespace GiNaC {
  34 #endif // ndef NO_NAMESPACE_GINAC
  35
  36 GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
  37
  38 //////////
  39 // default constructor, destructor, copy constructor assignment operator and helpers
  40 //////////
  41
  42 // public
  43
  44 constant::constant() : basic(TINFO_constant), name(""), ef(0), number(0), serial(next_serial++)
  45 {
  46         debugmsg("constant default constructor",LOGLEVEL_CONSTRUCT);
  47 }
  48
  49 // protected
  50
  51 void constant::copy(const constant & other)
  52 {
  53         basic::copy(other);
  54         name=other.name;
  55         serial=other.serial;
  56         ef=other.ef;
  57         if (other.number != 0) {
  58                 number = new numeric(*other.number);
  59         } else {
  60                 number = 0;
  61         }
  62         // fct_assigned=other.fct_assigned;
  63 }
  64
  65 void constant::destroy(bool call_parent)
  66 {
  67         delete number;
  68         if (call_parent)
  69                 basic::destroy(call_parent);
  70 }
  71
  72 //////////
  73 // other constructors
  74 //////////
  75
  76 // public
  77
  78 constant::constant(const std::string & initname, evalffunctype efun)
  79   : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
  80 {
  81         debugmsg("constant constructor from string, function",LOGLEVEL_CONSTRUCT);
  82 }
  83
  84 constant::constant(const std::string & initname, const numeric & initnumber)
  85   : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
  86 {
  87         debugmsg("constant constructor from string, numeric",LOGLEVEL_CONSTRUCT);
  88 }
  89
  90 //////////
  91 // archiving
  92 //////////
  93
  94 /** Construct object from archive_node. */
  95 constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
  96 {
  97         debugmsg("constant constructor from archive_node", LOGLEVEL_CONSTRUCT);
  98 }
  99
 100 /** Unarchive the object. */
 101 ex constant::unarchive(const archive_node &n, const lst &sym_lst)
 102 {
 103         // Find constant by name (!! this is bad: 'twould be better if there
 104         // was a list of all global constants that we could search)
 105         std::string s;
 106         if (n.find_string("name", s)) {
 107                 if (s == Pi.name)
 108                         return Pi;
 109                 else if (s == Catalan.name)
 110                         return Catalan;
 111                 else if (s == Euler.name)
 112                         return Euler;
 113                 else
 114                         throw (std::runtime_error("unknown constant '" + s + "' in archive"));
 115         } else
 116                 throw (std::runtime_error("unnamed constant in archive"));
 117 }
 118
 119 /** Archive the object. */
 120 void constant::archive(archive_node &n) const
 121 {
 122         inherited::archive(n);
 123         n.add_string("name", name);
 124 }
 125
 126 //////////
 127 // functions overriding virtual functions from bases classes
 128 //////////
 129
 130 // public
 131
 132 basic * constant::duplicate() const
 133 {
 134         debugmsg("constant duplicate",LOGLEVEL_DUPLICATE);
 135         return new constant(*this);
 136 }
 137
 138 void constant::print(std::ostream & os, unsigned upper_precedence) const
 139 {
 140         debugmsg("constant print",LOGLEVEL_PRINT);
 141         os << name;
 142 }
 143
 144 void constant::printraw(std::ostream & os) const
 145 {
 146         debugmsg("constant printraw",LOGLEVEL_PRINT);
 147         os << "constant(" << name << ")";
 148 }
 149
 150 void constant::printtree(std::ostream & os, unsigned indent) const
 151 {
 152         debugmsg("constant printtree",LOGLEVEL_PRINT);
 153         os << std::string(indent,' ') << name
 154            << ", type=" << class_name()
 155            << ", hash=" << hashvalue
 156            << " (0x" << std::hex << hashvalue << std::dec << ")"
 157            << ", flags=" << flags << std::endl;
 158 }
 159
 160 void constant::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
 161 {
 162         debugmsg("constant print csrc",LOGLEVEL_PRINT);
 163         os << name;
 164 }
 165
 166 ex constant::evalf(int level) const
 167 {
 168         if (ef!=0) {
 169                 return ef();
 170         } else if (number != 0) {
 171                 return *number;
 172         }
 173         return *this;
 174 }
 175
 176 // protected
 177
 178 /** Implementation of ex::diff() for a constant. It always returns 0.
 179  *
 180  *  @see ex::diff */
 181 ex constant::derivative(const symbol & s) const
 182 {
 183         return _ex0();
 184 }
 185
 186 int constant::compare_same_type(const basic & other) const
 187 {
 188         GINAC_ASSERT(is_exactly_of_type(other, constant));
 189         // const constant & o=static_cast<constant &>(const_cast<basic &>(other));
 190         // return name.compare(o.name);
 191         const constant *o = static_cast<const constant *>(&other);
 192         if (serial==o->serial) return 0;
 193         return serial < o->serial ? -1 : 1;
 194 }
 195
 196 bool constant::is_equal_same_type(const basic & other) const
 197 {
 198         GINAC_ASSERT(is_exactly_of_type(other, constant));
 199         const constant *o = static_cast<const constant *>(&other);
 200         return serial==o->serial;
 201 }
 202
 203 //////////
 204 // new virtual functions which can be overridden by derived classes
 205 //////////
 206
 207 // none
 208
 209 //////////
 210 // non-virtual functions in this class
 211 //////////
 212
 213 // none
 214
 215 //////////
 216 // static member variables
 217 //////////
 218
 219 unsigned constant::next_serial=0;
 220
 221 //////////
 222 // global constants
 223 //////////
 224
 225 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
 226 const constant Pi("Pi", PiEvalf);
 227
 228 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
 229  *  Diverts straight into CLN for evalf(). */
 230 const constant Euler("Euler", EulerEvalf);
 231
 232 /** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
 233 const constant Catalan("Catalan", CatalanEvalf);
 234
 235 #ifndef NO_NAMESPACE_GINAC
 236 } // namespace GiNaC
 237 #endif // ndef NO_NAMESPACE_GINAC