ginac/expairseq.h

   1 /** @file expairseq.h
   2  *
   3  *  Interface to sequences of expression pairs. */
   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_EXPAIRSEQ_H__
  24 #define __GINAC_EXPAIRSEQ_H__
  25
  26 #include <vector>
  27 #include <list>
  28 // CINT needs <algorithm> to work properly with <vector> and <list>
  29 #include <algorithm>
  30
  31 #include "expair.h"
  32
  33 namespace GiNaC {
  34
  35 /** Using hash tables can potentially enhance the asymptotic behaviour of
  36  *  combining n terms into one large sum (or n terms into one large product)
  37  *  from O(n*log(n)) to about O(n).  There are, however, several drawbacks.
  38  *  The constant in front of O(n) is quite large, when copying such an object
  39  *  one also has to copy the has table, comparison is quite expensive because
  40  *  there is no ordering any more, it doesn't help at all when combining two
  41  *  expairseqs because due to the presorted nature the behaviour would be
  42  *  O(n) anyways, the code is quite messy, etc, etc.  The code is here as
  43  *  an example for following generations to tinker with. */
  44 #define EXPAIRSEQ_USE_HASHTAB 0
  45
  46 typedef std::vector<expair> epvector;       ///< expair-vector
  47 typedef epvector::iterator epviter;         ///< expair-vector iterator
  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 /** A sequence of class expair.
  53  *  This is used for time-critical classes like sums and products of terms
  54  *  since handling a list of coeff and rest is much faster than handling a
  55  *  list of products or powers, respectively. (Not incidentally, Maple does it
  56  *  the same way, maybe others too.)  The semantics is (at least) twofold:
  57  *  one for addition and one for multiplication and several methods have to
  58  *  be overridden by derived classes to reflect the change in semantics.
  59  *  However, most functionality turns out to be shared between addition and
  60  *  multiplication, which is the reason why there is this base class. */
  61 class expairseq : public basic
  62 {
  63         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(expairseq, basic)
  64
  65 // member functions
  66
  67         // default ctor, dtor, copy ctor assignment operator and helpers
  68 public:
  69         expairseq() : basic(TINFO_expairseq)
  70 #if EXPAIRSEQ_USE_HASHTAB
  71                                             , hashtabsize(0)
  72 #endif // EXPAIRSEQ_USE_HASHTAB
  73         { }
  74         ~expairseq() { destroy(false); }
  75         expairseq(const expairseq & other);
  76         const expairseq & operator=(const expairseq & other);
  77 protected:
  78         void copy(const expairseq & other);
  79         void destroy(bool call_parent);
  80         // other ctors
  81 public:
  82         expairseq(const ex & lh, const ex & rh);
  83         expairseq(const exvector & v);
  84         expairseq(const epvector & v, const ex & oc);
  85         expairseq(epvector * vp, const ex & oc); // vp will be deleted
  86
  87         // functions overriding virtual functions from bases classes
  88 public:
  89         basic * duplicate() const;
  90         void print(const print_context & c, unsigned level = 0) const;
  91         unsigned precedence(void) const {return 10;}
  92         bool info(unsigned inf) const;
  93         unsigned nops() const;
  94         ex op(int i) const;
  95         ex & let_op(int i);
  96         ex map(map_function & f) const;
  97         ex eval(int level=0) const;
  98         ex evalf(int level=0) const;
  99         ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
 100         ex to_rational(lst &repl_lst) const;
 101         bool match(const ex & pattern, lst & repl_lst) const;
 102         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
 103 protected:
 104         ex derivative(const symbol & s) const;
 105         int compare_same_type(const basic & other) const;
 106         bool is_equal_same_type(const basic & other) const;
 107         unsigned return_type(void) const;
 108         unsigned calchash(void) const;
 109         ex expand(unsigned options=0) const;
 110
 111         // new virtual functions which can be overridden by derived classes
 112 protected:
 113         virtual ex thisexpairseq(const epvector & v, const ex & oc) const;
 114         virtual ex thisexpairseq(epvector * vp, const ex & oc) const;
 115         virtual void printseq(const print_context & c, char delim,
 116                               unsigned this_precedence,
 117                               unsigned upper_precedence) const;
 118         virtual void printpair(const print_context & c, const expair & p,
 119                                unsigned upper_precedence) const;
 120         virtual expair split_ex_to_pair(const ex & e) const;
 121         virtual expair combine_ex_with_coeff_to_pair(const ex & e,
 122                                                                                                  const ex & c) const;
 123         virtual expair combine_pair_with_coeff_to_pair(const expair & p,
 124                                                                                                    const ex & c) const;
 125         virtual ex recombine_pair_to_ex(const expair & p) const;
 126         virtual bool expair_needs_further_processing(epp it);
 127         virtual ex default_overall_coeff(void) const;
 128         virtual void combine_overall_coeff(const ex & c);
 129         virtual void combine_overall_coeff(const ex & c1, const ex & c2);
 130         virtual bool can_make_flat(const expair & p) const;
 131
 132         // non-virtual functions in this class
 133 protected:
 134         void construct_from_2_ex_via_exvector(const ex & lh, const ex & rh);
 135         void construct_from_2_ex(const ex & lh, const ex & rh);
 136         void construct_from_2_expairseq(const expairseq & s1,
 137                                         const expairseq & s2);
 138         void construct_from_expairseq_ex(const expairseq & s,
 139                                          const ex & e);
 140         void construct_from_exvector(const exvector & v);
 141         void construct_from_epvector(const epvector & v);
 142         void make_flat(const exvector & v);
 143         void make_flat(const epvector & v);
 144         void canonicalize(void);
 145         void combine_same_terms_sorted_seq(void);
 146 #if EXPAIRSEQ_USE_HASHTAB
 147         void combine_same_terms(void);
 148         unsigned calc_hashtabsize(unsigned sz) const;
 149         unsigned calc_hashindex(const ex & e) const;
 150         void shrink_hashtab(void);
 151         void remove_hashtab_entry(epvector::const_iterator element);
 152         void move_hashtab_entry(epvector::const_iterator oldpos,
 153                                 epvector::iterator newpos);
 154         void sorted_insert(epplist & eppl, epp elem);
 155         void build_hashtab_and_combine(epvector::iterator & first_numeric,
 156                                        epvector::iterator & last_non_zero,
 157                                        vector<bool> & touched,
 158                                        unsigned & number_of_zeroes);
 159         void drop_coeff_0_terms(epvector::iterator & first_numeric,
 160                                 epvector::iterator & last_non_zero,
 161                                 vector<bool> & touched,
 162                                 unsigned & number_of_zeroes);
 163         bool has_coeff_0(void) const;
 164         void add_numerics_to_hashtab(epvector::iterator first_numeric,
 165                                      epvector::const_iterator last_non_zero);
 166 #endif // EXPAIRSEQ_USE_HASHTAB
 167         bool is_canonical() const;
 168         epvector * expandchildren(unsigned options) const;
 169         epvector * evalchildren(int level) const;
 170         epvector evalfchildren(int level) const;
 171         epvector normalchildren(int level) const;
 172         epvector diffchildren(const symbol & s) const;
 173         epvector * subschildren(const lst & ls, const lst & lr, bool no_pattern = false) const;
 174
 175 // member variables
 176
 177 protected:
 178         epvector seq;
 179         ex overall_coeff;
 180 #if EXPAIRSEQ_USE_HASHTAB
 181         epplistvector hashtab;
 182         unsigned hashtabsize;
 183         unsigned hashmask;
 184         static unsigned maxhashtabsize;
 185         static unsigned minhashtabsize;
 186         static unsigned hashtabfactor;
 187 #endif // EXPAIRSEQ_USE_HASHTAB
 188 };
 189
 190 // utility functions
 191
 192 /** Return the expairseq object handled by an ex.
 193  *  This is unsafe: you need to check the type first. */
 194 inline const expairseq &ex_to_expairseq(const ex &e)
 195 {
 196         return static_cast<const expairseq &>(*e.bp);
 197 }
 198
 199 /** Specialization of is_exactly_a<expairseq>(obj) for expairseq objects. */
 200 template<> inline bool is_exactly_a<expairseq>(const basic & obj)
 201 {
 202         return obj.tinfo()==TINFO_expairseq;
 203 }
 204
 205 } // namespace GiNaC
 206
 207 #endif // ndef __GINAC_EXPAIRSEQ_H__