Cadabra
Computer algebra system for field theory problems
Storage.hh
Go to the documentation of this file.
1 /*
2 
3  Cadabra: a field-theory motivated computer algebra system.
4  Copyright (C) 2001-2014 Kasper Peeters <kasper.peeters@phi-sci.com>
5 
6  This program is free software: you can redistribute it and/or
7  modify it under the terms of the GNU General Public License as
8  published by the Free Software Foundation, either version 3 of the
9  License, or (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with this program. If not, see <http://www.gnu.org/licenses/>.
18 
19 */
20 
21 #pragma once
22 
23 #include <cstddef>
24 #include <iostream>
25 #include <gmpxx.h>
26 #include <string>
27 #include <vector>
28 #include <set>
29 #include <map>
30 #include <stdint.h>
31 #include <assert.h>
32 #include <initializer_list>
33 
34 #include "tree.hh"
35 
36 namespace cadabra {
37 
38 typedef mpq_class multiplier_t;
39 typedef std::set<std::string> nset_t;
40 typedef std::set<multiplier_t> rset_t;
41 typedef uintptr_t hashval_t;
42 
43 long to_long(multiplier_t);
44 std::string to_string(long);
45 
46 extern nset_t name_set;
47 extern rset_t rat_set;
48 
54 
55 class str_node { // size: 9 bytes (32 bit arch), can be reduced to 5 bytes.
56  public:
58 
62 
63  str_node(void);
64  str_node(nset_t::iterator name, bracket_t btype=b_none, parent_rel_t ptype=p_none);
65  str_node(const std::string& name, bracket_t btype=b_none, parent_rel_t ptype=p_none);
66 
67  bool operator==(const str_node&) const;
68  bool operator<(const str_node&) const;
69 
70  nset_t::iterator name;
71  rset_t::iterator multiplier;
72 
73 #ifdef _WIN32
74  struct flag_t {
75  bool keep_after_eval ;
78  bool line_per_node ;
79  };
80 #else
81  struct flag_t { // kept inside 8 bits for speed and size
82  bool keep_after_eval : 1;
85  bool line_per_node : 1;
86  };
87 #endif
88 
90 
93  void flip_parent_rel();
94 
95  bool is_zero() const;
96  bool is_identity() const;
97  bool is_rational() const;
98  bool is_unsimplified_rational() const;
99  bool is_integer() const;
100  bool is_unsimplified_integer() const;
101  bool is_index() const; // _ or ^ parent_rel (does not query properties)
102  bool is_quoted_string() const;
103  bool is_command() const;
104  bool is_inert_command() const;
105  bool is_name_wildcard() const; // ?
106  bool is_object_wildcard() const; // ??
107  bool is_range_wildcard() const; // #{..}
108  bool is_siblings_wildcard() const; // a...
109  bool is_autodeclare_wildcard() const; // m#
110  bool is_indexstar_wildcard() const; // ?* in sub/super
111  bool is_indexplus_wildcard() const; // ?+ in sub/super
112  bool is_numbered_symbol() const; // [a-zA-Z]+[0-9]+
113 
114  nset_t::iterator name_only();
115 
116  static bool compare_names_only(const str_node&, const str_node&);
117  static bool compare_name_brack_par(const str_node&, const str_node&);
118  static bool compare_name_inverse_par(const str_node&, const str_node&);
119 };
120 
124 void multiply(rset_t::iterator&, multiplier_t);
125 void add(rset_t::iterator&, multiplier_t);
126 void zero(rset_t::iterator&);
127 void one(rset_t::iterator&);
128 void flip_sign(rset_t::iterator&);
129 void half(rset_t::iterator&);
130 
138 
139 class Ex : public std::enable_shared_from_this<Ex>, public tree<str_node> {
140  public:
141  Ex();
142 // Ex(const tree<str_node>&);
143  Ex(tree<str_node>::iterator);
144  Ex(const str_node&);
145  Ex(const Ex&);
147  Ex(const std::string&);
148  Ex(int);
149 
157 
159  result_t state() const;
160  void update_state(result_t);
161  void reset_state();
162 
167  bool changed_state();
168 
171  bool is_rational() const;
172  multiplier_t to_rational() const;
173 
177  static std::ostream& print_python(std::ostream& str, Ex::iterator it);
178 
180  std::ostream& print_entire_tree(std::ostream& str) const;
181  static std::ostream& print_recursive_treeform(std::ostream& str, Ex::iterator it);
182  static std::ostream& print_recursive_treeform(std::ostream& str, Ex::iterator it, unsigned int& number);
183 
185  std::ostream& print_repr(std::ostream& str, Ex::iterator it) const;
186 
188  iterator named_parent(iterator it, const std::string&) const;
189  iterator erase_expression(iterator it);
190 
192  hashval_t calc_hash(iterator it) const;
193 
195  static sibling_iterator arg(iterator, unsigned int);
196  static unsigned int arg_size(sibling_iterator);
197 
198  multiplier_t arg_to_num(sibling_iterator, unsigned int) const; // shorthand for numerical arguments
199 
200  // Like 'child', but using index iterators instead.
201 // sibling_iterator tensor_index(const iterator_base& position, unsigned int) const;
202 
203  // Number of \\history nodes in an expression
204  unsigned int number_of_steps(iterator it) const;
205  // Given an iterator pointing to any node in the tree, figure
206  // out to which equation number it belongs.
207  unsigned int number_of_equations() const;
208  unsigned int equation_number(iterator it) const;
209  nset_t::iterator equation_label(iterator it) const;
210  iterator equation_by_number(unsigned int i) const;
211  iterator equation_by_name(nset_t::iterator it) const;
212  iterator equation_by_name(nset_t::iterator it, unsigned int& ) const;
213  iterator equation_by_number_or_name(iterator it, unsigned int last_used_equation) const;
214  iterator equation_by_number_or_name(iterator it, unsigned int last_used_equation,
215  unsigned int&) const;
216  std::string equation_number_or_name(iterator it, unsigned int last_used_equation) const;
217  iterator procedure_by_name(nset_t::iterator it) const;
218 
230  iterator replace_index(iterator position, const iterator& from, bool keep_parent_rel=false);
231 
234  iterator move_index(iterator position, const iterator& from);
235 
239  void list_wrap_single_element(iterator&);
240  void list_unwrap_single_element(iterator&);
241 
246  iterator flatten_and_erase(iterator position);
247 
250 
251  bool operator==(const Ex& other) const;
252 
254  void push_history(Ex selector);
255 
258  Ex pop_history();
259 
262  int history_size() const;
263 
264  private:
266 
267  std::vector<tree<str_node> > history;
269  std::vector<tree<str_node> > selectors;
270 };
271 
272 
276 
278  public:
279  bool operator()(nset_t::iterator first, nset_t::iterator second) const;
280 };
281 
282 template <typename T>
283 bool is_in(const T& val, const std::initializer_list<T>& list)
284  {
285  for (const auto& i : list) {
286  if (val == i) {
287  return true;
288  }
289  }
290  return false;
291  }
292 
293 }
294 
302 
303 std::ostream& operator<<(std::ostream&, const cadabra::Ex&);
304 std::ostream& operator<<(std::ostream&, cadabra::Ex::iterator);
bool is_quoted_string() const
Definition: Storage.cc:726
std::ostream & operator<<(std::ostream &, const cadabra::Ex &)
Bare output operator for Ex objects, mainly to provide a simple way to generate debugging output...
Definition: Storage.cc:937
Definition: Storage.hh:81
Definition: Storage.hh:158
bool is_integer() const
Definition: Storage.cc:689
bool operator==(const str_node &) const
Definition: Storage.cc:854
nset_t::iterator equation_label(iterator it) const
Definition: Storage.cc:397
std::ostream & print_entire_tree(std::ostream &str) const
Output helpers mainly for debugging purposes.
Definition: Storage.cc:230
rset_t rat_set
Definition: Storage.cc:32
iterator equation_by_number(unsigned int i) const
Definition: Storage.cc:434
static bool compare_names_only(const str_node &, const str_node &)
Definition: Storage.cc:864
bool is_command() const
Definition: Storage.cc:734
void reset_state()
Definition: Storage.cc:102
multiplier_t arg_to_num(sibling_iterator, unsigned int) const
Definition: Storage.cc:368
Definition: Storage.hh:57
Basic storage class for symbolic mathemematical expressions.
Definition: Storage.hh:139
Definition: Storage.hh:61
std::ostream & print_repr(std::ostream &str, Ex::iterator it) const
Print a representation like Python&#39;s &#39;repr&#39;.
Definition: Storage.cc:206
bool keep_after_eval
Definition: Storage.hh:82
void list_wrap_single_element(iterator &)
Make sure that the node pointed to is a \comma object, i.e.
Definition: Storage.cc:525
bool is_name_wildcard() const
Definition: Storage.cc:756
Definition: Storage.hh:61
static bool compare_name_inverse_par(const str_node &, const str_node &)
Definition: Storage.cc:878
std::vector< tree< str_node > > selectors
Patterns which describe how to get from one history step to the next.
Definition: Storage.hh:269
Definition: Storage.hh:61
void flip_parent_rel()
Change the parent relation from sub to super and vice versa (throws error when this is not an index)...
Definition: Storage.cc:665
Definition: Storage.hh:61
Definition: Storage.hh:158
bool is_autodeclare_wildcard() const
Definition: Storage.cc:796
void flip_sign(rset_t::iterator &num)
Definition: Storage.cc:917
Definition: Storage.hh:57
long to_long(multiplier_t mul)
Definition: Storage.cc:34
bool is_rational() const
Definition: Storage.cc:684
static std::ostream & print_python(std::ostream &str, Ex::iterator it)
Display expression in Python/Cadabra input form.
Definition: Storage.cc:130
str_node(void)
Definition: Storage.cc:636
result_t state() const
Definition: Storage.cc:82
Definition: Storage.hh:57
bool operator<(const str_node &) const
Definition: Storage.cc:927
Definition: Storage.hh:61
bool changed_state()
A status query method mainly to implement a simple method to apply algorithms until they converge...
Definition: Storage.cc:107
static unsigned int arg_size(sibling_iterator)
Definition: Storage.cc:362
Definition: Storage.hh:61
iterator move_index(iterator position, const iterator &from)
As in replace_index, but moves the index rather than making a copy (so that iterators.
Definition: Storage.cc:514
Definition: Storage.hh:57
Definition: Storage.hh:158
void zero(rset_t::iterator &num)
Definition: Storage.cc:907
bool is_zero() const
Definition: Storage.cc:672
void update_state(result_t)
Definition: Storage.cc:87
bool is_index() const
Definition: Storage.cc:718
parent_rel_t parent_rel
Definition: Storage.hh:84
multiplier_t to_rational() const
Definition: Storage.cc:123
iterator named_parent(iterator it, const std::string &) const
Step up until matching node is found (if current node matches, do nothing)
Definition: Storage.cc:312
Definition: Storage.hh:57
Elementary building block for a mathematical expression.
Definition: Storage.hh:55
void list_unwrap_single_element(iterator &)
Definition: Storage.cc:536
void one(rset_t::iterator &num)
Definition: Storage.cc:912
unsigned int number_of_equations() const
Definition: Storage.cc:557
nset_t::iterator name
Definition: Storage.hh:70
bool is_inert_command() const
Definition: Storage.cc:747
std::string equation_number_or_name(iterator it, unsigned int last_used_equation) const
Definition: Storage.cc:597
std::set< std::string > nset_t
Definition: Storage.hh:39
static std::ostream & print_recursive_treeform(std::ostream &str, Ex::iterator it)
Definition: Storage.cc:217
bool is_indexplus_wildcard() const
Definition: Storage.cc:813
bool is_numbered_symbol() const
Definition: Storage.cc:822
flag_t fl
Definition: Storage.hh:89
bool is_unsimplified_integer() const
Definition: Storage.cc:708
bool operator==(const Ex &other) const
Compare two Ex objects for exact equality; no dummy equivalence or other things that require property...
Definition: Storage.cc:611
void add(rset_t::iterator &num, multiplier_t fac)
Definition: Storage.cc:901
bool is_range_wildcard() const
Definition: Storage.cc:778
int history_size() const
Return the size of the history; 0 means no history, just the current expression.
Definition: Storage.cc:631
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Algorithm.cc:1626
void half(rset_t::iterator &num)
Definition: Storage.cc:922
static sibling_iterator arg(iterator, unsigned int)
Quick access to arguments or argument lists for A(B)(C,D) type nodes.
Definition: Storage.cc:353
unsigned int equation_number(iterator it) const
Definition: Storage.cc:376
Ex pop_history()
Pop the most recent state of the expression off the history stack; returns the selector that got us t...
Definition: Storage.cc:622
bool is_siblings_wildcard() const
Definition: Storage.cc:787
iterator flatten_and_erase(iterator position)
Replace the node with the children of the node, useful for e.g.
Definition: Storage.cc:546
bool is_object_wildcard() const
Definition: Storage.cc:769
void multiply(rset_t::iterator &num, multiplier_t fac)
Helper functions for manipulation of multipliers.
Definition: Storage.cc:895
iterator replace_index(iterator position, const iterator &from, bool keep_parent_rel=false)
Replace the index-like object (originally intended to replace indices only, but now used also for e...
Definition: Storage.cc:502
void push_history(Ex selector)
Push a copy of the current state of the expression onto the history stack.
Definition: Storage.cc:616
rset_t::iterator multiplier
Definition: Storage.hh:71
Definition: Storage.hh:158
std::string to_string(long num)
Definition: Storage.cc:39
iterator equation_by_name(nset_t::iterator it) const
Definition: Storage.cc:452
mpq_class multiplier_t
Definition: Storage.hh:38
Ex()
Definition: Storage.cc:48
hashval_t calc_hash(iterator it) const
Calculate the hash value for the subtree starting at &#39;it&#39;.
Definition: Storage.cc:332
nset_t name_set
Definition: Storage.cc:31
Definition: Storage.hh:57
bool is_rational() const
Test if the expression is a rational number.
Definition: Storage.cc:115
static bool compare_name_brack_par(const str_node &, const str_node &)
Definition: Storage.cc:870
bool is_unsimplified_rational() const
Definition: Storage.cc:698
bool is_in(const T &val, const std::initializer_list< T > &list)
Definition: Storage.hh:283
parent_rel_t
Child nodes are related to their parent node by a so-called parent relation, which can be one of thes...
Definition: Storage.hh:61
bool is_identity() const
Definition: Storage.cc:678
nset_t::iterator name_only()
Definition: Storage.cc:831
std::vector< tree< str_node > > history
Definition: Storage.hh:267
iterator erase_expression(iterator it)
Definition: Storage.cc:325
bool operator()(nset_t::iterator first, nset_t::iterator second) const
Definition: Storage.cc:887
bracket_t
Definition: Storage.hh:57
Definition: Storage.hh:61
iterator procedure_by_name(nset_t::iterator it) const
Definition: Storage.cc:482
result_t
Keeping track of what algorithms have done to this expression.
Definition: Storage.hh:158
bracket_t bracket
Definition: Storage.hh:83
bool line_per_node
Definition: Storage.hh:85
bool is_indexstar_wildcard() const
Definition: Storage.cc:804
Definition: Storage.hh:57
Compare two nset iterators by comparing the strings to which they point.
Definition: Storage.hh:277
unsigned int number_of_steps(iterator it) const
uintptr_t hashval_t
Definition: Storage.hh:41
result_t state_
Definition: Storage.hh:265
std::set< multiplier_t > rset_t
Definition: Storage.hh:40
iterator equation_by_number_or_name(iterator it, unsigned int last_used_equation) const
Definition: Storage.cc:591