Add support for Texinfo-5.0.
[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-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_CONSTANT_H
24 #define GINAC_CONSTANT_H
25
26 #include "basic.h"
27 #include "ex.h"
28 #include "archive.h"
29
30 #include <string>
31
32 namespace GiNaC {
33
34 typedef ex (*evalffunctype)();
35         
36 /** This class holds constants, symbols with specific numerical value. Each
37  *  object of this class must either provide their own function to evaluate it
38  *  to class numeric or provide the constant as a numeric (if it's an exact
39  *  number). */
40 class constant : public basic
41 {
42         GINAC_DECLARE_REGISTERED_CLASS(constant, basic)
43         // other constructors
44 public:
45         constant(const std::string & initname, evalffunctype efun = 0, const std::string & texname = std::string(), unsigned domain = domain::complex);
46         constant(const std::string & initname, const numeric & initnumber, const std::string & texname = std::string(), unsigned domain = domain::complex);
47         
48         // functions overriding virtual functions from base classes
49 public:
50         bool info(unsigned inf) const;
51         ex evalf(int level = 0) const;
52         bool is_polynomial(const ex & var) const;
53         ex conjugate() const;
54         ex real_part() const;
55         ex imag_part() const;
56         void archive(archive_node& n) const;
57         void read_archive(const archive_node& n, lst& syms);
58 protected:
59         ex derivative(const symbol & s) const;
60         bool is_equal_same_type(const basic & other) const;
61         unsigned calchash() const;
62         
63         // non-virtual functions in this class
64 protected:
65         void do_print(const print_context & c, unsigned level) const;
66         void do_print_tree(const print_tree & c, unsigned level) const;
67         void do_print_latex(const print_latex & c, unsigned level) const;
68         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
69
70 // member variables
71 private:
72         std::string name;     ///< printname of this constant
73         std::string TeX_name; ///< LaTeX name
74         evalffunctype ef;
75         ex number;            ///< numerical value this constant evalf()s to
76         unsigned serial;      ///< unique serial number for comparison
77         static unsigned next_serial;
78         unsigned domain;      ///< numerical value this constant evalf()s to
79 };
80 GINAC_DECLARE_UNARCHIVER(constant); 
81
82 extern const constant Pi;
83 extern const constant Catalan;
84 extern const constant Euler;
85
86 } // namespace GiNaC
87
88 #endif // ndef GINAC_CONSTANT_H