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