mention the "dummy()" function option

[ginac.git] / ginac / idx.h

diff --git a/ginac/idx.h b/ginac/idx.h
index ecc6f468439bb7c25d9fc12b2cdcfcd2077bc711..13004fd4db8359e36d723b63225773a6b1ccff19 100644 (file)
--- a/ginac/idx.h
+++ b/ginac/idx.h
@@ -48,16 +48,17 @@ public:
 
        // 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:
@@ -68,22 +69,22 @@ 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_exactly_a<numeric>(value);}
+       bool is_numeric() const {return is_exactly_a<numeric>(value);}
 
        /** Check whether the index is symbolic. */
-       bool is_symbolic(void) const {return !is_exactly_a<numeric>(value);}
+       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_exactly_a<numeric>(dim);}
+       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_exactly_a<numeric>(dim);}
+       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;
@@ -92,6 +93,12 @@ public:
         *  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) */
        ex dim;   /**< Dimension of space (can be symbolic or numeric) */
@@ -116,7 +123,6 @@ public:
 
        // 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:
@@ -125,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:
@@ -161,7 +171,6 @@ public:
 
        // 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:
@@ -170,18 +179,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:
@@ -248,7 +262,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);
@@ -256,13 +270,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__