#ifndef around namespace GiNaC { }
[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 /** This class holds constants, symbols with specific numerical value. Each
34  *  object of this class must either provide their own function to evaluate it
35  *  to class numeric or provide the constant as a numeric (if it's an exact
36  *  number). */
37 class constant : public basic
38 {
39
40 // member functions
41
42     // default constructor, destructor, copy constructor assignment operator and helpers
43 public:
44     ~constant();
45     constant(constant const & other);
46     // constant const & operator=(constant const & other); /* it's pervert! */
47 protected:
48     void copy(constant const & other);
49     void destroy(bool call_parent);
50
51     // other constructors
52 public:
53     constant(string const & initname, ex (*efun)()=0);
54     constant(string const & initname, numeric const & initnumber);
55
56     // functions overriding virtual functions from bases classes
57 public:
58     basic * duplicate() const;
59     void printraw(ostream & os) const;
60     void print(ostream & os, unsigned upper_precedence=0) const;
61     void printcsrc(ostream & os, unsigned type, unsigned upper_precedence=0) const;
62     ex evalf(int level=0) const;
63     ex diff(symbol const & s) const;
64 protected:
65     int compare_same_type(basic const & other) const;
66     bool is_equal_same_type(basic const & other) const;
67     
68     // new virtual functions which can be overridden by derived classes
69     // none
70
71     // non-virtual functions in this class
72     // none
73
74 // member variables
75
76 private:
77     string name;
78     ex (*ef)();
79     numeric * number;
80     bool fct_assigned;
81     unsigned serial;  //!< unique serial number for comparision
82     static unsigned next_serial;
83 };
84
85 // global constants
86
87 extern const constant some_constant;
88 extern type_info const & typeid_constant;
89
90 // extern const numeric I;
91 extern const constant Pi;
92 extern const constant Catalan;
93 extern const constant EulerGamma;
94
95 #ifndef NO_GINAC_NAMESPACE
96 } // namespace GiNaC
97 #endif // ndef NO_GINAC_NAMESPACE
98
99 #endif // ndef __GINAC_CONSTANT_H__