X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Findexed.h;h=aac4625c8d6f37a4ca06b461222ec3ff3c2ca993;hp=5988f0a0cad1da773f542e44a634518d132a56f5;hb=a68aee97d9ebdac8a6ac81f1e41961e6bc792468;hpb=956eeb82c513a723e864edefa857133282cf692b diff --git a/ginac/indexed.h b/ginac/indexed.h index 5988f0a0..aac4625c 100644 --- a/ginac/indexed.h +++ b/ginac/indexed.h @@ -1,9 +1,9 @@ /** @file indexed.h * - * Interface to GiNaC's index carrying objects. */ + * Interface to GiNaC's indexed expressions. */ /* - * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2004 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 @@ -23,84 +23,233 @@ #ifndef __GINAC_INDEXED_H__ #define __GINAC_INDEXED_H__ -#include +#include + #include "exprseq.h" +#include "wildcard.h" -#ifndef NO_NAMESPACE_GINAC namespace GiNaC { -#endif // ndef NO_NAMESPACE_GINAC -/** Base class for non-commutative indexed objects */ + +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) + * indices (all of class idx), accessible as op(1)..op(n). */ class indexed : public exprseq { - GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq) + GINAC_DECLARE_REGISTERED_CLASS(indexed, exprseq) -// member functions + 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); - // default constructor, destructor, copy constructor assignment operator and helpers + // other constructors public: - indexed(); - ~indexed(); - indexed(const indexed & other); - const indexed & operator=(const indexed & other); -protected: - void copy(const indexed & other); - void destroy(bool call_parent); - - // other constructors + /** Construct indexed object with no index. + * + * @param b Base expression + * @return newly constructed indexed object */ + indexed(const ex & b); + + /** Construct indexed object with one index. The index must be of class idx. + * + * @param b Base expression + * @param i1 The index + * @return newly constructed indexed object */ + indexed(const ex & b, const ex & i1); + + /** Construct indexed object with two indices. The indices must be of class idx. + * + * @param b Base expression + * @param i1 First index + * @param i2 Second index + * @return newly constructed indexed object */ + indexed(const ex & b, const ex & i1, const ex & i2); + + /** Construct indexed object with three indices. The indices must be of class idx. + * + * @param b Base expression + * @param i1 First index + * @param i2 Second index + * @param i3 Third index + * @return newly constructed indexed object */ + indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3); + + /** Construct indexed object with four indices. The indices must be of class idx. + * + * @param b Base expression + * @param i1 First index + * @param i2 Second index + * @param i3 Third index + * @param i4 Fourth index + * @return newly constructed indexed object */ + indexed(const ex & b, const ex & i1, const ex & i2, const ex & i3, const ex & i4); + + /** Construct indexed object with two indices and a specified symmetry. The + * indices must be of class idx. + * + * @param b Base expression + * @param symm Symmetry of indices + * @param i1 First index + * @param i2 Second index + * @return newly constructed indexed object */ + 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. + * + * @param b Base expression + * @param symm Symmetry of indices + * @param i1 First index + * @param i2 Second index + * @param i3 Third index + * @return newly constructed indexed object */ + 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. + * + * @param b Base expression + * @param symm Symmetry of indices + * @param i1 First index + * @param i2 Second index + * @param i3 Third index + * @param i4 Fourth index + * @return newly constructed indexed object */ + 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. + * + * @param b Base expression + * @param iv Vector of indices + * @return newly constructed indexed object */ + indexed(const ex & b, const exvector & iv); + + /** Construct indexed object with a specified vector of indices and + * symmetry. The indices must be of class idx. + * + * @param b Base expression + * @param symm Symmetry of indices + * @param iv Vector of indices + * @return newly constructed indexed object */ + indexed(const ex & b, const symmetry & symm, const exvector & iv); + + // internal constructors + 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: - indexed(const ex & i1); - indexed(const ex & i1, const ex & i2); - indexed(const ex & i1, const ex & i2, const ex & i3); - indexed(const ex & i1, const ex & i2, const ex & i3, const ex & i4); - indexed(const exvector & iv); - indexed(exvector * iv); - - // functions overriding virtual functions from base classes + unsigned precedence() const {return 55;} + bool info(unsigned inf) const; + ex eval(int level = 0) const; + exvector get_free_indices() const; + +protected: + ex derivative(const symbol & s) const; + ex thiscontainer(const exvector & v) const; + ex thiscontainer(std::auto_ptr vp) const; + unsigned return_type() const { return return_types::commutative; } + ex expand(unsigned options = 0) const; + + // new virtual functions which can be overridden by derived classes + // none + + // non-virtual functions in this class 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; - void printcsrc(ostream & os, unsigned type, unsigned upper_precedence) const; - bool info(unsigned inf) const; - ex diff(const symbol & s) const; - exvector get_indices(void) const; + /** Check whether all index values have a certain property. + * @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() 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: - int compare_same_type(const basic & other) const; - bool is_equal_same_type(const basic & other) const; - unsigned return_type(void) const; - unsigned return_type_tinfo(void) const; - ex thisexprseq(const exvector & v) const; - ex thisexprseq(exvector * vp) const; - - // new virtual functions which can be overridden by derived classes - // none - - // non-virtual functions in this class + 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: - void printrawindices(ostream & os) const; - void printtreeindices(ostream & os, unsigned indent) const; - void printindices(ostream & os) const; - bool all_of_type_idx(void) const; + ex symtree; /**< Index symmetry (tree of symmetry objects) */ +}; -// member variables - // none + +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; + + void debugprint() const; + +protected: + ex v1, v2, dim; }; -// global constants +typedef std::map spmap; + +/** Helper class for storing information about known scalar products which + * are to be automatically replaced by simplify_indexed(). + * + * @see simplify_indexed */ +class scalar_products { +public: + /** Register scalar product pair and its value. */ + void add(const ex & v1, const ex & v2, const ex & sp); + + /** 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); + + /** 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(); + + 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 */ +}; -extern const indexed some_indexed; -extern const type_info & typeid_indexed; // utility functions -inline const indexed &ex_to_indexed(const ex &e) + +/** Specialization of is_exactly_a(obj) for indexed objects. */ +template<> inline bool is_exactly_a(const basic & obj) { - return static_cast(*e.bp); + return obj.tinfo()==TINFO_indexed; } -#ifndef NO_NAMESPACE_GINAC } // namespace GiNaC -#endif // ndef NO_NAMESPACE_GINAC #endif // ndef __GINAC_INDEXED_H__