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-2004 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)();
  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 constructors
  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         ex evalf(int level = 0) const;
  52 protected:
  53         ex derivative(const symbol & s) const;
  54         bool is_equal_same_type(const basic & other) const;
  55         unsigned calchash() const;
  56
  57         // non-virtual functions in this class
  58 protected:
  59         void do_print(const print_context & c, unsigned level) const;
  60         void do_print_tree(const print_tree & c, unsigned level) const;
  61         void do_print_latex(const print_latex & c, unsigned level) const;
  62         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
  63
  64 // member variables
  65 private:
  66         std::string name;     ///< printname of this constant
  67         std::string TeX_name; ///< LaTeX name
  68         evalffunctype ef;
  69         ex number;            ///< numerical value this constant evalf()s to
  70         unsigned serial;      ///< unique serial number for comparison
  71         static unsigned next_serial;
  72 };
  73
  74 extern const constant Pi;
  75 extern const constant Catalan;
  76 extern const constant Euler;
  77
  78 // utility functions
  79
  80 /** Specialization of is_exactly_a<constant>(obj) for constant objects. */
  81 template<> inline bool is_exactly_a<constant>(const basic & obj)
  82 {
  83         return obj.tinfo()==TINFO_constant;
  84 }
  85
  86 } // namespace GiNaC
  87
  88 #endif // ndef __GINAC_CONSTANT_H__