X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Findexed.h;h=93eecd27e45ba041b6293ac97846ee3f589ad603;hp=b06fad1040a702a8354248f3ef68834297c88cc8;hb=515171f0bcd42099c266713c3d605cd92cedd2e2;hpb=745d46b8492878030cc0decd1cb9bf2de2de03ff diff --git a/ginac/indexed.h b/ginac/indexed.h index b06fad10..93eecd27 100644 --- a/ginac/indexed.h +++ b/ginac/indexed.h @@ -3,7 +3,7 @@ * Interface to GiNaC's indexed expressions. */ /* - * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2010 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 @@ -17,20 +17,21 @@ * * 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_INDEXED_H__ -#define __GINAC_INDEXED_H__ - -#include +#ifndef GINAC_INDEXED_H +#define GINAC_INDEXED_H #include "exprseq.h" +#include "wildcard.h" -namespace GiNaC { +#include +namespace GiNaC { class scalar_products; +class symmetry; /** This class holds an indexed expression. It consists of a 'base' expression * (the expression being indexed) which can be accessed as op(0), and n (n >= 0) @@ -39,18 +40,9 @@ class indexed : public exprseq { GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq) - friend ex simplify_indexed(const ex & e, exvector & free_indices, const scalar_products & sp); - friend ex simplify_indexed_product(const ex & e, exvector & free_indices, const scalar_products & sp); - - // types -public: - /** Type of symmetry of the object with respect to commutation of its indices. */ - typedef enum { - unknown, /**< symmetry properties unknown */ - symmetric, /**< totally symmetric */ - antisymmetric, /**< totally antisymmetric */ - mixed /**< mixed symmetry (unimplemented) */ - } symmetry_type; + friend ex simplify_indexed(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp); + friend ex simplify_indexed_product(const ex & e, exvector & free_indices, exvector & dummy_indices, const scalar_products & sp); + friend bool reposition_dummy_indices(ex & e, exvector & variant_dummy_indices, exvector & moved_indices); // other constructors public: @@ -102,7 +94,7 @@ public: * @param i1 First index * @param i2 Second index * @return newly constructed indexed object */ - indexed(const ex & b, symmetry_type symm, const ex & i1, const ex & i2); + indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2); /** Construct indexed object with three indices and a specified symmetry. * The indices must be of class idx. @@ -113,7 +105,7 @@ public: * @param i2 Second index * @param i3 Third index * @return newly constructed indexed object */ - indexed(const ex & b, symmetry_type symm, const ex & i1, const ex & i2, const ex & i3); + indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3); /** Construct indexed object with four indices and a specified symmetry. The * indices must be of class idx. @@ -125,7 +117,7 @@ public: * @param i3 Third index * @param i4 Fourth index * @return newly constructed indexed object */ - indexed(const ex & b, symmetry_type symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4); + indexed(const ex & b, const symmetry & symm, const ex & i1, const ex & i2, const ex & i3, const ex & i4); /** Construct indexed object with a specified vector of indices. The indices * must be of class idx. @@ -142,26 +134,32 @@ public: * @param symm Symmetry of indices * @param iv Vector of indices * @return newly constructed indexed object */ - indexed(const ex & b, symmetry_type symm, const exvector & iv); + indexed(const ex & b, const symmetry & symm, const exvector & iv); // internal constructors - indexed(symmetry_type symm, const exprseq & es); - indexed(symmetry_type symm, const exvector & v, bool discardable = false); - indexed(symmetry_type symm, exvector * vp); // vp will be deleted + indexed(const symmetry & symm, const exprseq & es); + indexed(const symmetry & symm, const exvector & v, bool discardable = false); + indexed(const symmetry & symm, std::auto_ptr vp); // functions overriding virtual functions from base classes public: - void printraw(std::ostream & os) const; - void printtree(std::ostream & os, unsigned indent) const; - void print(std::ostream & os, unsigned upper_precedence=0) const; + unsigned precedence() const {return 55;} bool info(unsigned inf) const; ex eval(int level = 0) const; - exvector get_free_indices(void) const; - + ex real_part() const; + ex imag_part() const; + exvector get_free_indices() const; + + /** Save (a.k.a. serialize) indexed object into archive. */ + void archive(archive_node& n) const; + /** Read (a.k.a. deserialize) indexed object from archive. */ + void read_archive(const archive_node& n, lst& syms); protected: - ex thisexprseq(const exvector & v) const; - ex thisexprseq(exvector * vp) const; - unsigned return_type(void) const { return return_types::commutative; } + ex derivative(const symbol & s) const; + ex thiscontainer(const exvector & v) const; + ex thiscontainer(std::auto_ptr vp) const; + unsigned return_type() const; + return_type_t return_type_tinfo() const { return op(0).return_type_tinfo(); } ex expand(unsigned options = 0) const; // new virtual functions which can be overridden by derived classes @@ -173,32 +171,54 @@ public: * @see class info_flags */ bool all_index_values_are(unsigned inf) const; + /** Return a vector containing the object's indices. */ + exvector get_indices() const; + /** Return a vector containing the dummy indices of the object, if any. */ - exvector get_dummy_indices(void) const; + exvector get_dummy_indices() const; + + /** Return a vector containing the dummy indices in the contraction with + * another indexed object. This is symmetric: a.get_dummy_indices(b) + * == b.get_dummy_indices(a) */ + exvector get_dummy_indices(const indexed & other) const; + + /** Check whether the object has an index that forms a dummy index pair + * with a given index. */ + bool has_dummy_index_for(const ex & i) const; + + /** Return symmetry properties. */ + ex get_symmetry() const {return symtree;} protected: - void printrawindices(std::ostream & os) const; - void printtreeindices(std::ostream & os, unsigned indent) const; - void printindices(std::ostream & os) const; - void assert_all_indices_of_type_idx(void) const; + void printindices(const print_context & c, unsigned level) const; + void print_indexed(const print_context & c, const char *openbrace, const char *closebrace, unsigned level) const; + void do_print(const print_context & c, unsigned level) const; + void do_print_latex(const print_latex & c, unsigned level) const; + void do_print_tree(const print_tree & c, unsigned level) const; + void validate() const; // member variables protected: - symmetry_type symmetry; /**< Index symmetry */ + ex symtree; /**< Index symmetry (tree of symmetry objects) */ }; +GINAC_DECLARE_UNARCHIVER(indexed); + + +class spmapkey { +public: + spmapkey() : dim(wild()) {} + spmapkey(const ex & v1, const ex & v2, const ex & dim = wild()); + bool operator==(const spmapkey &other) const; + bool operator<(const spmapkey &other) const; -typedef std::pair spmapkey; + void debugprint() const; -struct spmapkey_is_less { - bool operator() (const spmapkey &p, const spmapkey &q) const - { - int cmp = p.first.compare(q.first); - return ((cmp<0) || (!(cmp>0) && p.second.compare(q.second)<0)); - } +protected: + ex v1, v2, dim; }; -typedef std::map spmap; +typedef std::map spmap; /** Helper class for storing information about known scalar products which * are to be automatically replaced by simplify_indexed(). @@ -209,46 +229,60 @@ public: /** Register scalar product pair and its value. */ void add(const ex & v1, const ex & v2, const ex & sp); - /** Clear all registered scalar products. */ - void clear(void); + /** Register scalar product pair and its value for a specific space dimension. */ + void add(const ex & v1, const ex & v2, const ex & dim, const ex & sp); - bool is_defined(const ex & v1, const ex & v2) const; - ex evaluate(const ex & v1, const ex & v2) const; - void debugprint(void) const; + /** Register list of vectors. This adds all possible pairs of products + * a.i * b.i with the value a*b (note that this is not a scalar vector + * product but an ordinary product of scalars). */ + void add_vectors(const lst & l, const ex & dim = wild()); + + /** Clear all registered scalar products. */ + void clear(); -private: - static spmapkey make_key(const ex & v1, const ex & v2); + bool is_defined(const ex & v1, const ex & v2, const ex & dim) const; + ex evaluate(const ex & v1, const ex & v2, const ex & dim) const; + void debugprint() const; +protected: spmap spm; /*< Map from defined scalar product pairs to their values */ }; // utility functions -inline const indexed &ex_to_indexed(const ex &e) -{ - return static_cast(*e.bp); -} +/** Returns all dummy indices from the expression */ +exvector get_all_dummy_indices(const ex & e); -/** Simplify/canonicalize expression containing indexed objects. This - * performs contraction of dummy indices where possible and checks whether - * the free indices in sums are consistent. - * - * @param e The expression to be simplified - * @return simplified expression */ -ex simplify_indexed(const ex & e); - -/** Simplify/canonicalize expression containing indexed objects. This - * performs contraction of dummy indices where possible, checks whether - * the free indices in sums are consistent, and automatically replaces - * scalar products by known values if desired. - * - * @param e The expression to be simplified - * @param sp Scalar products to be replaced automatically - * @return simplified expression */ -ex simplify_indexed(const ex & e, const scalar_products & sp); +/** More reliable version of the form. The former assumes that e is an + * expanded epxression. */ +exvector get_all_dummy_indices_safely(const ex & e); + +/** Returns b with all dummy indices, which are listed in va, renamed + * if modify_va is set to TRUE all dummy indices of b will be appended to va */ +ex rename_dummy_indices_uniquely(exvector & va, const ex & b, bool modify_va = false); + +/** Returns b with all dummy indices, which are common with a, renamed */ +ex rename_dummy_indices_uniquely(const ex & a, const ex & b); + +/** Same as above, where va and vb contain the indices of a and b and are sorted */ +ex rename_dummy_indices_uniquely(const exvector & va, const exvector & vb, const ex & b); +/** Similar to above, where va and vb are the same and the return value is a list of two lists + * for substitution in b */ +lst rename_dummy_indices_uniquely(const exvector & va, const exvector & vb); + +/** This function returns the given expression with expanded sums + * for all dummy index summations, where the dimensionality of + * the dummy index is a nonnegative integer. + * Optionally all indices with a variance will be substituted by + * indices with the corresponding numeric values without variance. + * + * @param e the given expression + * @param subs_idx indicates if variance of dummy indixes should be neglected + */ +ex expand_dummy_sum(const ex & e, bool subs_idx = false); } // namespace GiNaC -#endif // ndef __GINAC_INDEXED_H__ +#endif // ndef GINAC_INDEXED_H