ginac/expairseq.h

   1 /** @file expairseq.h
   2  *
   3  *  Interface to sequences of expression pairs. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2006 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_EXPAIRSEQ_H__
  24 #define __GINAC_EXPAIRSEQ_H__
  25
  26 #include <vector>
  27 #include <list>
  28 #include <memory>
  29 // CINT needs <algorithm> to work properly with <vector> and <list>
  30 #include <algorithm>
  31
  32 #include "expair.h"
  33
  34 namespace GiNaC {
  35
  36 /** Using hash tables can potentially enhance the asymptotic behaviour of
  37  *  combining n terms into one large sum (or n terms into one large product)
  38  *  from O(n*log(n)) to about O(n).  There are, however, several drawbacks.
  39  *  The constant in front of O(n) is quite large, when copying such an object
  40  *  one also has to copy the has table, comparison is quite expensive because
  41  *  there is no ordering any more, it doesn't help at all when combining two
  42  *  expairseqs because due to the presorted nature the behaviour would be
  43  *  O(n) anyways, the code is quite messy, etc, etc.  The code is here as
  44  *  an example for following generations to tinker with. */
  45 #define EXPAIRSEQ_USE_HASHTAB 0
  46
  47 typedef std::vector<expair> epvector;       ///< expair-vector
  48 typedef epvector::iterator epp;             ///< expair-vector pointer
  49 typedef std::list<epp> epplist;             ///< list of expair-vector pointers
  50 typedef std::vector<epplist> epplistvector; ///< vector of epplist
  51
  52 /** Complex conjugate every element of an epvector. Returns zero if this
  53  *  does not change anything. */
  54 epvector* conjugateepvector(const epvector&);
  55
  56 /** A sequence of class expair.
  57  *  This is used for time-critical classes like sums and products of terms
  58  *  since handling a list of coeff and rest is much faster than handling a
  59  *  list of products or powers, respectively. (Not incidentally, Maple does it
  60  *  the same way, maybe others too.)  The semantics is (at least) twofold:
  61  *  one for addition and one for multiplication and several methods have to
  62  *  be overridden by derived classes to reflect the change in semantics.
  63  *  However, most functionality turns out to be shared between addition and
  64  *  multiplication, which is the reason why there is this base class. */
  65 class expairseq : public basic
  66 {
  67         GINAC_DECLARE_REGISTERED_CLASS(expairseq, basic)
  68
  69         // other constructors
  70 public:
  71         expairseq(const ex & lh, const ex & rh);
  72         expairseq(const exvector & v);
  73         expairseq(const epvector & v, const ex & oc, bool do_index_renaming = false);
  74         expairseq(std::auto_ptr<epvector>, const ex & oc, bool do_index_renaming = false);
  75
  76         // functions overriding virtual functions from base classes
  77 public:
  78         unsigned precedence() const {return 10;}
  79         bool info(unsigned inf) const;
  80         size_t nops() const;
  81         ex op(size_t i) const;
  82         ex map(map_function & f) const;
  83         ex eval(int level=0) const;
  84         ex to_rational(exmap & repl) const;
  85         ex to_polynomial(exmap & repl) const;
  86         bool match(const ex & pattern, lst & repl_lst) const;
  87         ex subs(const exmap & m, unsigned options = 0) const;
  88         ex conjugate() const;
  89         bool is_polynomial(const ex & var) const;
  90 protected:
  91         bool is_equal_same_type(const basic & other) const;
  92         unsigned return_type() const;
  93         unsigned calchash() const;
  94         ex expand(unsigned options=0) const;
  95
  96         // new virtual functions which can be overridden by derived classes
  97 protected:
  98         virtual ex thisexpairseq(const epvector & v, const ex & oc, bool do_index_renaming = false) const;
  99         virtual ex thisexpairseq(std::auto_ptr<epvector> vp, const ex & oc, bool do_index_renaming = false) const;
 100         virtual void printseq(const print_context & c, char delim,
 101                               unsigned this_precedence,
 102                               unsigned upper_precedence) const;
 103         virtual void printpair(const print_context & c, const expair & p,
 104                                unsigned upper_precedence) const;
 105         virtual expair split_ex_to_pair(const ex & e) const;
 106         virtual expair combine_ex_with_coeff_to_pair(const ex & e,
 107                                                                                                  const ex & c) const;
 108         virtual expair combine_pair_with_coeff_to_pair(const expair & p,
 109                                                                                                    const ex & c) const;
 110         virtual ex recombine_pair_to_ex(const expair & p) const;
 111         virtual bool expair_needs_further_processing(epp it);
 112         virtual ex default_overall_coeff() const;
 113         virtual void combine_overall_coeff(const ex & c);
 114         virtual void combine_overall_coeff(const ex & c1, const ex & c2);
 115         virtual bool can_make_flat(const expair & p) const;
 116
 117         // non-virtual functions in this class
 118 protected:
 119         void do_print(const print_context & c, unsigned level) const;
 120         void do_print_tree(const print_tree & c, unsigned level) const;
 121         void construct_from_2_ex_via_exvector(const ex & lh, const ex & rh);
 122         void construct_from_2_ex(const ex & lh, const ex & rh);
 123         void construct_from_2_expairseq(const expairseq & s1,
 124                                         const expairseq & s2);
 125         void construct_from_expairseq_ex(const expairseq & s,
 126                                          const ex & e);
 127         void construct_from_exvector(const exvector & v);
 128         void construct_from_epvector(const epvector & v, bool do_index_renaming = false);
 129         void make_flat(const exvector & v);
 130         void make_flat(const epvector & v, bool do_index_renaming = false);
 131         void canonicalize();
 132         void combine_same_terms_sorted_seq();
 133 #if EXPAIRSEQ_USE_HASHTAB
 134         void combine_same_terms();
 135         unsigned calc_hashtabsize(unsigned sz) const;
 136         unsigned calc_hashindex(const ex & e) const;
 137         void shrink_hashtab();
 138         void remove_hashtab_entry(epvector::const_iterator element);
 139         void move_hashtab_entry(epvector::const_iterator oldpos,
 140                                 epvector::iterator newpos);
 141         void sorted_insert(epplist & eppl, epvector::const_iterator elem);
 142         void build_hashtab_and_combine(epvector::iterator & first_numeric,
 143                                        epvector::iterator & last_non_zero,
 144                                        vector<bool> & touched,
 145                                        unsigned & number_of_zeroes);
 146         void drop_coeff_0_terms(epvector::iterator & first_numeric,
 147                                 epvector::iterator & last_non_zero,
 148                                 vector<bool> & touched,
 149                                 unsigned & number_of_zeroes);
 150         bool has_coeff_0() const;
 151         void add_numerics_to_hashtab(epvector::iterator first_numeric,
 152                                      epvector::const_iterator last_non_zero);
 153 #endif // EXPAIRSEQ_USE_HASHTAB
 154         bool is_canonical() const;
 155         std::auto_ptr<epvector> expandchildren(unsigned options) const;
 156         std::auto_ptr<epvector> evalchildren(int level) const;
 157         std::auto_ptr<epvector> subschildren(const exmap & m, unsigned options = 0) const;
 158
 159 // member variables
 160
 161 protected:
 162         epvector seq;
 163         ex overall_coeff;
 164 #if EXPAIRSEQ_USE_HASHTAB
 165         epplistvector hashtab;
 166         unsigned hashtabsize;
 167         unsigned hashmask;
 168         static unsigned maxhashtabsize;
 169         static unsigned minhashtabsize;
 170         static unsigned hashtabfactor;
 171 #endif // EXPAIRSEQ_USE_HASHTAB
 172 };
 173
 174 } // namespace GiNaC
 175
 176 #endif // ndef __GINAC_EXPAIRSEQ_H__