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         bool info(unsigned inf) const;
  53         unsigned nops() const;
  54         ex & let_op(int i);
  55         int degree(const ex & s) const;
  56         int ldegree(const ex & s) const;
  57         ex coeff(const ex & s, int n = 1) const;
  58         ex eval(int level=0) const;
  59         ex evalf(int level=0) const;
  60         ex series(const relational & s, int order, unsigned options = 0) const;
  61         ex subs(const lst & ls, const lst & lr) const;
  62         ex normal(lst &sym_lst, lst &repl_lst, int level = 0) const;
  63         ex to_rational(lst &repl_lst) const;
  64         exvector get_free_indices(void) const;
  65         ex simplify_ncmul(const exvector & v) const;
  66 protected:
  67         ex derivative(const symbol & s) const;
  68         unsigned return_type(void) const;
  69         unsigned return_type_tinfo(void) const;
  70         ex expand(unsigned options = 0) const;
  71
  72         // new virtual functions which can be overridden by derived classes
  73         // none
  74
  75         // non-virtual functions in this class
  76 protected:
  77         ex expand_add(const add & a, int n) const;
  78         ex expand_add_2(const add & a) const;
  79         ex expand_mul(const mul & m, const numeric & n) const;
  80         //ex expand_commutative_3(const ex & basis, const numeric & exponent,
  81         //                        unsigned options) const;
  82         //ex expand_noncommutative(const ex & basis, const numeric & exponent, unsigned options) const;
  83
  84 // member variables
  85
  86 protected:
  87         ex basis;
  88         ex exponent;
  89         static unsigned precedence;
  90 };
  91
  92 // utility functions
  93 inline const power &ex_to_power(const ex &e)
  94 {
  95         return static_cast<const power &>(*e.bp);
  96 }
  97
  98 // wrapper functions
  99
 100 /** Symbolic exponentiation.  Returns a power-object as a new expression.
 101  *
 102  *  @param b the basis expression
 103  *  @param e the exponent expression */
 104 inline ex pow(const ex & b, const ex & e)
 105 {
 106         return power(b, e);
 107 }
 108
 109 /** Square root expression.  Returns a power-object with exponent 1/2. */
 110 ex sqrt(const ex & a);
 111
 112 } // namespace GiNaC
 113
 114 #endif // ndef __GINAC_POWER_H__