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-2002 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 #include <iostream>
  26
  27 #include "constant.h"
  28 #include "numeric.h"
  29 #include "ex.h"
  30 #include "print.h"
  31 #include "archive.h"
  32 #include "utils.h"
  33
  34 namespace GiNaC {
  35
  36 GINAC_IMPLEMENT_REGISTERED_CLASS(constant, basic)
  37
  38 //////////
  39 // default ctor, dtor, copy ctor, assignment operator and helpers
  40 //////////
  41
  42 // public
  43
  44 constant::constant() : basic(TINFO_constant), ef(0), number(0), serial(next_serial++) {}
  45
  46 // protected
  47
  48 /** For use by copy ctor and assignment operator. */
  49 void constant::copy(const constant & other)
  50 {
  51         inherited::copy(other);
  52         name = other.name;
  53         TeX_name = other.TeX_name;
  54         serial = other.serial;
  55         ef = other.ef;
  56         if (other.number != 0)
  57                 number = new numeric(*other.number);
  58         else
  59                 number = 0;
  60 }
  61
  62 void constant::destroy(bool call_parent)
  63 {
  64         delete number;
  65         if (call_parent)
  66                 inherited::destroy(call_parent);
  67 }
  68
  69 //////////
  70 // other ctors
  71 //////////
  72
  73 // public
  74
  75 constant::constant(const std::string & initname, evalffunctype efun, const std::string & texname)
  76   : basic(TINFO_constant), name(initname), ef(efun), number(0), serial(next_serial++)
  77 {
  78         if (texname.empty())
  79                 TeX_name = "\\mbox{" + name + "}";
  80         else
  81                 TeX_name = texname;
  82         setflag(status_flags::evaluated | status_flags::expanded);
  83 }
  84
  85 constant::constant(const std::string & initname, const numeric & initnumber, const std::string & texname)
  86   : basic(TINFO_constant), name(initname), ef(0), number(new numeric(initnumber)), serial(next_serial++)
  87 {
  88         if (texname.empty())
  89                 TeX_name = "\\mbox{" + name + "}";
  90         else
  91                 TeX_name = texname;
  92         setflag(status_flags::evaluated | status_flags::expanded);
  93 }
  94
  95 //////////
  96 // archiving
  97 //////////
  98
  99 constant::constant(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) {}
 100
 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 void constant::archive(archive_node &n) const
 120 {
 121         inherited::archive(n);
 122         n.add_string("name", name);
 123 }
 124
 125 //////////
 126 // functions overriding virtual functions from base classes
 127 //////////
 128
 129 // public
 130
 131 void constant::print(const print_context & c, unsigned level) const
 132 {
 133         if (is_a<print_tree>(c)) {
 134                 c.s << std::string(level, ' ') << name << " (" << class_name() << ")"
 135                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 136                     << std::endl;
 137         } else if (is_a<print_latex>(c)) {
 138                 c.s << TeX_name;
 139         } else if (is_a<print_python_repr>(c)) {
 140                 c.s << class_name() << "('" << name << "'";
 141                 if (TeX_name != "\\mbox{" + name + "}")
 142                         c.s << ",TeX_name='" << TeX_name << "'";
 143                 c.s << ')';
 144         } else
 145                 c.s << name;
 146 }
 147
 148 ex constant::evalf(int level) const
 149 {
 150         if (ef!=0) {
 151                 return ef();
 152         } else if (number != 0) {
 153                 return number->evalf();
 154         }
 155         return *this;
 156 }
 157
 158 // protected
 159
 160 /** Implementation of ex::diff() for a constant always returns 0.
 161  *
 162  *  @see ex::diff */
 163 ex constant::derivative(const symbol & s) const
 164 {
 165         return _ex0;
 166 }
 167
 168 int constant::compare_same_type(const basic & other) const
 169 {
 170         GINAC_ASSERT(is_exactly_a<constant>(other));
 171         const constant &o = static_cast<const constant &>(other);
 172
 173         if (serial == o.serial)
 174                 return 0;
 175         else
 176                 return serial < o.serial ? -1 : 1;
 177 }
 178
 179 bool constant::is_equal_same_type(const basic & other) const
 180 {
 181         GINAC_ASSERT(is_exactly_a<constant>(other));
 182         const constant &o = static_cast<const constant &>(other);
 183
 184         return serial == o.serial;
 185 }
 186
 187 unsigned constant::calchash(void) const
 188 {
 189         hashvalue = golden_ratio_hash(tinfo() ^ serial);
 190         // mask out numeric hashes:
 191         hashvalue &= 0x7FFFFFFFU;
 192
 193         setflag(status_flags::hash_calculated);
 194
 195         return hashvalue;
 196 }
 197
 198 //////////
 199 // new virtual functions which can be overridden by derived classes
 200 //////////
 201
 202 // none
 203
 204 //////////
 205 // non-virtual functions in this class
 206 //////////
 207
 208 // none
 209
 210 //////////
 211 // static member variables
 212 //////////
 213
 214 unsigned constant::next_serial = 0;
 215
 216 //////////
 217 // global constants
 218 //////////
 219
 220 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
 221 const constant Pi("Pi", PiEvalf, "\\pi");
 222
 223 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
 224  *  Diverts straight into CLN for evalf(). */
 225 const constant Euler("Euler", EulerEvalf, "\\gamma_E");
 226
 227 /** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
 228 const constant Catalan("Catalan", CatalanEvalf, "G");
 229
 230 } // namespace GiNaC