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);
  47         constant(const std::string & initname, const numeric & initnumber);
  48
  49         // functions overriding virtual functions from bases classes
  50 public:
  51         void print(std::ostream & os, unsigned upper_precedence = 0) const;
  52         void printraw(std::ostream & os) const;
  53         void printtree(std::ostream & os, unsigned indent) const;
  54         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence = 0) const;
  55         int degree(const ex & s) const;
  56         int ldegree(const ex & s) const;
  57         ex coeff(const ex & s, int n = 1) const;
  58         ex evalf(int level = 0) const;
  59 protected:
  60         ex derivative(const symbol & s) const;
  61         bool is_equal_same_type(const basic & other) const;
  62         unsigned calchash(void) const;
  63
  64         // new virtual functions which can be overridden by derived classes
  65         // none
  66
  67         // non-virtual functions in this class
  68         // none
  69
  70 // member variables
  71
  72 private:
  73         std::string name;   ///< printname of this constant
  74         evalffunctype ef;
  75         numeric *number;    ///< numerical value this constant evalf()s to
  76         unsigned serial;    ///< unique serial number for comparison
  77         static unsigned next_serial;
  78 };
  79
  80 extern const constant Pi;
  81 extern const constant Catalan;
  82 extern const constant Euler;
  83
  84 // utility functions
  85 inline const constant &ex_to_constant(const ex &e)
  86 {
  87         return static_cast<const constant &>(*e.bp);
  88 }
  89
  90 } // namespace GiNaC
  91
  92 #endif // ndef __GINAC_CONSTANT_H__