/** @file expairseq.h
*
- * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ * Interface to sequences of expression pairs. */
+
+/*
+ * GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef __GINAC_EXPAIRSEQ_H__
-#define __GINAC_EXPAIRSEQ_H__
+#ifndef GINAC_EXPAIRSEQ_H
+#define GINAC_EXPAIRSEQ_H
-#include <vector>
+#include "expair.h"
+#include "indexed.h"
+
+// CINT needs <algorithm> to work properly with <vector> and <list>
+#include <algorithm>
#include <list>
+#include <memory>
+#include <vector>
-//#define EXPAIRSEQ_USE_HASHTAB
+namespace GiNaC {
-typedef vector<expair> epvector;
-typedef epvector::iterator epviter;
+/** Using hash tables can potentially enhance the asymptotic behaviour of
+ * combining n terms into one large sum (or n terms into one large product)
+ * from O(n*log(n)) to about O(n). There are, however, several drawbacks.
+ * The constant in front of O(n) is quite large, when copying such an object
+ * one also has to copy the has table, comparison is quite expensive because
+ * there is no ordering any more, it doesn't help at all when combining two
+ * expairseqs because due to the presorted nature the behaviour would be
+ * O(n) anyways, the code is quite messy, etc, etc. The code is here as
+ * an example for following generations to tinker with. */
+#define EXPAIRSEQ_USE_HASHTAB 0
-inline void iter_swap(epvector::iterator it1, epvector::iterator it2)
-{
- debugmsg("iter_swap epvector",LOGLEVEL_NONMEMBER_FUNCTION);
- (*it1).rest.swap((*it2).rest);
- (*it1).coeff.swap((*it2).coeff);
-}
+typedef std::vector<expair> epvector; ///< expair-vector
+typedef epvector::iterator epp; ///< expair-vector pointer
+typedef std::list<epp> epplist; ///< list of expair-vector pointers
+typedef std::vector<epplist> epplistvector; ///< vector of epplist
-typedef epvector::iterator epp;
-typedef list<epp> epplist;
-typedef vector<epplist> epplistvector;
+/** Complex conjugate every element of an epvector. Returns zero if this
+ * does not change anything. */
+epvector* conjugateepvector(const epvector&);
/** A sequence of class expair.
* This is used for time-critical classes like sums and products of terms
* since handling a list of coeff and rest is much faster than handling a
- * list of products or powers, respectively. (Incidentally, Maple does it
- * the same way.) */
+ * list of products or powers, respectively. (Not incidentally, Maple does it
+ * the same way, maybe others too.) The semantics is (at least) twofold:
+ * one for addition and one for multiplication and several methods have to
+ * be overridden by derived classes to reflect the change in semantics.
+ * However, most functionality turns out to be shared between addition and
+ * multiplication, which is the reason why there is this base class. */
class expairseq : public basic
{
-// member functions
+ GINAC_DECLARE_REGISTERED_CLASS(expairseq, basic)
- // default constructor, destructor, copy constructor assignment operator and helpers
+ // other constructors
public:
- expairseq() : basic(TINFO_EXPAIRSEQ)
-#ifdef EXPAIRSEQ_USE_HASHTAB
- , hashtabsize(0)
-#endif // def EXPAIRSEQ_USE_HASHTAB
- {
- debugmsg("expairseq default constructor",LOGLEVEL_CONSTRUCT);
- }
- ~expairseq()
- {
- debugmsg("expairseq destructor",LOGLEVEL_DESTRUCT);
- destroy(0);
- }
- expairseq(expairseq const & other);
- expairseq const & operator=(expairseq const & other);
-protected:
- void copy(expairseq const & other);
- void destroy(bool call_parent)
- {
- if (call_parent) basic::destroy(call_parent);
- };
-
- // other constructors
+ expairseq(const ex & lh, const ex & rh);
+ expairseq(const exvector & v);
+ expairseq(const epvector & v, const ex & oc, bool do_index_renaming = false);
+ expairseq(std::auto_ptr<epvector>, const ex & oc, bool do_index_renaming = false);
+
+ // functions overriding virtual functions from base classes
public:
- expairseq(ex const & lh, ex const & rh);
- expairseq(exvector const & v);
- expairseq(epvector const & v, ex const & oc);
- expairseq(epvector * vp, ex const & oc); // vp will be deleted
+ unsigned precedence() const {return 10;}
+ bool info(unsigned inf) const;
+ size_t nops() const;
+ ex op(size_t i) const;
+ ex map(map_function & f) const;
+ ex eval(int level=0) const;
+ ex to_rational(exmap & repl) const;
+ ex to_polynomial(exmap & repl) const;
+ bool match(const ex & pattern, exmap& repl_lst) const;
+ ex subs(const exmap & m, unsigned options = 0) const;
+ ex conjugate() const;
- // functions overriding virtual functions from bases classes
-public:
- basic * duplicate() const;
- void printraw(ostream & os) const;
- void printtree(ostream & os, unsigned indent) const;
- void print(ostream & os, unsigned upper_precedence=0) const;
- bool info(unsigned inf) const;
- int nops() const;
- ex op(int const i) const;
- ex & let_op(int const i);
- ex eval(int level=0) const;
- ex evalf(int level=0) const;
- ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
- ex diff(symbol const & s) const;
- ex subs(lst const & ls, lst const & lr) const;
+ void archive(archive_node& n) const;
+ void read_archive(const archive_node& n, lst& syms);
protected:
- int compare_same_type(basic const & other) const;
- bool is_equal_same_type(basic const & other) const;
- unsigned return_type(void) const;
- unsigned calchash(void) const;
- ex expand(unsigned options=0) const;
-
- // new virtual functions which can be overridden by derived classes
+ bool is_equal_same_type(const basic & other) const;
+ unsigned return_type() const;
+ unsigned calchash() const;
+ ex expand(unsigned options=0) const;
+
+ // new virtual functions which can be overridden by derived classes
protected:
- virtual ex thisexpairseq(epvector const & v, ex const & oc) const;
- virtual ex thisexpairseq(epvector * vp, ex const & oc) const;
- virtual void printseq(ostream & os, char delim, unsigned this_precedence,
- unsigned upper_precedence) const;
- virtual void printpair(ostream & os, expair const & p,
- unsigned upper_precedence) const;
- virtual expair split_ex_to_pair(ex const & e) const;
- virtual expair combine_ex_with_coeff_to_pair(ex const & e,
- ex const & c) const;
- virtual expair combine_pair_with_coeff_to_pair(expair const & p,
- ex const & c) const;
- virtual ex recombine_pair_to_ex(expair const & p) const;
- virtual bool expair_needs_further_processing(epp it);
- virtual ex default_overall_coeff(void) const;
- virtual void combine_overall_coeff(ex const & c);
- virtual void combine_overall_coeff(ex const & c1, ex const & c2);
- virtual bool can_make_flat(expair const & p) const;
-
- // non-virtual functions in this class
+ virtual ex thisexpairseq(const epvector & v, const ex & oc, bool do_index_renaming = false) const;
+ virtual ex thisexpairseq(std::auto_ptr<epvector> vp, const ex & oc, bool do_index_renaming = false) const;
+ virtual void printseq(const print_context & c, char delim,
+ unsigned this_precedence,
+ unsigned upper_precedence) const;
+ virtual void printpair(const print_context & c, const expair & p,
+ unsigned upper_precedence) const;
+ virtual expair split_ex_to_pair(const ex & e) const;
+ virtual expair combine_ex_with_coeff_to_pair(const ex & e,
+ const ex & c) const;
+ virtual expair combine_pair_with_coeff_to_pair(const expair & p,
+ const ex & c) const;
+ virtual ex recombine_pair_to_ex(const expair & p) const;
+ virtual bool expair_needs_further_processing(epp it);
+ virtual ex default_overall_coeff() const;
+ virtual void combine_overall_coeff(const ex & c);
+ virtual void combine_overall_coeff(const ex & c1, const ex & c2);
+ virtual bool can_make_flat(const expair & p) const;
+
+ // non-virtual functions in this class
protected:
- void construct_from_2_ex_via_exvector(ex const & lh, ex const & rh);
- void construct_from_2_ex(ex const & lh, ex const & rh);
- void construct_from_2_expairseq(expairseq const & s1,
- expairseq const & s2);
- void construct_from_expairseq_ex(expairseq const & s,
- ex const & e);
- void construct_from_exvector(exvector const & v);
- void construct_from_epvector(epvector const & v);
- void make_flat(exvector const & v);
- void make_flat(epvector const & v);
- epvector * bubblesort(epvector::iterator itbegin, epvector::iterator itend);
- epvector * mergesort(epvector::iterator itbegin, epvector::iterator itend);
- void canonicalize(void);
- void combine_same_terms_sorted_seq(void);
-#ifdef EXPAIRSEQ_USE_HASHTAB
- void combine_same_terms(void);
- unsigned calc_hashtabsize(unsigned sz) const;
- unsigned calc_hashindex(ex const & e) const;
- void shrink_hashtab(void);
- void remove_hashtab_entry(epvector::const_iterator element);
- void move_hashtab_entry(epvector::const_iterator oldpos,
- epvector::iterator newpos);
- void sorted_insert(epplist & eppl, epp elem);
- void build_hashtab_and_combine(epvector::iterator & first_numeric,
- epvector::iterator & last_non_zero,
- vector<bool> & touched,
- unsigned & number_of_zeroes);
- void drop_coeff_0_terms(epvector::iterator & first_numeric,
- epvector::iterator & last_non_zero,
- vector<bool> & touched,
- unsigned & number_of_zeroes);
- bool has_coeff_0(void) const;
- void add_numerics_to_hashtab(epvector::iterator first_numeric, epvector::const_iterator last_non_zero);
-#endif // def EXPAIRSEQ_USE_HASHTAB
- bool is_canonical() const;
- epvector * expandchildren(unsigned options) const;
- epvector * evalchildren(int level) const;
- epvector evalfchildren(int level) const;
- epvector normalchildren(int level) const;
- epvector diffchildren(symbol const & s) const;
- epvector * subschildren(lst const & ls, lst const & lr) const;
-
+ void do_print(const print_context & c, unsigned level) const;
+ void do_print_tree(const print_tree & c, unsigned level) const;
+ void construct_from_2_ex_via_exvector(const ex & lh, const ex & rh);
+ void construct_from_2_ex(const ex & lh, const ex & rh);
+ void construct_from_2_expairseq(const expairseq & s1,
+ const expairseq & s2);
+ void construct_from_expairseq_ex(const expairseq & s,
+ const ex & e);
+ void construct_from_exvector(const exvector & v);
+ void construct_from_epvector(const epvector & v, bool do_index_renaming = false);
+ void make_flat(const exvector & v);
+ void make_flat(const epvector & v, bool do_index_renaming = false);
+ void canonicalize();
+ void combine_same_terms_sorted_seq();
+#if EXPAIRSEQ_USE_HASHTAB
+ void combine_same_terms();
+ unsigned calc_hashtabsize(unsigned sz) const;
+ unsigned calc_hashindex(const ex & e) const;
+ void shrink_hashtab();
+ void remove_hashtab_entry(epvector::const_iterator element);
+ void move_hashtab_entry(epvector::const_iterator oldpos,
+ epvector::iterator newpos);
+ void sorted_insert(epplist & eppl, epvector::const_iterator elem);
+ void build_hashtab_and_combine(epvector::iterator & first_numeric,
+ epvector::iterator & last_non_zero,
+ vector<bool> & touched,
+ unsigned & number_of_zeroes);
+ void drop_coeff_0_terms(epvector::iterator & first_numeric,
+ epvector::iterator & last_non_zero,
+ vector<bool> & touched,
+ unsigned & number_of_zeroes);
+ bool has_coeff_0() const;
+ void add_numerics_to_hashtab(epvector::iterator first_numeric,
+ epvector::const_iterator last_non_zero);
+#endif // EXPAIRSEQ_USE_HASHTAB
+ bool is_canonical() const;
+ std::auto_ptr<epvector> expandchildren(unsigned options) const;
+ std::auto_ptr<epvector> evalchildren(int level) const;
+ std::auto_ptr<epvector> subschildren(const exmap & m, unsigned options = 0) const;
+
// member variables
-
+
protected:
- epvector seq;
- ex overall_coeff;
- static unsigned precedence;
-#ifdef EXPAIRSEQ_USE_HASHTAB
- epplistvector hashtab;
- unsigned hashtabsize;
- unsigned hashmask;
- static unsigned maxhashtabsize;
- static unsigned minhashtabsize;
- static unsigned hashtabfactor;
-#endif // def EXPAIRSEQ_USE_HASHTAB
+ epvector seq;
+ ex overall_coeff;
+#if EXPAIRSEQ_USE_HASHTAB
+ epplistvector hashtab;
+ unsigned hashtabsize;
+ unsigned hashmask;
+ static unsigned maxhashtabsize;
+ static unsigned minhashtabsize;
+ static unsigned hashtabfactor;
+#endif // EXPAIRSEQ_USE_HASHTAB
};
-// global constants
-
-extern const expairseq some_expairseq;
-extern type_info const & typeid_expairseq;
+/** Class to handle the renaming of dummy indices. It holds a vector of
+ * indices that are being used in the expression so-far. If the same
+ * index occurs again as a dummy index in a factor, it is to be renamed.
+ * Unless dummy index renaming was swichted of, of course ;-) . */
+class make_flat_inserter
+{
+ public:
+ make_flat_inserter(const epvector &epv, bool b): do_renaming(b)
+ {
+ if (!do_renaming)
+ return;
+ for (epvector::const_iterator i=epv.begin(); i!=epv.end(); ++i)
+ if(are_ex_trivially_equal(i->coeff, 1))
+ combine_indices(i->rest.get_free_indices());
+ }
+ make_flat_inserter(const exvector &v, bool b): do_renaming(b)
+ {
+ if (!do_renaming)
+ return;
+ for (exvector::const_iterator i=v.begin(); i!=v.end(); ++i)
+ combine_indices(i->get_free_indices());
+ }
+ ex handle_factor(const ex &x, const ex &coeff)
+ {
+ if (!do_renaming)
+ return x;
+ exvector dummies_of_factor;
+ if (is_a<numeric>(coeff) && coeff.is_equal(GiNaC::numeric(1)))
+ dummies_of_factor = get_all_dummy_indices_safely(x);
+ else if (is_a<numeric>(coeff) && coeff.is_equal(GiNaC::numeric(2)))
+ dummies_of_factor = x.get_free_indices();
+ else
+ return x;
+ if (dummies_of_factor.size() == 0)
+ return x;
+ sort(dummies_of_factor.begin(), dummies_of_factor.end(), ex_is_less());
+ ex new_factor = rename_dummy_indices_uniquely(used_indices,
+ dummies_of_factor, x);
+ combine_indices(dummies_of_factor);
+ return new_factor;
+ }
+ private:
+ void combine_indices(const exvector &dummies_of_factor)
+ {
+ exvector new_dummy_indices;
+ set_union(used_indices.begin(), used_indices.end(),
+ dummies_of_factor.begin(), dummies_of_factor.end(),
+ std::back_insert_iterator<exvector>(new_dummy_indices), ex_is_less());
+ used_indices.swap(new_dummy_indices);
+ }
+ bool do_renaming;
+ exvector used_indices;
+};
-#define ex_to_expairseq(X) static_cast<expairseq const &>(*(X).bp)
+} // namespace GiNaC
-#endif // ndef __GINAC_EXPAIRSEQ_H__
+#endif // ndef GINAC_EXPAIRSEQ_H
git://www.ginac.de / ginac.git / blobdiff