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 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 <ginac/basic.h>
  28
  29 /** This class holds constants, symbols with specific numerical value. Each
  30  *  object of this class must either provide their own function to evaluate it
  31  *  to class numeric or provide the constant as a numeric (if it's an exact
  32  *  number). */
  33 class constant : public basic
  34 {
  35
  36 // member functions
  37
  38     // default constructor, destructor, copy constructor assignment operator and helpers
  39 public:
  40     ~constant();
  41     constant(constant const & other);
  42     // constant const & operator=(constant const & other); /* it's pervert! */
  43 protected:
  44     void copy(constant const & other);
  45     void destroy(bool call_parent);
  46
  47     // other constructors
  48 public:
  49     constant(string const & initname, ex (*efun)()=0);
  50     constant(string const & initname, numeric const & initnumber);
  51
  52     // functions overriding virtual functions from bases classes
  53 public:
  54     basic * duplicate() const;
  55     void printraw(ostream & os) const;
  56     void print(ostream & os, unsigned upper_precedence=0) const;
  57     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
  58     ex evalf(int level=0) const;
  59     ex diff(symbol const & s) const;
  60 protected:
  61     int compare_same_type(basic const & other) const;
  62     bool is_equal_same_type(basic const & other) 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     string name;
  74     ex (*ef)();
  75     numeric * number;
  76     bool fct_assigned;
  77     unsigned serial;  //!< unique serial number for comparision
  78     static unsigned next_serial;
  79 };
  80
  81 // global constants
  82
  83 extern const constant some_constant;
  84 extern type_info const & typeid_constant;
  85
  86 // extern const numeric I;
  87 extern const constant Pi;
  88 extern const constant Catalan;
  89 extern const constant EulerGamma;
  90
  91 #endif // ndef __GINAC_CONSTANT_H__