mention the "dummy()" function option

[ginac.git] / ginac / tensor.h

diff --git a/ginac/tensor.h b/ginac/tensor.h
index d868355b16b71ee07e9102c1b1995dd5e7330792..446ede8653e467adb35f147ef6d53a329aae18bb 100644 (file)
--- a/ginac/tensor.h
+++ b/ginac/tensor.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's special tensors. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2003 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
@@ -37,11 +37,18 @@ class tensor : public basic
 
        // other constructors
 protected:
-       tensor(unsigned ti);
+       tensor(unsigned ti) : inherited(ti) {}
 
        // functions overriding virtual functions from base classes
 protected:
-       unsigned return_type(void) const { return return_types::noncommutative_composite; }
+       unsigned return_type() 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;
 };
 
 
@@ -53,9 +60,13 @@ class tensdelta : public tensor
 
        // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) 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:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
 
 
@@ -68,9 +79,12 @@ class tensmetric : public tensor
 
        // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) 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:
+       void do_print(const print_context & c, unsigned level) const;
 };
 
 
@@ -88,9 +102,13 @@ public:
 
        // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
        ex eval_indexed(const basic & i) const;
 
+       // non-virtual functions in this class
+protected:
+       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,...). */
@@ -107,9 +125,13 @@ class spinmetric : public tensmetric
 
        // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) 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:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
 };
 
 
@@ -126,25 +148,23 @@ public:
 
        // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) 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:
+       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. */
 };
 
 
 // utility functions
 
-/** Return the tensor object handled by an ex.  Deprecated: use ex_to<tensor>().
- *  This is unsafe: you need to check the type first. */
-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
  *  the dimension of the index space.
@@ -212,18 +232,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__