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  str_node(const std::u32string& name, bracket_t btype=b_none, parent_rel_t ptype=p_none);
67 
68  bool operator==(const str_node&) const;
69  bool operator<(const str_node&) const;
70 
71  nset_t::iterator name;
72  rset_t::iterator multiplier;
73 
74 #ifdef _WIN32
75  struct flag_t {
76  bool keep_after_eval ;
79  bool line_per_node ;
80  };
81 #else
82  struct flag_t { // kept inside 8 bits for speed and size
83  bool keep_after_eval : 1;
86  bool line_per_node : 1;
87  };
88 #endif
89 
91 
94  void flip_parent_rel();
95 
96  bool is_zero() const;
97  bool is_identity() const;
98  bool is_rational() const;
99  bool is_unsimplified_rational() const;
100  bool is_integer() const;
101  bool is_unsimplified_integer() const;
102  bool is_index() const; // _ or ^ parent_rel (does not query properties)
103  bool is_quoted_string() const;
104  bool is_command() const;
105  bool is_inert_command() const;
106  bool is_name_wildcard() const; // ?
107  bool is_object_wildcard() const; // ??
108  bool is_range_wildcard() const; // #{..}
109  bool is_siblings_wildcard() const; // a...
110  bool is_autodeclare_wildcard() const; // m#
111  bool is_indexstar_wildcard() const; // ?* in sub/super
112  bool is_indexplus_wildcard() const; // ?+ in sub/super
113  bool is_numbered_symbol() const; // [a-zA-Z]+[0-9]+
114 
115  nset_t::iterator name_only();
116 
117  static bool compare_names_only(const str_node&, const str_node&);
118  static bool compare_name_brack_par(const str_node&, const str_node&);
119  static bool compare_name_inverse_par(const str_node&, const str_node&);
120  };
121 
125  void multiply(rset_t::iterator&, multiplier_t);
126  void add(rset_t::iterator&, multiplier_t);
127  void zero(rset_t::iterator&);
128  void one(rset_t::iterator&);
129  void flip_sign(rset_t::iterator&);
130  void half(rset_t::iterator&);
131 
139 
140  class Ex : public std::enable_shared_from_this<Ex>, public tree<str_node> {
141  public:
142  Ex();
143  // Ex(const tree<str_node>&);
144  Ex(tree<str_node>::iterator);
145  Ex(const str_node&);
146  Ex(const Ex&);
148  Ex(const std::string&);
149  Ex(int);
150 
158 
160  result_t state() const;
161  void update_state(result_t);
162  void reset_state();
163 
168  bool changed_state();
169 
172  bool is_rational() const;
173  multiplier_t to_rational() const;
174 
178  static std::ostream& print_python(std::ostream& str, Ex::iterator it);
179 
181  std::ostream& print_entire_tree(std::ostream& str) const;
182  static std::ostream& print_recursive_treeform(std::ostream& str, Ex::iterator it);
183  static std::ostream& print_recursive_treeform(std::ostream& str, Ex::iterator it, unsigned int& number);
184 
186  std::ostream& print_repr(std::ostream& str, Ex::iterator it) const;
187 
189  iterator named_parent(iterator it, const std::string&) const;
190  iterator erase_expression(iterator it);
191 
193  hashval_t calc_hash(iterator it) const;
194 
196  static sibling_iterator arg(iterator, unsigned int);
197  static unsigned int arg_size(sibling_iterator);
198 
199  multiplier_t arg_to_num(sibling_iterator, unsigned int) const; // shorthand for numerical arguments
200 
201  // Like 'child', but using index iterators instead.
202  // sibling_iterator tensor_index(const iterator_base& position, unsigned int) const;
203 
204  // Number of \\history nodes in an expression
205  unsigned int number_of_steps(iterator it) const;
206  // Given an iterator pointing to any node in the tree, figure
207  // out to which equation number it belongs.
208  unsigned int number_of_equations() const;
209  unsigned int equation_number(iterator it) const;
210  nset_t::iterator equation_label(iterator it) const;
211  iterator equation_by_number(unsigned int i) const;
212  iterator equation_by_name(nset_t::iterator it) const;
213  iterator equation_by_name(nset_t::iterator it, unsigned int& ) const;
214  iterator equation_by_number_or_name(iterator it, unsigned int last_used_equation) const;
215  iterator equation_by_number_or_name(iterator it, unsigned int last_used_equation,
216  unsigned int&) const;
217  std::string equation_number_or_name(iterator it, unsigned int last_used_equation) const;
218  iterator procedure_by_name(nset_t::iterator it) const;
219 
220  // Determine whether a node has an '\ldots' parent (not necessarily direct).
221  bool is_hidden(iterator) const;
222 
234  iterator replace_index(iterator position, const iterator& from, bool keep_parent_rel=false);
235 
238  iterator move_index(iterator position, const iterator& from);
239 
243  void list_wrap_single_element(iterator&);
244  void list_unwrap_single_element(iterator&);
245 
250  iterator flatten_and_erase(iterator position);
251 
254 
255  bool operator==(const Ex& other) const;
256 
261  void push_history(const std::vector<Ex::path_t>&);
262 
266  std::vector<Ex::path_t> pop_history();
267 
270  int history_size() const;
271 
272  private:
274 
275  std::vector<tree<str_node> > history;
277  std::vector<std::vector<Ex::path_t> > terms;
278  };
279 
280 
284 
285  class nset_it_less {
286  public:
287  bool operator()(nset_t::iterator first, nset_t::iterator second) const;
288  };
289 
290  template <typename T>
291  bool is_in(const T& val, const std::initializer_list<T>& list)
292  {
293  for (const auto& i : list) {
294  if (val == i) {
295  return true;
296  }
297  }
298  return false;
299  }
300 
301  }
302 
310 
311 std::ostream& operator<<(std::ostream&, const cadabra::Ex&);
312 std::ostream& operator<<(std::ostream&, cadabra::Ex::iterator);
bool is_quoted_string() const
Definition: Storage.cc:807
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:1024
Definition: Storage.hh:82
Definition: Storage.hh:159
bool is_integer() const
Definition: Storage.cc:770
bool operator==(const str_node &) const
Definition: Storage.cc:935
nset_t::iterator equation_label(iterator it) const
Definition: Storage.cc:446
std::ostream & print_entire_tree(std::ostream &str) const
Output helpers mainly for debugging purposes.
Definition: Storage.cc:269
rset_t rat_set
Definition: Storage.cc:35
iterator equation_by_number(unsigned int i) const
Definition: Storage.cc:483
static bool compare_names_only(const str_node &, const str_node &)
Definition: Storage.cc:945
bool is_command() const
Definition: Storage.cc:815
void reset_state()
Definition: Storage.cc:105
multiplier_t arg_to_num(sibling_iterator, unsigned int) const
Definition: Storage.cc:417
Definition: Storage.hh:57
Basic storage class for symbolic mathemematical expressions.
Definition: Storage.hh:140
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:236
bool keep_after_eval
Definition: Storage.hh:83
void list_wrap_single_element(iterator &)
Make sure that the node pointed to is a \comma object, i.e.
Definition: Storage.cc:585
bool is_name_wildcard() const
Definition: Storage.cc:837
Definition: Storage.hh:61
static bool compare_name_inverse_par(const str_node &, const str_node &)
Definition: Storage.cc:959
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:746
Definition: Storage.hh:61
Definition: Storage.hh:159
bool is_autodeclare_wildcard() const
Definition: Storage.cc:877
void flip_sign(rset_t::iterator &num)
Definition: Storage.cc:1000
Definition: Storage.hh:57
long to_long(multiplier_t mul)
Definition: Storage.cc:37
bool is_rational() const
Definition: Storage.cc:765
static std::ostream & print_python(std::ostream &str, Ex::iterator it)
Display expression in Python/Cadabra input form.
Definition: Storage.cc:133
str_node(void)
Definition: Storage.cc:696
result_t state() const
Definition: Storage.cc:85
Definition: Storage.hh:57
bool operator<(const str_node &) const
Definition: Storage.cc:1014
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:110
static unsigned int arg_size(sibling_iterator)
Definition: Storage.cc:411
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 pointing to the...
Definition: Storage.cc:574
Definition: Storage.hh:57
Definition: Storage.hh:159
void zero(rset_t::iterator &num)
Definition: Storage.cc:990
bool is_zero() const
Definition: Storage.cc:753
void update_state(result_t)
Definition: Storage.cc:90
bool is_index() const
Definition: Storage.cc:799
parent_rel_t parent_rel
Definition: Storage.hh:85
multiplier_t to_rational() const
Definition: Storage.cc:126
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:361
Definition: Storage.hh:57
Elementary building block for a mathematical expression.
Definition: Storage.hh:55
void list_unwrap_single_element(iterator &)
Definition: Storage.cc:596
void one(rset_t::iterator &num)
Definition: Storage.cc:995
unsigned int number_of_equations() const
Definition: Storage.cc:617
nset_t::iterator name
Definition: Storage.hh:71
bool is_inert_command() const
Definition: Storage.cc:828
std::string equation_number_or_name(iterator it, unsigned int last_used_equation) const
Definition: Storage.cc:657
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:247
bool is_indexplus_wildcard() const
Definition: Storage.cc:894
bool is_numbered_symbol() const
Definition: Storage.cc:903
flag_t fl
Definition: Storage.hh:90
bool is_unsimplified_integer() const
Definition: Storage.cc:789
void push_history(const std::vector< Ex::path_t > &)
Push a copy of the current state of the expression onto the history stack.
Definition: Storage.cc:676
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:671
void add(rset_t::iterator &num, multiplier_t fac)
Definition: Storage.cc:983
std::vector< std::vector< Ex::path_t > > terms
Patterns which describe how to get from one history step to the next.
Definition: Storage.hh:277
bool is_range_wildcard() const
Definition: Storage.cc:859
int history_size() const
Return the size of the history; 0 means no history, just the current expression.
Definition: Storage.cc:691
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Algorithm.cc:1045
void half(rset_t::iterator &num)
Definition: Storage.cc:1007
static sibling_iterator arg(iterator, unsigned int)
Quick access to arguments or argument lists for A(B)(C,D) type nodes.
Definition: Storage.cc:402
unsigned int equation_number(iterator it) const
Definition: Storage.cc:425
std::vector< Ex::path_t > pop_history()
Pop the most recent state of the expression off the history stack; returns the set of paths that we a...
Definition: Storage.cc:682
bool is_siblings_wildcard() const
Definition: Storage.cc:868
iterator flatten_and_erase(iterator position)
Replace the node with the children of the node, useful for e.g.
Definition: Storage.cc:606
bool is_object_wildcard() const
Definition: Storage.cc:850
void multiply(rset_t::iterator &num, multiplier_t fac)
Helper functions for manipulation of multipliers.
Definition: Storage.cc:976
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:562
rset_t::iterator multiplier
Definition: Storage.hh:72
Definition: Storage.hh:159
std::string to_string(long num)
Definition: Storage.cc:42
iterator equation_by_name(nset_t::iterator it) const
Definition: Storage.cc:501
mpq_class multiplier_t
Definition: Storage.hh:38
Ex()
Definition: Storage.cc:51
hashval_t calc_hash(iterator it) const
Calculate the hash value for the subtree starting at &#39;it&#39;.
Definition: Storage.cc:381
nset_t name_set
Definition: Storage.cc:34
Definition: Storage.hh:57
bool is_rational() const
Test if the expression is a rational number.
Definition: Storage.cc:118
static bool compare_name_brack_par(const str_node &, const str_node &)
Definition: Storage.cc:951
bool is_unsimplified_rational() const
Definition: Storage.cc:779
bool is_in(const T &val, const std::initializer_list< T > &list)
Definition: Storage.hh:291
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:759
nset_t::iterator name_only()
Definition: Storage.cc:912
std::vector< tree< str_node > > history
Definition: Storage.hh:275
iterator erase_expression(iterator it)
Definition: Storage.cc:374
bool operator()(nset_t::iterator first, nset_t::iterator second) const
Definition: Storage.cc:968
bracket_t
Definition: Storage.hh:57
Definition: Storage.hh:61
iterator procedure_by_name(nset_t::iterator it) const
Definition: Storage.cc:542
result_t
Keeping track of what algorithms have done to this expression.
Definition: Storage.hh:159
bracket_t bracket
Definition: Storage.hh:84
bool line_per_node
Definition: Storage.hh:86
bool is_indexstar_wildcard() const
Definition: Storage.cc:885
Definition: Storage.hh:57
Compare two nset iterators by comparing the strings to which they point.
Definition: Storage.hh:285
bool is_hidden(iterator) const
Definition: Storage.cc:531
unsigned int number_of_steps(iterator it) const
uintptr_t hashval_t
Definition: Storage.hh:41
result_t state_
Definition: Storage.hh:273
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:651