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