]> www.ginac.de Git - ginac.git/blobdiff - ginac/idx.h
Synced to HEAD
[ginac.git] / ginac / idx.h
index d98d4b14932bf1b6db5cd829e8f987c09d1816f1..97538d77f6864857c0df97a7481b1be63ee82fb1 100644 (file)
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's indices. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 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
@@ -24,6 +24,7 @@
 #define __GINAC_IDX_H__
 
 #include "ex.h"
+#include "numeric.h"
 
 namespace GiNaC {
 
@@ -45,18 +46,19 @@ public:
         *  @return newly constructed index */
        explicit idx(const ex & v, const ex & dim);
 
-       // 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;
-       unsigned nops() const;
-       ex & let_op(int i);
+       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 lst & ls, const lst & lr, bool no_pattern = false) const;
+       ex subs(const exmap & m, unsigned options = 0) const;
 
 protected:
        ex derivative(const symbol & s) const;
        bool match_same_type(const basic & other) const;
+       unsigned calchash() const;
 
        // new virtual functions in this class
 public:
@@ -67,22 +69,35 @@ public:
        // non-virtual functions in this class
 public:
        /** Get value of index. */
-       ex get_value(void) const {return value;}
+       ex get_value() const {return value;}
 
        /** Check whether the index is numeric. */
-       bool is_numeric(void) const {return is_ex_exactly_of_type(value, numeric);}
+       bool is_numeric() const {return is_exactly_a<numeric>(value);}
 
        /** Check whether the index is symbolic. */
-       bool is_symbolic(void) const {return !is_ex_exactly_of_type(value, numeric);}
+       bool is_symbolic() const {return !is_exactly_a<numeric>(value);}
 
        /** Get dimension of index space. */
-       ex get_dim(void) const {return dim;}
+       ex get_dim() const {return dim;}
 
        /** Check whether the dimension is numeric. */
-       bool is_dim_numeric(void) const {return is_ex_exactly_of_type(dim, numeric);}
+       bool is_dim_numeric() const {return is_exactly_a<numeric>(dim);}
 
        /** Check whether the dimension is symbolic. */
-       bool is_dim_symbolic(void) const {return !is_ex_exactly_of_type(dim, numeric);}
+       bool is_dim_symbolic() const {return !is_exactly_a<numeric>(dim);}
+
+       /** Make a new index with the same value but a different dimension. */
+       ex replace_dim(const ex & new_dim) const;
+
+       /** Return the minimum of the dimensions of this and another index.
+        *  If this is undecidable, throw an exception. */
+       ex minimal_dim(const idx & other) const;
+
+protected:
+       void print_index(const print_context & c, 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;
 
 protected:
        ex value; /**< Expression that constitutes the index (numeric or symbolic name) */
@@ -106,9 +121,8 @@ public:
         *  @return newly constructed index */
        varidx(const ex & v, const ex & dim, bool covariant = false);
 
-       // 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 is_dummy_pair_same_type(const basic & other) const;
 
 protected:
@@ -117,13 +131,17 @@ protected:
        // non-virtual functions in this class
 public:
        /** Check whether the index is covariant. */
-       bool is_covariant(void) const {return covariant;}
+       bool is_covariant() const {return covariant;}
 
        /** Check whether the index is contravariant (not covariant). */
-       bool is_contravariant(void) const {return !covariant;}
+       bool is_contravariant() const {return !covariant;}
 
        /** Make a new index with the same value but the opposite variance. */
-       ex toggle_variance(void) const;
+       ex toggle_variance() const;
+
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_tree(const print_tree & c, unsigned level) const;
 
        // member variables
 protected:
@@ -151,10 +169,11 @@ public:
         *  @return newly constructed index */
        spinidx(const ex & v, const ex & dim = 2, bool covariant = false, bool dotted = false);
 
-       // 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 is_dummy_pair_same_type(const basic & other) const;
+       // complex conjugation
+       ex conjugate() const { return toggle_dot(); }
 
 protected:
        bool match_same_type(const basic & other) const;
@@ -162,18 +181,23 @@ protected:
        // non-virtual functions in this class
 public:
        /** Check whether the index is dotted. */
-       bool is_dotted(void) const {return dotted;}
+       bool is_dotted() const {return dotted;}
 
        /** Check whether the index is not dotted. */
-       bool is_undotted(void) const {return !dotted;}
+       bool is_undotted() const {return !dotted;}
 
        /** Make a new index with the same value and variance but the opposite
         *  dottedness. */
-       ex toggle_dot(void) const;
+       ex toggle_dot() const;
 
        /** Make a new index with the same value but opposite variance and
         *  dottedness. */
-       ex toggle_variance_dot(void) const;
+       ex toggle_variance_dot() const;
+
+protected:
+       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;
 
        // member variables
 protected:
@@ -183,27 +207,6 @@ protected:
 
 // utility functions
 
-/** Return the idx object handled by an ex.  Deprecated: use ex_to<idx>().
- *  This is unsafe: you need to check the type first. */
-inline const idx &ex_to_idx(const ex & e)
-{
-       return static_cast<const idx &>(*e.bp);
-}
-
-/** Return the varidx object handled by an ex.  Deprecated: use ex_to<varidx>().
- *  This is unsafe: you need to check the type first. */
-inline const varidx &ex_to_varidx(const ex & e)
-{
-       return static_cast<const varidx &>(*e.bp);
-}
-
-/** Return the spinidx object handled by an ex.  Deprecated: use ex_to<spinidx>().
- *  This is unsafe: you need to check the type first. */
-inline const spinidx &ex_to_spinidx(const ex & e)
-{
-       return static_cast<const spinidx &>(*e.bp);
-}
-
 /** Specialization of is_exactly_a<idx>(obj) for idx objects. */
 template<> inline bool is_exactly_a<idx>(const basic & obj)
 {
@@ -261,7 +264,7 @@ inline void find_dummy_indices(const exvector & v, exvector & out_dummy)
 }
 
 /** Count the number of dummy index pairs in an index vector. */
-inline unsigned count_dummy_indices(const exvector & v)
+inline size_t count_dummy_indices(const exvector & v)
 {
        exvector free_indices, dummy_indices;
        find_free_and_dummy(v.begin(), v.end(), free_indices, dummy_indices);
@@ -269,13 +272,18 @@ inline unsigned count_dummy_indices(const exvector & v)
 }
 
 /** Count the number of dummy index pairs in an index vector. */
-inline unsigned count_free_indices(const exvector & v)
+inline size_t count_free_indices(const exvector & v)
 {
        exvector free_indices, dummy_indices;
        find_free_and_dummy(v.begin(), v.end(), free_indices, dummy_indices);
        return free_indices.size();
 }
 
+/** Return the minimum of two index dimensions. If this is undecidable,
+ *  throw an exception. Numeric dimensions are always considered "smaller"
+ *  than symbolic dimensions. */
+ex minimal_dim(const ex & dim1, const ex & dim2);
+
 } // namespace GiNaC
 
 #endif // ndef __GINAC_IDX_H__