]> www.ginac.de Git - ginac.git/blobdiff - ginac/tensor.h
Add support for Texinfo-5.0.
[ginac.git] / ginac / tensor.h
index 5698b9b944450e44852b3571cb610dd0051b95ec..fb8185b6a3a118a4c2a49d20cd76f979034db264 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's special tensors. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  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_TENSOR_H__
-#define __GINAC_TENSOR_H__
+#ifndef GINAC_TENSOR_H
+#define GINAC_TENSOR_H
 
 #include "ex.h"
+#include "archive.h"
 
 namespace GiNaC {
 
-
 /** This class holds one of GiNaC's predefined special tensors such as the
  *  delta and the metric tensors. They are represented without indices.
  *  To attach indices to them, wrap them in an object of class indexed. */
@@ -35,13 +35,16 @@ class tensor : public basic
 {
        GINAC_DECLARE_REGISTERED_CLASS(tensor, basic)
 
-       // other constructors
+       // functions overriding virtual functions from base classes
 protected:
-       tensor(unsigned ti);
+       unsigned return_type() const { return return_types::noncommutative_composite; }
 
-       // functions overriding virtual functions from bases classes
-protected:
-       unsigned return_type(void) const { return return_types::noncommutative_composite; }
+       // non-virtual functions in this class
+public:
+       /** Replace dummy index in contracted-with object by the contracting
+        *  object's second index (used internally for delta and metric tensor
+        *  contractions. */
+       bool replace_contr_index(exvector::iterator self, exvector::iterator other) const;
 };
 
 
@@ -51,12 +54,19 @@ class tensdelta : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(tensdelta, tensor)
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
+       bool info(unsigned inf) const;
        ex eval_indexed(const basic & i) const;
        bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+       // non-virtual functions in this class
+protected:
+       unsigned return_type() const { return return_types::commutative; }
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
+GINAC_DECLARE_UNARCHIVER(tensdelta);
 
 
 /** This class represents a general metric tensor which can be used to
@@ -66,12 +76,18 @@ class tensmetric : public tensor
 {
        GINAC_DECLARE_REGISTERED_CLASS(tensmetric, tensor)
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
+       bool info(unsigned inf) const;
        ex eval_indexed(const basic & i) const;
        bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+       // non-virtual functions in this class
+protected:
+       unsigned return_type() const { return return_types::commutative; }
+       void do_print(const print_context & c, unsigned level) const;
 };
+GINAC_DECLARE_UNARCHIVER(tensmetric);
 
 
 /** This class represents a Minkowski metric tensor. It has all the
@@ -86,15 +102,26 @@ public:
        /** Construct Lorentz metric tensor with given signature. */
        minkmetric(bool pos_sig);
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
+       bool info(unsigned inf) const;
        ex eval_indexed(const basic & i) const;
 
+       /** Save (a.k.a. serialize) object into archive. */
+       void archive(archive_node& n) const;
+       /** Read (a.k.a. deserialize) object from archive. */
+       void read_archive(const archive_node& n, lst& syms);
+       // non-virtual functions in this class
+protected:
+       unsigned return_type() const { return return_types::commutative; }
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
+
        // member variables
 private:
        bool pos_sig; /**< If true, the metric is diag(-1,1,1...). Otherwise it is diag(1,-1,-1,...). */
 };
+GINAC_DECLARE_UNARCHIVER(minkmetric); 
 
 
 /** This class represents an antisymmetric spinor metric tensor which
@@ -105,12 +132,17 @@ class spinmetric : public tensmetric
 {
        GINAC_DECLARE_REGISTERED_CLASS(spinmetric, tensmetric)
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
+       bool info(unsigned inf) const;
        ex eval_indexed(const basic & i) const;
        bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
+GINAC_DECLARE_UNARCHIVER(spinmetric);
 
 
 /** This class represents the totally antisymmetric epsilon tensor. If
@@ -124,23 +156,31 @@ class tensepsilon : public tensor
 public:
        tensepsilon(bool minkowski, bool pos_sig);
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
+       bool info(unsigned inf) const;
        ex eval_indexed(const basic & i) const;
+       bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
+
+       /** Save (a.k.a. serialize) object into archive. */
+       void archive(archive_node& n) const;
+       /** Read (a.k.a. deserialize) object from archive. */
+       void read_archive(const archive_node& n, lst& syms);
+       // non-virtual functions in this class
+protected:
+       unsigned return_type() const { return return_types::commutative; }
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 
        // member variables
 private:
        bool minkowski; /**< If true, tensor is in Minkowski-type space. Otherwise it is in a Euclidean space. */
-       bool pos_sig;  /**< If true, the metric is assumed to be diag(-1,1,1...). Otherwise it is diag(1,-1,-1,...). This is only relevant if minkowski = true. */
+       bool pos_sig;   /**< If true, the metric is assumed to be diag(-1,1,1...). Otherwise it is diag(1,-1,-1,...). This is only relevant if minkowski = true. */
 };
+GINAC_DECLARE_UNARCHIVER(tensepsilon); 
 
 
 // utility functions
-inline const tensor &ex_to_tensor(const ex &e)
-{
-       return static_cast<const tensor &>(*e.bp);
-}
 
 /** Create a delta tensor with specified indices. The indices must be of class
  *  idx or a subclass. The delta tensor is always symmetric and its trace is
@@ -209,18 +249,6 @@ ex epsilon_tensor(const ex & i1, const ex & i2, const ex & i3);
  *  @return newly constructed epsilon tensor */
 ex lorentz_eps(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig = false);
 
-/** Create an epsilon tensor in a 4-dimensional projection of a D-dimensional
- *  Minkowski space. It vanishes whenever one of the indices is not in the
- *  set {0, 1, 2, 3}.
- *
- *  @param i1 First index
- *  @param i2 Second index
- *  @param i3 Third index
- *  @param i4 Fourth index
- *  @param pos_sig Whether the signature of the metric is positive
- *  @return newly constructed epsilon tensor */
-ex eps0123(const ex & i1, const ex & i2, const ex & i3, const ex & i4, bool pos_sig = false);
-
 } // namespace GiNaC
 
-#endif // ndef __GINAC_TENSOR_H__
+#endif // ndef GINAC_TENSOR_H