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-2000 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         // default constructor, destructor, copy constructor assignment operator and helpers
  46 public:
  47         constant();
  48         ~constant();
  49         constant(const constant & other);
  50         // const constant & operator=(const constant & other); /* it's pervert! */
  51 protected:
  52         void copy(const constant & other);
  53         void destroy(bool call_parent);
  54
  55         // other constructors
  56 public:
  57         constant(const std::string & initname, evalffunctype efun=0);
  58         constant(const std::string & initname, const numeric & initnumber);
  59
  60         // functions overriding virtual functions from bases classes
  61 public:
  62         basic * duplicate() const;
  63         void print(std::ostream & os, unsigned upper_precedence=0) const;
  64         void printraw(std::ostream & os) const;
  65         void printtree(std::ostream & os, unsigned indent) const;
  66         void printcsrc(std::ostream & os, unsigned type, unsigned upper_precedence=0) const;
  67         ex evalf(int level=0) const;
  68 protected:
  69         ex derivative(const symbol & s) const;
  70         int compare_same_type(const basic & other) const;
  71         bool is_equal_same_type(const basic & other) const;
  72
  73         // new virtual functions which can be overridden by derived classes
  74         // none
  75
  76         // non-virtual functions in this class
  77         // none
  78
  79 // member variables
  80
  81 private:
  82         std::string name;
  83         evalffunctype ef;
  84         numeric * number;
  85         // bool fct_assigned;
  86         unsigned serial;  //!< unique serial number for comparision
  87         static unsigned next_serial;
  88 };
  89
  90 // global constants
  91
  92 extern const constant some_constant;
  93 extern const std::type_info & typeid_constant;
  94
  95 extern const constant Pi;
  96 extern const constant Catalan;
  97 extern const constant Euler;
  98
  99 #ifndef NO_NAMESPACE_GINAC
 100 } // namespace GiNaC
 101 #endif // ndef NO_NAMESPACE_GINAC
 102
 103 #endif // ndef __GINAC_CONSTANT_H__