the old methods of ex remain for compatibility
[ginac.git] / ginac / power.h
1 /** @file power.h
2  *
3  *  Interface to GiNaC's symbolic exponentiation (basis^exponent). */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2003 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_POWER_H__
24 #define __GINAC_POWER_H__
25
26 #include "basic.h"
27 #include "ex.h"
28
29 namespace GiNaC {
30
31 class numeric;
32 class add;
33
34 /** This class holds a two-component object, a basis and and exponent
35  *  representing exponentiation. */
36 class power : public basic
37 {
38         GINAC_DECLARE_REGISTERED_CLASS(power, basic)
39         
40         friend class mul;
41         
42 // member functions
43         
44         // other constructors
45 public:
46         power(const ex & lh, const ex & rh) : inherited(TINFO_power), basis(lh), exponent(rh) {}
47         template<typename T> power(const ex & lh, const T & rh) : inherited(TINFO_power), basis(lh), exponent(rh) {}
48         
49         // functions overriding virtual functions from base classes
50 public:
51         unsigned precedence() const {return 60;}
52         bool info(unsigned inf) const;
53         size_t nops() const;
54         ex op(size_t i) const;
55         ex map(map_function & f) const;
56         int degree(const ex & s) const;
57         int ldegree(const ex & s) const;
58         ex coeff(const ex & s, int n = 1) const;
59         ex eval(int level=0) const;
60         ex evalf(int level=0) const;
61         ex evalm() const;
62         ex series(const relational & s, int order, unsigned options = 0) const;
63         ex subs(const exmap & m, unsigned options = 0) const;
64         ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
65         ex to_rational(exmap & repl) const;
66         ex to_polynomial(exmap & repl) const;
67         exvector get_free_indices() const;
68 protected:
69         ex derivative(const symbol & s) const;
70         ex eval_ncmul(const exvector & v) const;
71         unsigned return_type() const;
72         unsigned return_type_tinfo() const;
73         ex expand(unsigned options = 0) const;
74         
75         // new virtual functions which can be overridden by derived classes
76         // none
77         
78         // non-virtual functions in this class
79 protected:
80         void print_power(const print_context & c, const char *powersymbol, const char *openbrace, const char *closebrace, unsigned level) const;
81         void do_print_dflt(const print_dflt & c, unsigned level) const;
82         void do_print_latex(const print_latex & c, unsigned level) const;
83         void do_print_csrc(const print_csrc & c, unsigned level) const;
84         void do_print_python(const print_python & c, unsigned level) const;
85         void do_print_python_repr(const print_python_repr & c, unsigned level) const;
86
87         ex expand_add(const add & a, int n) const;
88         ex expand_add_2(const add & a) const;
89         ex expand_mul(const mul & m, const numeric & n) const;
90         
91 // member variables
92         
93 protected:
94         ex basis;
95         ex exponent;
96 };
97
98 // utility functions
99
100 /** Efficient specialization of is_exactly_a<power>(obj) for power objects. */
101 template<> inline bool is_exactly_a<power>(const basic & obj)
102 {
103         return obj.tinfo()==TINFO_power;
104 }
105
106 // wrapper functions
107
108 /** Symbolic exponentiation.  Returns a power-object as a new expression.
109  *
110  *  @param b the basis expression
111  *  @param e the exponent expression */
112 inline ex pow(const ex & b, const ex & e)
113 {
114         return power(b, e);
115 }
116 template<typename T1, typename T2>
117 inline ex pow(const T1 & b, const T2 & e)
118 {
119         return power(ex(b), ex(e));
120 }
121
122 /** Square root expression.  Returns a power-object with exponent 1/2. */
123 inline ex sqrt(const ex & a)
124 {
125         extern const ex _ex1_2;
126         return power(a,_ex1_2);
127 }
128
129 } // namespace GiNaC
130
131 #endif // ndef __GINAC_POWER_H__