ginac/constant.h

   1 /** @file constant.h
   2  *
   3  *  Interface to 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 #ifndef __GINAC_CONSTANT_H__
  24 #define __GINAC_CONSTANT_H__
  25
  26 #include <string>
  27 #include "basic.h"
  28 #include "ex.h"
  29
  30 namespace GiNaC {
  31
  32 typedef ex (*evalffunctype)(void);
  33
  34 /** This class holds constants, symbols with specific numerical value. Each
  35  *  object of this class must either provide their own function to evaluate it
  36  *  to class numeric or provide the constant as a numeric (if it's an exact
  37  *  number). */
  38 class constant : public basic
  39 {
  40         GINAC_DECLARE_REGISTERED_CLASS(constant, basic)
  41
  42 // member functions
  43
  44         // other ctors
  45 public:
  46         constant(const std::string & initname, evalffunctype efun = 0, const std::string & texname = std::string());
  47         constant(const std::string & initname, const numeric & initnumber, const std::string & texname = std::string());
  48
  49         // functions overriding virtual functions from base classes
  50 public:
  51         void print(const print_context & c, unsigned level = 0) const;
  52         int degree(const ex & s) const;
  53         int ldegree(const ex & s) const;
  54         ex coeff(const ex & s, int n = 1) const;
  55         ex evalf(int level = 0) const;
  56 protected:
  57         ex derivative(const symbol & s) const;
  58         bool is_equal_same_type(const basic & other) const;
  59         unsigned calchash(void) const;
  60
  61         // new virtual functions which can be overridden by derived classes
  62         // none
  63
  64         // non-virtual functions in this class
  65         // none
  66
  67 // member variables
  68
  69 private:
  70         std::string name;     ///< printname of this constant
  71         std::string TeX_name; ///< LaTeX name
  72         evalffunctype ef;
  73         numeric *number;      ///< numerical value this constant evalf()s to
  74         unsigned serial;      ///< unique serial number for comparison
  75         static unsigned next_serial;
  76 };
  77
  78 extern const constant Pi;
  79 extern const constant Catalan;
  80 extern const constant Euler;
  81
  82 // utility functions
  83
  84 /** Return the constant object handled by an ex.  Deprecated: use ex_to<constant>().
  85  *  This is unsafe: you need to check the type first. */
  86 inline const constant &ex_to_constant(const ex &e)
  87 {
  88         return static_cast<const constant &>(*e.bp);
  89 }
  90
  91 /** Specialization of is_exactly_a<constant>(obj) for constant objects. */
  92 template<> inline bool is_exactly_a<constant>(const basic & obj)
  93 {
  94         return obj.tinfo()==TINFO_constant;
  95 }
  96
  97 } // namespace GiNaC
  98
  99 #endif // ndef __GINAC_CONSTANT_H__