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
  29 #ifndef NO_NAMESPACE_GINAC
  30 namespace GiNaC {
  31 #endif // ndef NO_NAMESPACE_GINAC
  32
  33 typedef ex (*evalffunctype)(void);
  34
  35 /** This class holds constants, symbols with specific numerical value. Each
  36  *  object of this class must either provide their own function to evaluate it
  37  *  to class numeric or provide the constant as a numeric (if it's an exact
  38  *  number). */
  39 class constant : public basic
  40 {
  41         GINAC_DECLARE_REGISTERED_CLASS(constant, basic)
  42
  43 // member functions
  44
  45         // other constructors
  46 public:
  47         constant(const std::string & initname, evalffunctype efun=0);
  48         constant(const std::string & initname, const numeric & initnumber);
  49
  50         // functions overriding virtual functions from bases classes
  51 public:
  52         void print(std::ostream & os, unsigned upper_precedence=0) const;
  53         void printraw(std::ostream & os) const;
  54         void printtree(std::ostream & os, unsigned indent) const;
  55         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  56         ex evalf(int level=0) const;
  57 protected:
  58         ex derivative(const symbol & s) const;
  59         bool is_equal_same_type(const basic & other) 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;
  71         evalffunctype ef;
  72         numeric * number;
  73         unsigned serial;  //!  unique serial number for comparision
  74         static unsigned next_serial;
  75 };
  76
  77 extern const constant Pi;
  78 extern const constant Catalan;
  79 extern const constant Euler;
  80
  81 #ifndef NO_NAMESPACE_GINAC
  82 } // namespace GiNaC
  83 #endif // ndef NO_NAMESPACE_GINAC
  84
  85 #endif // ndef __GINAC_CONSTANT_H__