GiNaC 1.8.7
idx.h
Go to the documentation of this file.
1
5/*
6 * GiNaC Copyright (C) 1999-2023 Johannes Gutenberg University Mainz, Germany
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23#ifndef GINAC_IDX_H
24#define GINAC_IDX_H
25
26#include "ex.h"
27#include "numeric.h"
28
29namespace GiNaC {
30
35class idx : public basic
36{
38
39 // other constructors
40public:
45 explicit idx(const ex & v, const ex & dim);
46
47 // functions overriding virtual functions from base classes
48public:
49 bool info(unsigned inf) const override;
50 size_t nops() const override;
51 ex op(size_t i) const override;
52 ex map(map_function & f) const override;
53 ex evalf() const override;
54 ex subs(const exmap & m, unsigned options = 0) const override;
55 void archive(archive_node& n) const override;
56 void read_archive(const archive_node& n, lst& syms) override;
57protected:
58 ex derivative(const symbol & s) const override;
59 bool match_same_type(const basic & other) const override;
60 unsigned calchash() const override;
61
62 // new virtual functions in this class
63public:
66 virtual bool is_dummy_pair_same_type(const basic & other) const;
67
68 // non-virtual functions in this class
69public:
71 ex get_value() const {return value;}
72
74 bool is_numeric() const {return is_exactly_a<numeric>(value);}
75
77 bool is_symbolic() const {return !is_exactly_a<numeric>(value);}
78
80 ex get_dim() const {return dim;}
81
83 bool is_dim_numeric() const {return is_exactly_a<numeric>(dim);}
84
86 bool is_dim_symbolic() const {return !is_exactly_a<numeric>(dim);}
87
89 ex replace_dim(const ex & new_dim) const;
90
93 ex minimal_dim(const idx & other) const;
94
95protected:
96 void print_index(const print_context & c, unsigned level) const;
97 void do_print(const print_context & c, unsigned level) const;
98 void do_print_csrc(const print_csrc & c, unsigned level) const;
99 void do_print_latex(const print_latex & c, unsigned level) const;
100 void do_print_tree(const print_tree & c, unsigned level) const;
101
102protected:
105};
107
108
111class varidx : public idx
112{
114
115 // other constructors
116public:
122 varidx(const ex & v, const ex & dim, bool covariant = false);
123
124 // functions overriding virtual functions from base classes
125public:
126 bool is_dummy_pair_same_type(const basic & other) const override;
127 void archive(archive_node& n) const override;
128 void read_archive(const archive_node& n, lst& syms) override;
129protected:
130 bool match_same_type(const basic & other) const override;
131
132 // non-virtual functions in this class
133public:
135 bool is_covariant() const {return covariant;}
136
138 bool is_contravariant() const {return !covariant;}
139
141 ex toggle_variance() const;
142
143protected:
144 void do_print(const print_context & c, unsigned level) const;
145 void do_print_tree(const print_tree & c, unsigned level) const;
146
147 // member variables
148protected:
150};
152
153
159class spinidx : public varidx
160{
162
163 // other constructors
164public:
171 spinidx(const ex & v, const ex & dim = 2, bool covariant = false, bool dotted = false);
172
173 // functions overriding virtual functions from base classes
174public:
175 bool is_dummy_pair_same_type(const basic & other) const override;
176 // complex conjugation
177 ex conjugate() const override { return toggle_dot(); }
178 void archive(archive_node& n) const override;
179 void read_archive(const archive_node& n, lst& syms) override;
180protected:
181 bool match_same_type(const basic & other) const override;
182
183 // non-virtual functions in this class
184public:
186 bool is_dotted() const {return dotted;}
187
189 bool is_undotted() const {return !dotted;}
190
193 ex toggle_dot() const;
194
197 ex toggle_variance_dot() const;
198
199protected:
200 void do_print(const print_context & c, unsigned level) const;
201 void do_print_latex(const print_latex & c, unsigned level) const;
202 void do_print_tree(const print_tree & c, unsigned level) const;
203
204 // member variables
205protected:
206 bool dotted;
207};
209
210
211// utility functions
212
214bool is_dummy_pair(const idx & i1, const idx & i2);
215
217bool is_dummy_pair(const ex & e1, const ex & e2);
218
227void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator itend, exvector & out_free, exvector & out_dummy);
228
236inline void find_free_and_dummy(const exvector & v, exvector & out_free, exvector & out_dummy)
237{
238 find_free_and_dummy(v.begin(), v.end(), out_free, out_dummy);
239}
240
245inline void find_dummy_indices(const exvector & v, exvector & out_dummy)
246{
247 exvector free_indices;
248 find_free_and_dummy(v.begin(), v.end(), free_indices, out_dummy);
249}
250
252inline size_t count_dummy_indices(const exvector & v)
253{
254 exvector free_indices, dummy_indices;
255 find_free_and_dummy(v.begin(), v.end(), free_indices, dummy_indices);
256 return dummy_indices.size();
257}
258
260inline size_t count_free_indices(const exvector & v)
261{
262 exvector free_indices, dummy_indices;
263 find_free_and_dummy(v.begin(), v.end(), free_indices, dummy_indices);
264 return free_indices.size();
265}
266
270ex minimal_dim(const ex & dim1, const ex & dim2);
271
272} // namespace GiNaC
273
274#endif // ndef GINAC_IDX_H
This class stores all properties needed to record/retrieve the state of one object of class basic (or...
Definition: archive.h:49
This class is the ABC (abstract base class) of GiNaC's class hierarchy.
Definition: basic.h:105
Wrapper template for making GiNaC classes out of STL containers.
Definition: container.h:73
Lightweight wrapper for GiNaC's symbolic objects.
Definition: ex.h:72
This class holds one index of an indexed object.
Definition: idx.h:36
ex map(map_function &f) const override
Construct new expression by applying the specified function to all sub-expressions (one level only,...
Definition: idx.cpp:256
void print_index(const print_context &c, unsigned level) const
Definition: idx.cpp:136
ex derivative(const symbol &s) const override
Implementation of ex::diff() for an index always returns 0.
Definition: idx.cpp:404
ex dim
Dimension of space (can be symbolic or numeric)
Definition: idx.h:104
idx(const ex &v, const ex &dim)
Construct index with given value and dimension.
Definition: idx.cpp:72
void do_print_csrc(const print_csrc &c, unsigned level) const
Definition: idx.cpp:164
bool is_dim_numeric() const
Check whether the dimension is numeric.
Definition: idx.h:83
unsigned calchash() const override
Compute the hash value of an object and if it makes sense to store it in the objects status_flags,...
Definition: idx.cpp:343
ex subs(const exmap &m, unsigned options=0) const override
Substitute a set of objects by arbitrary expressions.
Definition: idx.cpp:373
ex replace_dim(const ex &new_dim) const
Make a new index with the same value but a different dimension.
Definition: idx.cpp:460
ex op(size_t i) const override
Return operand/member at position i.
Definition: idx.cpp:250
ex value
Expression that constitutes the index (numeric or symbolic name)
Definition: idx.h:103
bool match_same_type(const basic &other) const override
Returns true if the attributes of two objects are similar enough for a match.
Definition: idx.cpp:282
virtual bool is_dummy_pair_same_type(const basic &other) const
Check whether the index forms a dummy index pair with another index of the same type.
Definition: idx.cpp:413
bool info(unsigned inf) const override
Information about the object.
Definition: idx.cpp:234
ex get_dim() const
Get dimension of index space.
Definition: idx.h:80
void do_print_latex(const print_latex &c, unsigned level) const
Definition: idx.cpp:157
bool is_symbolic() const
Check whether the index is symbolic.
Definition: idx.h:77
size_t nops() const override
Number of operands/members.
Definition: idx.cpp:244
void do_print_tree(const print_tree &c, unsigned level) const
Definition: idx.cpp:174
void read_archive(const archive_node &n, lst &syms) override
Load (deserialize) the object from an archive node.
Definition: idx.cpp:91
ex minimal_dim(const idx &other) const
Return the minimum of the dimensions of this and another index.
Definition: idx.cpp:468
void do_print(const print_context &c, unsigned level) const
Definition: idx.cpp:151
ex get_value() const
Get value of index.
Definition: idx.h:71
bool is_dim_symbolic() const
Check whether the dimension is symbolic.
Definition: idx.h:86
void archive(archive_node &n) const override
Save (serialize) the object into archive node.
Definition: idx.cpp:113
ex evalf() const override
By default, basic::evalf would evaluate the index value but we don't want a.1 to become a.
Definition: idx.cpp:368
bool is_numeric() const
Check whether the index is numeric.
Definition: idx.h:74
Base class for print_contexts.
Definition: print.h:103
Base context for C source output.
Definition: print.h:158
Context for latex-parsable output.
Definition: print.h:123
Context for tree-like output for debugging.
Definition: print.h:147
This class holds a spinor index that can be dotted or undotted and that also has a variance.
Definition: idx.h:160
void read_archive(const archive_node &n, lst &syms) override
Load (deserialize) the object from an archive node.
Definition: idx.cpp:106
void do_print_latex(const print_latex &c, unsigned level) const
Definition: idx.cpp:213
void do_print(const print_context &c, unsigned level) const
Definition: idx.cpp:202
void archive(archive_node &n) const override
Save (serialize) the object into archive node.
Definition: idx.cpp:126
spinidx(const ex &v, const ex &dim=2, bool covariant=false, bool dotted=false)
Construct index with given value, dimension, variance and dot.
Definition: idx.cpp:64
ex conjugate() const override
Definition: idx.h:177
bool match_same_type(const basic &other) const override
Returns true if the attributes of two objects are similar enough for a match.
Definition: idx.cpp:333
bool is_dotted() const
Check whether the index is dotted.
Definition: idx.h:186
ex toggle_dot() const
Make a new index with the same value and variance but the opposite dottedness.
Definition: idx.cpp:481
bool is_undotted() const
Check whether the index is not dotted.
Definition: idx.h:189
bool is_dummy_pair_same_type(const basic &other) const override
Check whether the index forms a dummy index pair with another index of the same type.
Definition: idx.cpp:444
void do_print_tree(const print_tree &c, unsigned level) const
Definition: idx.cpp:223
bool dotted
Definition: idx.h:206
ex toggle_variance_dot() const
Make a new index with the same value but opposite variance and dottedness.
Definition: idx.cpp:489
Basic CAS symbol.
Definition: symbol.h:39
This class holds an index with a variance (co- or contravariant).
Definition: idx.h:112
void read_archive(const archive_node &n, lst &syms) override
Load (deserialize) the object from an archive node.
Definition: idx.cpp:99
bool is_dummy_pair_same_type(const basic &other) const override
Check whether the index forms a dummy index pair with another index of the same type.
Definition: idx.cpp:433
varidx(const ex &v, const ex &dim, bool covariant=false)
Construct index with given value, dimension and variance.
Definition: idx.cpp:60
void do_print(const print_context &c, unsigned level) const
Definition: idx.cpp:183
void archive(archive_node &n) const override
Save (serialize) the object into archive node.
Definition: idx.cpp:120
bool match_same_type(const basic &other) const override
Returns true if the attributes of two objects are similar enough for a match.
Definition: idx.cpp:306
bool is_covariant() const
Check whether the index is covariant.
Definition: idx.h:135
bool covariant
x.mu, default is contravariant: x~mu
Definition: idx.h:149
void do_print_tree(const print_tree &c, unsigned level) const
Definition: idx.cpp:192
bool is_contravariant() const
Check whether the index is contravariant (not covariant).
Definition: idx.h:138
ex toggle_variance() const
Make a new index with the same value but the opposite variance.
Definition: idx.cpp:473
Interface to GiNaC's light-weight expression handles.
unsigned options
Definition: factor.cpp:2475
size_t n
Definition: factor.cpp:1432
size_t c
Definition: factor.cpp:757
exset syms
Definition: factor.cpp:2429
mvec m
Definition: factor.cpp:758
Definition: add.cpp:38
ex minimal_dim(const ex &dim1, const ex &dim2)
Return the minimum of two index dimensions.
Definition: idx.cpp:561
std::map< ex, ex, ex_is_less > exmap
Definition: basic.h:50
GINAC_DECLARE_UNARCHIVER(add)
size_t count_dummy_indices(const exvector &v)
Count the number of dummy index pairs in an index vector.
Definition: idx.h:252
bool is_dummy_pair(const idx &i1, const idx &i2)
Check whether two indices form a dummy pair.
Definition: idx.cpp:502
size_t count_free_indices(const exvector &v)
Count the number of dummy index pairs in an index vector.
Definition: idx.h:260
void find_dummy_indices(const exvector &v, exvector &out_dummy)
Given a vector of indices, find the dummy indices.
Definition: idx.h:245
void find_free_and_dummy(exvector::const_iterator it, exvector::const_iterator itend, exvector &out_free, exvector &out_dummy)
Given a vector of indices, split them into two vectors, one containing the free indices,...
Definition: idx.cpp:521
std::vector< ex > exvector
Definition: basic.h:48
Makes the interface to the underlying bignum package available.
#define GINAC_DECLARE_REGISTERED_CLASS(classname, supername)
Macro for inclusion in the declaration of each registered class.
Definition: registrar.h:153
Function object for map().
Definition: basic.h:85

This page is part of the GiNaC developer's reference. It was generated automatically by doxygen. For an introduction, see the tutorial.