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-2008 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  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 "archive.h"
  31 #include "utils.h"
  32 #include "inifcns.h"
  33
  34 namespace GiNaC {
  35
  36 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(constant, basic,
  37   print_func<print_context>(&constant::do_print).
  38   print_func<print_latex>(&constant::do_print_latex).
  39   print_func<print_tree>(&constant::do_print_tree).
  40   print_func<print_python_repr>(&constant::do_print_python_repr))
  41
  42 //////////
  43 // default constructor
  44 //////////
  45
  46 // public
  47
  48 constant::constant() : basic(&constant::tinfo_static), ef(0), serial(next_serial++), domain(domain::complex)
  49 {
  50         setflag(status_flags::evaluated | status_flags::expanded);
  51 }
  52
  53 //////////
  54 // other constructors
  55 //////////
  56
  57 // public
  58
  59 constant::constant(const std::string & initname, evalffunctype efun, const std::string & texname, unsigned dm)
  60   : basic(&constant::tinfo_static), name(initname), ef(efun), serial(next_serial++), domain(dm)
  61 {
  62         if (texname.empty())
  63                 TeX_name = "\\mbox{" + name + "}";
  64         else
  65                 TeX_name = texname;
  66         setflag(status_flags::evaluated | status_flags::expanded);
  67 }
  68
  69 constant::constant(const std::string & initname, const numeric & initnumber, const std::string & texname, unsigned dm)
  70   : basic(&constant::tinfo_static), name(initname), ef(0), number(initnumber), serial(next_serial++), domain(dm)
  71 {
  72         if (texname.empty())
  73                 TeX_name = "\\mbox{" + name + "}";
  74         else
  75                 TeX_name = texname;
  76         setflag(status_flags::evaluated | status_flags::expanded);
  77 }
  78
  79 //////////
  80 // archiving
  81 //////////
  82
  83 constant::constant(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst) {}
  84
  85 ex constant::unarchive(const archive_node &n, lst &sym_lst)
  86 {
  87         // Find constant by name (!! this is bad: 'twould be better if there
  88         // was a list of all global constants that we could search)
  89         std::string s;
  90         if (n.find_string("name", s)) {
  91                 if (s == Pi.name)
  92                         return Pi;
  93                 else if (s == Catalan.name)
  94                         return Catalan;
  95                 else if (s == Euler.name)
  96                         return Euler;
  97                 else
  98                         throw (std::runtime_error("unknown constant '" + s + "' in archive"));
  99         } else
 100                 throw (std::runtime_error("unnamed constant in archive"));
 101 }
 102
 103 void constant::archive(archive_node &n) const
 104 {
 105         inherited::archive(n);
 106         n.add_string("name", name);
 107 }
 108
 109 //////////
 110 // functions overriding virtual functions from base classes
 111 //////////
 112
 113 // public
 114
 115 void constant::do_print(const print_context & c, unsigned level) const
 116 {
 117         c.s << name;
 118 }
 119
 120 void constant::do_print_tree(const print_tree & c, unsigned level) const
 121 {
 122         c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
 123             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 124             << std::endl;
 125 }
 126
 127 void constant::do_print_latex(const print_latex & c, unsigned level) const
 128 {
 129         c.s << TeX_name;
 130 }
 131
 132 void constant::do_print_python_repr(const print_python_repr & c, unsigned level) const
 133 {
 134         c.s << class_name() << "('" << name << "'";
 135         if (TeX_name != "\\mbox{" + name + "}")
 136                 c.s << ",TeX_name='" << TeX_name << "'";
 137         c.s << ')';
 138 }
 139
 140 bool constant::info(unsigned inf) const
 141 {
 142         if (inf == info_flags::polynomial)
 143                 return true;
 144         if (inf == info_flags::real)
 145                 return domain==domain::real || domain==domain::positive ;
 146         if (inf==info_flags::positive || inf==info_flags::nonnegative)
 147                 return domain == domain::positive;
 148         else
 149                 return inherited::info(inf);
 150 }
 151
 152 ex constant::evalf(int level) const
 153 {
 154         if (ef!=0) {
 155                 return ef();
 156         } else {
 157                 return number.evalf();
 158         }
 159         return *this;
 160 }
 161
 162 bool constant::is_polynomial(const ex & var) const
 163 {
 164         return true;
 165 }
 166
 167 ex constant::conjugate() const
 168 {
 169         if ( domain==domain::real || domain==domain::positive )
 170                 return *this;
 171         return conjugate_function(*this).hold();
 172 }
 173
 174 ex constant::real_part() const
 175 {
 176         if ( domain==domain::real || domain==domain::positive )
 177                 return *this;
 178         return real_part_function(*this).hold();
 179 }
 180
 181 ex constant::imag_part() const
 182 {
 183         if ( domain==domain::real || domain==domain::positive )
 184                 return 0;
 185         return imag_part_function(*this).hold();
 186 }
 187
 188 // protected
 189
 190 /** Implementation of ex::diff() for a constant always returns 0.
 191  *
 192  *  @see ex::diff */
 193 ex constant::derivative(const symbol & s) const
 194 {
 195         return _ex0;
 196 }
 197
 198 int constant::compare_same_type(const basic & other) const
 199 {
 200         GINAC_ASSERT(is_exactly_a<constant>(other));
 201         const constant &o = static_cast<const constant &>(other);
 202
 203         if (serial == o.serial)
 204                 return 0;
 205         else
 206                 return serial < o.serial ? -1 : 1;
 207 }
 208
 209 bool constant::is_equal_same_type(const basic & other) const
 210 {
 211         GINAC_ASSERT(is_exactly_a<constant>(other));
 212         const constant &o = static_cast<const constant &>(other);
 213
 214         return serial == o.serial;
 215 }
 216
 217 unsigned constant::calchash() const
 218 {
 219         hashvalue = golden_ratio_hash((p_int)tinfo() ^ serial);
 220
 221         setflag(status_flags::hash_calculated);
 222
 223         return hashvalue;
 224 }
 225
 226 //////////
 227 // new virtual functions which can be overridden by derived classes
 228 //////////
 229
 230 // none
 231
 232 //////////
 233 // non-virtual functions in this class
 234 //////////
 235
 236 // none
 237
 238 //////////
 239 // static member variables
 240 //////////
 241
 242 unsigned constant::next_serial = 0;
 243
 244 //////////
 245 // global constants
 246 //////////
 247
 248 /**  Pi. (3.14159...)  Diverts straight into CLN for evalf(). */
 249 const constant Pi("Pi", PiEvalf, "\\pi", domain::positive);
 250
 251 /** Euler's constant. (0.57721...)  Sometimes called Euler-Mascheroni constant.
 252  *  Diverts straight into CLN for evalf(). */
 253 const constant Euler("Euler", EulerEvalf, "\\gamma_E", domain::positive);
 254
 255 /** Catalan's constant. (0.91597...)  Diverts straight into CLN for evalf(). */
 256 const constant Catalan("Catalan", CatalanEvalf, "G", domain::positive);
 257
 258 } // namespace GiNaC