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 #include "utils.h"
  32
  33 namespace GiNaC {
  34
  35 GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
  36
  37 //////////
  38 // default ctor, dtor, copy ctor assignment operator and helpers
  39 //////////
  40
  41 // public
  42
  43 constant::constant() : basic(TINFO_constant), name(""), ef(0), number(0), serial(next_serial++)
  44 {
  45         debugmsg("constant default ctor",LOGLEVEL_CONSTRUCT);
  46 }
  47
  48 // protected
  49
  50 /** For use by copy ctor and assignment operator. */
  51 void constant::copy(const constant & other)
  52 {
  53         inherited::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
  63 void constant::destroy(bool call_parent)
  64 {
  65         delete number;
  66         if (call_parent)
  67                 inherited::destroy(call_parent);
  68 }
  69
  70 //////////
  71 // other ctors
  72 //////////
  73
  74 // public
  75
  76 constant::constant(const std::string & initname, evalffunctype efun)
  77   : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
  78 {
  79         debugmsg("constant ctor from string, function",LOGLEVEL_CONSTRUCT);
  80         setflag(status_flags::evaluated);
  81 }
  82
  83 constant::constant(const std::string & initname, const numeric & initnumber)
  84   : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
  85 {
  86         debugmsg("constant ctor from string, numeric",LOGLEVEL_CONSTRUCT);
  87         setflag(status_flags::evaluated);
  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 ctor 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 void constant::print(std::ostream & os, unsigned upper_precedence) const
 133 {
 134         debugmsg("constant print",LOGLEVEL_PRINT);
 135         os << name;
 136 }
 137
 138 void constant::printraw(std::ostream & os) const
 139 {
 140         debugmsg("constant printraw",LOGLEVEL_PRINT);
 141         os << class_name() << "(" << name << ")";
 142 }
 143
 144 void constant::printtree(std::ostream & os, unsigned indent) const
 145 {
 146         debugmsg("constant printtree",LOGLEVEL_PRINT);
 147         os << std::string(indent,' ') << name
 148            << ", type=" << class_name()
 149            << ", hash=" << hashvalue
 150            << " (0x" << std::hex << hashvalue << std::dec << ")"
 151            << ", flags=" << flags << std::endl;
 152 }
 153
 154 void constant::printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence) const
 155 {
 156         debugmsg("constant print csrc",LOGLEVEL_PRINT);
 157         os << name;
 158 }
 159
 160 ex constant::evalf(int level) const
 161 {
 162         if (ef!=0) {
 163                 return ef();
 164         } else if (number != 0) {
 165                 return number->evalf();
 166         }
 167         return *this;
 168 }
 169
 170 // protected
 171
 172 /** Implementation of ex::diff() for a constant. It always returns 0.
 173  *
 174  *  @see ex::diff */
 175 ex constant::derivative(const symbol & s) const
 176 {
 177         return _ex0();
 178 }
 179
 180 int constant::compare_same_type(const basic & other) const
 181 {
 182         GINAC_ASSERT(is_exactly_of_type(other, constant));
 183         // const constant & o=static_cast<constant &>(const_cast<basic &>(other));
 184         // return name.compare(o.name);
 185         const constant *o = static_cast<const constant *>(&other);
 186         if (serial==o->serial) return 0;
 187         return serial < o->serial ? -1 : 1;
 188 }
 189
 190 bool constant::is_equal_same_type(const basic & other) const
 191 {
 192         GINAC_ASSERT(is_exactly_of_type(other, constant));
 193         const constant *o = static_cast<const constant *>(&other);
 194         return serial==o->serial;
 195 }
 196
 197 unsigned constant::calchash(void) const
 198 {
 199         hashvalue = golden_ratio_hash(tinfo() ^ serial);
 200         // mask out numeric hashes:
 201         hashvalue &= 0x7FFFFFFFU;
 202
 203         setflag(status_flags::hash_calculated);
 204
 205         return hashvalue;
 206 }
 207
 208 //////////
 209 // new virtual functions which can be overridden by derived classes
 210 //////////
 211
 212 // none
 213
 214 //////////
 215 // non-virtual functions in this class
 216 //////////
 217
 218 // none
 219
 220 //////////
 221 // static member variables
 222 //////////
 223
 224 unsigned constant::next_serial = 0;
 225
 226 //////////
 227 // global constants
 228 //////////
 229
 230 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
 231 const constant Pi("Pi", PiEvalf);
 232
 233 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
 234  *  Diverts straight into CLN for evalf(). */
 235 const constant Euler("Euler", EulerEvalf);
 236
 237 /** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
 238 const constant Catalan("Catalan", CatalanEvalf);
 239
 240 } // namespace GiNaC