Happy New Year!
[ginac.git] / ginac / idx.h
index 16c515f22380e7c929f09d30a46fa5bebf35b0fb..e38bf20baaf587dac2b430d82fbc6ac4bce48f69 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's indices. */
 
 /*
- *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2019 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_IDX_H__
-#define __GINAC_IDX_H__
+#ifndef GINAC_IDX_H
+#define GINAC_IDX_H
 
 #include "ex.h"
 #include "numeric.h"
 
 namespace GiNaC {
 
-
 /** This class holds one index of an indexed object. Indices can
  *  theoretically consist of any symbolic expression but they are usually
  *  only just a symbol (e.g. "mu", "i") or numeric (integer). Indices belong
@@ -48,17 +47,18 @@ public:
 
        // functions overriding virtual functions from base classes
 public:
-       bool info(unsigned inf) const;
-       size_t nops() const;
-       ex op(size_t i) const;
-       ex map(map_function & f) const;
-       ex evalf(int level = 0) const;
-       ex subs(const exmap & m, unsigned options = 0) const;
-
+       bool info(unsigned inf) const override;
+       size_t nops() const override;
+       ex op(size_t i) const override;
+       ex map(map_function & f) const override;
+       ex evalf() const override;
+       ex subs(const exmap & m, unsigned options = 0) const override;
+       void archive(archive_node& n) const override;
+       void read_archive(const archive_node& n, lst& syms) override;
 protected:
-       ex derivative(const symbol & s) const;
-       bool match_same_type(const basic & other) const;
-       unsigned calchash() const;
+       ex derivative(const symbol & s) const override;
+       bool match_same_type(const basic & other) const override;
+       unsigned calchash() const override;
 
        // new virtual functions in this class
 public:
@@ -94,8 +94,9 @@ public:
        ex minimal_dim(const idx & other) const;
 
 protected:
-       void do_print_idx(const print_context & c, unsigned level) const;
+       void print_index(const print_context & c, unsigned level) const;
        void do_print(const print_context & c, unsigned level) const;
+       void do_print_csrc(const print_csrc & 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;
 
@@ -103,6 +104,7 @@ protected:
        ex value; /**< Expression that constitutes the index (numeric or symbolic name) */
        ex dim;   /**< Dimension of space (can be symbolic or numeric) */
 };
+GINAC_DECLARE_UNARCHIVER(idx); 
 
 
 /** This class holds an index with a variance (co- or contravariant). There
@@ -123,10 +125,11 @@ public:
 
        // functions overriding virtual functions from base classes
 public:
-       bool is_dummy_pair_same_type(const basic & other) const;
-
+       bool is_dummy_pair_same_type(const basic & other) const override;
+       void archive(archive_node& n) const override;
+       void read_archive(const archive_node& n, lst& syms) override;
 protected:
-       bool match_same_type(const basic & other) const;
+       bool match_same_type(const basic & other) const override;
 
        // non-virtual functions in this class
 public:
@@ -147,6 +150,7 @@ protected:
 protected:
        bool covariant; /**< x.mu, default is contravariant: x~mu */
 };
+GINAC_DECLARE_UNARCHIVER(varidx);
 
 
 /** This class holds a spinor index that can be dotted or undotted and that
@@ -171,10 +175,13 @@ public:
 
        // functions overriding virtual functions from base classes
 public:
-       bool is_dummy_pair_same_type(const basic & other) const;
-
+       bool is_dummy_pair_same_type(const basic & other) const override;
+       // complex conjugation
+       ex conjugate() const override { return toggle_dot(); }
+       void archive(archive_node& n) const override;
+       void read_archive(const archive_node& n, lst& syms) override;
 protected:
-       bool match_same_type(const basic & other) const;
+       bool match_same_type(const basic & other) const override;
 
        // non-virtual functions in this class
 public:
@@ -201,28 +208,11 @@ protected:
 protected:
        bool dotted;
 };
+GINAC_DECLARE_UNARCHIVER(spinidx);
 
 
 // utility functions
 
-/** Specialization of is_exactly_a<idx>(obj) for idx objects. */
-template<> inline bool is_exactly_a<idx>(const basic & obj)
-{
-        return obj.tinfo()==TINFO_idx;
-}
-
-/** Specialization of is_exactly_a<varidx>(obj) for varidx objects. */
-template<> inline bool is_exactly_a<varidx>(const basic & obj)
-{
-        return obj.tinfo()==TINFO_varidx;
-}
-
-/** Specialization of is_exactly_a<spinidx>(obj) for spinidx objects. */
-template<> inline bool is_exactly_a<spinidx>(const basic & obj)
-{
-        return obj.tinfo()==TINFO_spinidx;
-}
-
 /** Check whether two indices form a dummy pair. */
 bool is_dummy_pair(const idx & i1, const idx & i2);
 
@@ -284,4 +274,4 @@ ex minimal_dim(const ex & dim1, const ex & dim2);
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_IDX_H__
+#endif // ndef GINAC_IDX_H