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-2022 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 "constant.h"
  24 #include "numeric.h"
  25 #include "ex.h"
  26 #include "archive.h"
  27 #include "utils.h"
  28 #include "inifcns.h"
  29
  30 #include <iostream>
  31 #include <stdexcept>
  32 #include <string>
  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() : ef(nullptr), 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   : name(initname), ef(efun), serial(next_serial++), domain(dm)
  61 {
  62         if (texname.empty())
  63                 TeX_name = "\\mathrm{" + 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   : name(initname), ef(nullptr), number(initnumber), serial(next_serial++), domain(dm)
  71 {
  72         if (texname.empty())
  73                 TeX_name = "\\mathrm{" + name + "}";
  74         else
  75                 TeX_name = texname;
  76         setflag(status_flags::evaluated | status_flags::expanded);
  77 }
  78
  79 //////////
  80 // archiving
  81 //////////
  82
  83 void constant::read_archive(const archive_node &n, lst &sym_lst)
  84 {
  85         // Find constant by name (!! this is bad: 'twould be better if there
  86         // was a list of all global constants that we could search)
  87         std::string s;
  88         if (n.find_string("name", s)) {
  89                 if (s == Pi.name)
  90                         *this = Pi;
  91                 else if (s == Catalan.name)
  92                         *this = Catalan;
  93                 else if (s == Euler.name)
  94                         *this = Euler;
  95                 else
  96                         throw (std::runtime_error("unknown constant '" + s + "' in archive"));
  97         } else
  98                 throw (std::runtime_error("unnamed constant in archive"));
  99 }
 100 GINAC_BIND_UNARCHIVER(constant);
 101
 102 void constant::archive(archive_node &n) const
 103 {
 104         inherited::archive(n);
 105         n.add_string("name", name);
 106 }
 107
 108 //////////
 109 // functions overriding virtual functions from base classes
 110 //////////
 111
 112 // public
 113
 114 void constant::do_print(const print_context & c, unsigned level) const
 115 {
 116         c.s << name;
 117 }
 118
 119 void constant::do_print_tree(const print_tree & c, unsigned level) const
 120 {
 121         c.s << std::string(level, ' ') << name << " (" << class_name() << ")" << " @" << this
 122             << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 123             << std::endl;
 124 }
 125
 126 void constant::do_print_latex(const print_latex & c, unsigned level) const
 127 {
 128         c.s << TeX_name;
 129 }
 130
 131 void constant::do_print_python_repr(const print_python_repr & c, unsigned level) const
 132 {
 133         c.s << class_name() << "('" << name << "'";
 134         if (TeX_name != "\\mathrm{" + name + "}")
 135                 c.s << ",TeX_name='" << TeX_name << "'";
 136         c.s << ')';
 137 }
 138
 139 bool constant::info(unsigned inf) const
 140 {
 141         if (inf == info_flags::polynomial)
 142                 return true;
 143         if (inf == info_flags::real)
 144                 return domain==domain::real || domain==domain::positive ;
 145         if (inf==info_flags::positive || inf==info_flags::nonnegative)
 146                 return domain == domain::positive;
 147         else
 148                 return inherited::info(inf);
 149 }
 150
 151 ex constant::evalf() const
 152 {
 153         if (ef!=nullptr) {
 154                 return ef();
 155         } else {
 156                 return number.evalf();
 157         }
 158         return *this;
 159 }
 160
 161 bool constant::is_polynomial(const ex & var) const
 162 {
 163         return true;
 164 }
 165
 166 ex constant::conjugate() const
 167 {
 168         if ( domain==domain::real || domain==domain::positive )
 169                 return *this;
 170         return conjugate_function(*this).hold();
 171 }
 172
 173 ex constant::real_part() const
 174 {
 175         if ( domain==domain::real || domain==domain::positive )
 176                 return *this;
 177         return real_part_function(*this).hold();
 178 }
 179
 180 ex constant::imag_part() const
 181 {
 182         if ( domain==domain::real || domain==domain::positive )
 183                 return 0;
 184         return imag_part_function(*this).hold();
 185 }
 186
 187 // protected
 188
 189 /** Implementation of ex::diff() for a constant always returns 0.
 190  *
 191  *  @see ex::diff */
 192 ex constant::derivative(const symbol & s) const
 193 {
 194         return _ex0;
 195 }
 196
 197 int constant::compare_same_type(const basic & other) const
 198 {
 199         GINAC_ASSERT(is_exactly_a<constant>(other));
 200         const constant &o = static_cast<const constant &>(other);
 201
 202         if (serial == o.serial)
 203                 return 0;
 204         else
 205                 return serial < o.serial ? -1 : 1;
 206 }
 207
 208 bool constant::is_equal_same_type(const basic & other) const
 209 {
 210         GINAC_ASSERT(is_exactly_a<constant>(other));
 211         const constant &o = static_cast<const constant &>(other);
 212
 213         return serial == o.serial;
 214 }
 215
 216 unsigned constant::calchash() const
 217 {
 218         const void* typeid_this = (const void*)typeid(*this).name();
 219         hashvalue = golden_ratio_hash((uintptr_t)typeid_this ^ 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