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