- Instead of just totally symmetric or antisymmetric, complex symmetries
[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-2001 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 ctors
45 public:
46         power(const ex & lh, const ex & rh);
47         power(const ex & lh, const numeric & rh);
48         
49         // functions overriding virtual functions from bases classes
50 public:
51         void print(const print_context & c, unsigned level = 0) const;
52         unsigned precedence(void) const {return 60;}
53         bool info(unsigned inf) const;
54         unsigned nops() const;
55         ex & let_op(int i);
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(void) const;
63         ex series(const relational & s, int order, unsigned options = 0) const;
64         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
65         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
66         ex to_rational(lst &repl_lst) const;
67         exvector get_free_indices(void) const;
68         ex simplify_ncmul(const exvector & v) const;
69 protected:
70         ex derivative(const symbol & s) const;
71         unsigned return_type(void) const;
72         unsigned return_type_tinfo(void) 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         ex expand_add(const add & a, int n) const;
81         ex expand_add_2(const add & a) const;
82         ex expand_mul(const mul & m, const numeric & n) const;
83         //ex expand_commutative_3(const ex & basis, const numeric & exponent,
84         //                        unsigned options) const;
85         //ex expand_noncommutative(const ex & basis, const numeric & exponent, unsigned options) const;
86         
87 // member variables
88         
89 protected:
90         ex basis;
91         ex exponent;
92 };
93
94 // utility functions
95 inline const power &ex_to_power(const ex &e)
96 {
97         return static_cast<const power &>(*e.bp);
98 }
99
100 // wrapper functions
101
102 /** Symbolic exponentiation.  Returns a power-object as a new expression.
103  *
104  *  @param b the basis expression
105  *  @param e the exponent expression */
106 inline ex pow(const ex & b, const ex & e)
107 {
108         return power(b, e);
109 }
110
111 /** Square root expression.  Returns a power-object with exponent 1/2. */
112 ex sqrt(const ex & a);
113
114 } // namespace GiNaC
115
116 #endif // ndef __GINAC_POWER_H__