Cadabra
Computer algebra system for field theory problems
Compare.hh
Go to the documentation of this file.
1 
2 #pragma once
3 
4 #include "Storage.hh"
5 #include "Props.hh"
6 #include "properties/Indices.hh"
7 
8 namespace cadabra {
9 
52 
53  int subtree_compare(const Properties*,
54  Ex::iterator one, Ex::iterator two,
55  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2,
56  bool literal_wildcards=false);
57 
59 
60  bool tree_less(const Properties*,
61  const Ex& one, const Ex& two,
62  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2);
63  bool tree_equal(const Properties*,
64  const Ex& one, const Ex& two,
65  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2);
66  bool tree_exact_less(const Properties*,
67  const Ex& one, const Ex& two,
68  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2,
69  bool literal_wildcards=false);
70  bool tree_exact_equal(const Properties*,
71  const Ex& one, const Ex& two,
72  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2,
73  bool literal_wildcards=false);
74 
75  bool subtree_less(const Properties*,
76  Ex::iterator one, Ex::iterator two,
77  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2);
78  bool subtree_equal(const Properties*,
79  Ex::iterator one, Ex::iterator two,
80  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2);
81  bool subtree_exact_less(const Properties*,
82  Ex::iterator one, Ex::iterator two,
83  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2,
84  bool literal_wildcards=false);
85  bool subtree_exact_equal(const Properties*,
86  Ex::iterator one, Ex::iterator two,
87  int mod_prel=-2, bool checksets=true, int compare_multiplier=-2,
88  bool literal_wildcards=false);
89 
91  //
92  class tree_less_obj {
93  public:
94  tree_less_obj(const Properties*);
95  bool operator()(const Ex& first, const Ex& second) const;
96  private:
98  };
99 
101  public:
103  bool operator()(const Ex& first, const Ex& second) const;
104  private:
106  };
107 
109  public:
110  tree_equal_obj(const Properties*);
111  bool operator()(const Ex& first, const Ex& second) const;
112  private:
114  };
115 
117  //
119  public:
121  bool operator()(const Ex& first, const Ex& second) const;
122  private:
124  };
125 
127  public:
129  bool operator()(const Ex& first, const Ex& second) const;
130  private:
132  };
133 
135  public:
137  bool operator()(const Ex& first, const Ex& second) const;
138  private:
140  };
141 
143  public:
145  bool operator()(const Ex& first, const Ex& second) const;
146  private:
148  };
149 
156 
158  public:
159  bool operator()(const Ex& first, const Ex& second) const;
160  };
161 
163  //
165  public:
166  tree_exact_less_no_wildcards_obj(); // disables property handling
168  bool operator()(const Ex& first, const Ex& second) const;
169  private:
171  };
172 
174  public:
176  bool operator()(const Ex& first, const Ex& second) const;
177  private:
179  };
180 
181 
188 
190  public:
191  Ex_comparator(const Properties&);
192 
193  enum class match_t {
194  node_match=0, // a single node matches
195  subtree_match=1, // identical match, including index names
196  match_index_less=2, // structure match, indices in same set, but different names
198  no_match_indexpos_less=4, // mismatch but only for index positions
200  no_match_less=6, // more serious mismatch
202  };
203 
204  enum class useprops_t {
205  always=0, // always use property info
206  not_at_top, // don't use property info at top level of the expression
207  never=2 // never use property info
208  };
209 
211 
212  void clear();
213 
221 
222  void set_value_matches_index(bool);
223 
232 
233  match_t equal_subtree(Ex::iterator i1, Ex::iterator i2,
234  useprops_t use_props=useprops_t::always, bool ignore_parent_rel=false);
235 
238 
239  match_t match_subtree(const Ex&, Ex::iterator i1, Ex::iterator i2, Ex::iterator conditions);
240 
247 
248  match_t match_subproduct(const Ex&,
249  Ex::sibling_iterator lhs, Ex::sibling_iterator tofind,
250  Ex::sibling_iterator st, Ex::iterator conditions);
251 
258 
259  match_t match_subsum(const Ex&,
260  Ex::sibling_iterator lhs, Ex::sibling_iterator tofind,
261  Ex::sibling_iterator st, Ex::iterator conditions);
262 
266 
267  bool satisfies_conditions(Ex::iterator conditions, std::string& error);
268 
270 
271  typedef std::map<Ex, Ex, tree_exact_less_no_wildcards_obj> replacement_map_t;
273 
275 
276  typedef std::map<nset_t::iterator, Ex::iterator, nset_it_less> subtree_replacement_map_t;
278 
281 
283 
288 
289  std::vector<Ex::sibling_iterator> factor_locations;
290  std::vector<int> factor_moving_signs;
292 
297 
300 
301  bool should_swap(Ex::iterator obj, match_t subtree_comparison) ;
302 
312 
313  int can_swap(Ex::iterator one, Ex::iterator two, match_t subtree_comparison,
314  bool ignore_implicit_indices=false);
315 
320 
321  int can_swap_components(Ex::iterator one, Ex::iterator two,
322  match_t subtree_comparison);
323 
327 
328  int can_move_adjacent(Ex::iterator prod, Ex::sibling_iterator one,
329  Ex::sibling_iterator two, bool fix_one=false) ;
330 
331 
334  int can_move_to_front(Ex&, Ex::iterator prod, Ex::sibling_iterator one);
335 
338 
339  int can_move_adjacent(Ex::iterator prod, const std::vector<Ex::sibling_iterator>& factors, Ex::sibling_iterator to_move);
340 
341  protected:
343 
345 
350 
351  match_t compare(const Ex::iterator&, const Ex::iterator&,
352  bool nobrackets=false,
353  useprops_t use_props=useprops_t::always,
354  bool ignore_parent_rel=false);
355 
356  // Internal functions used by can_swap.
357  int can_swap_prod_obj(Ex::iterator prod, Ex::iterator obj, bool) ;
358  int can_swap_prod_prod(Ex::iterator prod1, Ex::iterator prod2, bool) ;
359  int can_swap_sum_obj(Ex::iterator sum, Ex::iterator obj, bool) ;
360  int can_swap_prod_sum(Ex::iterator prod, Ex::iterator sum, bool) ;
361  int can_swap_sum_sum(Ex::iterator sum1, Ex::iterator sum2, bool) ;
362  int can_swap_ilist_ilist(Ex::iterator obj1, Ex::iterator obj2);
363  bool can_swap_different_indexsets(Ex::iterator obj1, Ex::iterator obj2);
364 
365  std::string tab() const;
366  match_t report(match_t r) const;
367 
368  static int offset;
369  };
370 
374 
376  public:
378  bool operator()(const Ex&, const Ex&);
379  private:
381  };
382 
383  class Ex_is_less {
384  public:
385  Ex_is_less(const Properties&, int mod_prel);
386  bool operator()(const Ex&, const Ex&);
387  private:
389  int mod_prel;
390  };
391 
392 
393 
394  }
395 
396 bool operator<(const cadabra::Ex::iterator&, const cadabra::Ex::iterator&);
397 bool operator<(const cadabra::Ex&, const cadabra::Ex&);
398 std::ostream& operator<<(std::ostream&, cadabra::Ex_comparator::useprops_t up);
cadabra::Ex_comparator::useprops_t
useprops_t
Definition: Compare.hh:204
cadabra::Ex_comparator::match_subsum
match_t match_subsum(const Ex &, Ex::sibling_iterator lhs, Ex::sibling_iterator tofind, Ex::sibling_iterator st, Ex::iterator conditions)
Find a sub-sum in a sum.
Definition: Compare.cc:974
cadabra::tree_exact_equal_mod_prel_obj::properties
const Properties * properties
Definition: Compare.hh:147
cadabra::tree_exact_equal_obj
Definition: Compare.hh:134
Storage.hh
cadabra::tree_less_obj::properties
const Properties * properties
Definition: Compare.hh:97
cadabra::Ex_comparator::match_t
match_t
Definition: Compare.hh:193
cadabra::tree_less_modprel_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:202
cadabra::tree_exact_less_mod_prel_obj::tree_exact_less_mod_prel_obj
tree_exact_less_mod_prel_obj(const Properties *)
Definition: Compare.cc:247
cadabra::Ex_comparator::match_t::no_match_indexpos_greater
cadabra::tree_exact_equal
bool tree_exact_equal(const Properties *properties, const Ex &one, const Ex &two, int mod_prel, bool checksets, int compare_multiplier, bool literal_wildcards)
Definition: Compare.cc:152
cadabra::tree_exact_less_mod_prel_obj::properties
const Properties * properties
Definition: Compare.hh:131
cadabra::subtree_equal
bool subtree_equal(const Properties *properties, Ex::iterator one, Ex::iterator two, int mod_prel, bool checksets, int compare_multiplier)
Definition: Compare.cc:164
cadabra::tree_less_modprel_obj
Definition: Compare.hh:100
cadabra::Ex_comparator::can_move_to_front
int can_move_to_front(Ex &, Ex::iterator prod, Ex::sibling_iterator one)
Determine whether object 'one' can be moved to be the first factor in the given product.
Definition: Compare.cc:1161
cadabra::Ex_is_equivalent::operator()
bool operator()(const Ex &, const Ex &)
Definition: Compare.cc:1674
operator<
bool operator<(const cadabra::Ex::iterator &, const cadabra::Ex::iterator &)
Definition: Compare.cc:1695
cadabra::Ex_comparator::compare
match_t compare(const Ex::iterator &, const Ex::iterator &, bool nobrackets=false, useprops_t use_props=useprops_t::always, bool ignore_parent_rel=false)
Internal entry point.
Definition: Compare.cc:465
cadabra::tree_exact_less_no_wildcards_obj
Compare two trees exactly, treat wildcard names as ordinary names.
Definition: Compare.hh:164
cadabra::tree_exact_less_no_wildcards_obj::tree_exact_less_no_wildcards_obj
tree_exact_less_no_wildcards_obj()
Definition: Compare.cc:227
cadabra::Ex_comparator::can_swap_sum_obj
int can_swap_sum_obj(Ex::iterator sum, Ex::iterator obj, bool)
Definition: Compare.cc:1321
cadabra::tree_exact_less_obj::tree_exact_less_obj
tree_exact_less_obj(const Properties *)
Definition: Compare.cc:217
cadabra::Ex_comparator::equal_subtree
match_t equal_subtree(Ex::iterator i1, Ex::iterator i2, useprops_t use_props=useprops_t::always, bool ignore_parent_rel=false)
Match two subtrees taking into account symbol properties.
Definition: Compare.cc:296
cadabra::subtree_less
bool subtree_less(const Properties *properties, Ex::iterator one, Ex::iterator two, int mod_prel, bool checksets, int compare_multiplier)
Definition: Compare.cc:157
cadabra::Ex_is_equivalent::Ex_is_equivalent
Ex_is_equivalent(const Properties &)
Definition: Compare.cc:1669
cadabra::tree_equal_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:212
cadabra::tree_exact_less_obj
Compare two trees exactly, i.e. including exact index names.
Definition: Compare.hh:118
cadabra::Ex_is_less::mod_prel
int mod_prel
Definition: Compare.hh:389
cadabra::Ex_comparator::match_t::no_match_less
cadabra::Ex_comparator::properties
const Properties & properties
Definition: Compare.hh:342
cadabra::Ex_comparator::can_swap
int can_swap(Ex::iterator one, Ex::iterator two, match_t subtree_comparison, bool ignore_implicit_indices=false)
Determine whether obj and obj+1 be exchanged? If yes, return the sign, if no return zero.
Definition: Compare.cc:1429
cadabra::Ex_comparator::match_t::match_index_less
cadabra::tree_less_modprel_obj::properties
const Properties * properties
Definition: Compare.hh:105
cadabra::Ex_comparator::useprops_t::not_at_top
cadabra::subtree_exact_equal
bool subtree_exact_equal(const Properties *properties, Ex::iterator one, Ex::iterator two, int mod_prel, bool checksets, int compare_multiplier, bool literal_wildcards)
Definition: Compare.cc:179
cadabra::tree_exact_less_no_wildcards_mod_prel_obj::properties
const Properties * properties
Definition: Compare.hh:178
cadabra::Ex_comparator::offset
static int offset
Definition: Compare.hh:368
cadabra::Ex_comparator::factor_locations
std::vector< Ex::sibling_iterator > factor_locations
Information to keep track of where individual factors/terms in a sub-product/sub-sum were found,...
Definition: Compare.hh:289
cadabra::subtree_compare
int subtree_compare(const Properties *properties, Ex::iterator one, Ex::iterator two, int mod_prel, bool, int compare_multiplier, bool literal_wildcards)
Definition: Compare.cc:28
cadabra::Ex_comparator::useprops_t::never
cadabra::Ex_comparator::clear
void clear()
Reset the object for a new match.
Definition: Compare.cc:273
cadabra::Ex_comparator::index_value_map
replacement_map_t index_value_map
Map for matching of index names to index values.
Definition: Compare.hh:282
cadabra::tree_exact_equal_obj::tree_exact_equal_obj
tree_exact_equal_obj(const Properties *)
cadabra::Ex_comparator::can_swap_different_indexsets
bool can_swap_different_indexsets(Ex::iterator obj1, Ex::iterator obj2)
Definition: Compare.cc:1403
cadabra::Ex_comparator::replacement_map
replacement_map_t replacement_map
Definition: Compare.hh:272
cadabra::Ex_comparator::subtree_replacement_map
subtree_replacement_map_t subtree_replacement_map
Definition: Compare.hh:277
cadabra::Ex_comparator::set_value_matches_index
void set_value_matches_index(bool)
Determine whether Coordinates in the pattern (first argument to functions below) can match against In...
Definition: Compare.cc:416
cadabra::Ex_comparator::tab
std::string tab() const
Definition: Compare.cc:421
cadabra::tree_exact_equal_mod_prel_obj
Definition: Compare.hh:142
cadabra::Ex_comparator::match_t::no_match_indexpos_less
cadabra::Ex_comparator::Ex_comparator
Ex_comparator(const Properties &)
Definition: Compare.cc:411
cadabra::Ex_comparator::can_move_adjacent
int can_move_adjacent(Ex::iterator prod, Ex::sibling_iterator one, Ex::sibling_iterator two, bool fix_one=false)
Determine whether object 'one' and 'two' can be moved next to each other by moving either one or the ...
Definition: Compare.cc:1106
cadabra::Ex_comparator::can_swap_prod_obj
int can_swap_prod_obj(Ex::iterator prod, Ex::iterator obj, bool)
Definition: Compare.cc:1280
cadabra::Ex_comparator::match_subproduct
match_t match_subproduct(const Ex &, Ex::sibling_iterator lhs, Ex::sibling_iterator tofind, Ex::sibling_iterator st, Ex::iterator conditions)
Find a sub-product in a product.
Definition: Compare.cc:880
cadabra::Ex_comparator::match_t::match_index_greater
cadabra::Ex_is_equivalent
Definition: Compare.hh:375
cadabra::Ex_comparator::can_swap_prod_prod
int can_swap_prod_prod(Ex::iterator prod1, Ex::iterator prod2, bool)
Definition: Compare.cc:1305
cadabra::tree_exact_less_no_wildcards_mod_prel_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:237
cadabra::tree_equal
bool tree_equal(const Properties *properties, const Ex &one, const Ex &two, int mod_prel, bool checksets, int compare_multiplier)
Definition: Compare.cc:142
cadabra::Ex_comparator::match_t::no_match_greater
cadabra::tree_exact_less_no_wildcards_obj::properties
const Properties * properties
Definition: Compare.hh:170
cadabra::tree_less
bool tree_less(const Properties *properties, const Ex &one, const Ex &two, int mod_prel, bool checksets, int compare_multiplier)
Various comparison functions, some exact, some with pattern logic.
Definition: Compare.cc:137
cadabra::Ex_comparator::lhs_contains_dummies
bool lhs_contains_dummies
Flag to indicate whether additional care must be taken to handle dummies in the lhs of the pattern.
Definition: Compare.hh:296
cadabra::Ex_comparator::can_swap_ilist_ilist
int can_swap_ilist_ilist(Ex::iterator obj1, Ex::iterator obj2)
Definition: Compare.cc:1374
cadabra::one
void one(rset_t::iterator &num)
Definition: Storage.cc:999
cadabra::Ex_comparator::should_swap
bool should_swap(Ex::iterator obj, match_t subtree_comparison)
Determine whether two objects should be swapped according to the available SortOrder properties.
Definition: Compare.cc:1248
cadabra::Ex_comparator::factor_moving_signs
std::vector< int > factor_moving_signs
Definition: Compare.hh:290
cadabra::Ex_is_less::operator()
bool operator()(const Ex &, const Ex &)
Definition: Compare.cc:1686
cadabra::subtree_exact_less
bool subtree_exact_less(const Properties *properties, Ex::iterator one, Ex::iterator two, int mod_prel, bool checksets, int compare_multiplier, bool literal_wildcards)
Definition: Compare.cc:171
cadabra::tree_exact_less_no_wildcards_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:232
cadabra::Ex_comparator::report
match_t report(match_t r) const
Definition: Compare.cc:429
cadabra::tree_exact_less
bool tree_exact_less(const Properties *properties, const Ex &one, const Ex &two, int mod_prel, bool checksets, int compare_multiplier, bool literal_wildcards)
Definition: Compare.cc:147
cadabra::Ex
Definition: Storage.hh:140
cadabra::tree_exact_less_no_wildcards_mod_prel_obj::tree_exact_less_no_wildcards_mod_prel_obj
tree_exact_less_no_wildcards_mod_prel_obj(const Properties *)
cadabra::Ex_comparator::term_ratio
multiplier_t term_ratio
Definition: Compare.hh:291
cadabra::tree_equal_obj::properties
const Properties * properties
Definition: Compare.hh:113
cadabra::Ex_comparator::value_matches_index
bool value_matches_index
Definition: Compare.hh:344
cadabra::tree_exact_less_obj::properties
const Properties * properties
Definition: Compare.hh:123
cadabra::Ex_comparator::can_swap_prod_sum
int can_swap_prod_sum(Ex::iterator prod, Ex::iterator sum, bool)
Definition: Compare.cc:1340
cadabra::tree_equal_obj::tree_equal_obj
tree_equal_obj(const Properties *)
Definition: Compare.cc:207
cadabra::Ex_comparator::match_t::subtree_match
cadabra::Ex_is_equivalent::properties
const Properties & properties
Definition: Compare.hh:380
cadabra
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Adjform.cc:80
cadabra::tree_exact_equal_mod_prel_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:257
Props.hh
cadabra::Ex_is_less::properties
const Properties & properties
Definition: Compare.hh:388
cadabra::tree_equal_obj
Definition: Compare.hh:108
cadabra::Ex_comparator::can_swap_components
int can_swap_components(Ex::iterator one, Ex::iterator two, match_t subtree_comparison)
Wrapper for can_swap which is meant for objects that have implicit indices.
Definition: Compare.cc:1171
cadabra::Properties
Definition: Props.hh:233
cadabra::multiplier_t
mpq_class multiplier_t
Definition: Storage.hh:38
cadabra::Ex_comparator::satisfies_conditions
bool satisfies_conditions(Ex::iterator conditions, std::string &error)
Check whether the a match found by calling equal_subtree or match_subproduct satisfies the conditions...
Definition: Compare.cc:1524
cadabra::tree_less_modprel_obj::tree_less_modprel_obj
tree_less_modprel_obj(const Properties *)
Definition: Compare.cc:197
cadabra::tree_exact_less_no_wildcards_mod_prel_obj
Definition: Compare.hh:173
cadabra::tree_exact_less_mod_prel_obj
Definition: Compare.hh:126
cadabra::tree_exact_less_mod_prel_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:252
cadabra::Ex_comparator::useprops_t::always
cadabra::lhs
Ex lhs(Ex_ptr ex)
Definition: py_ex.cc:293
cadabra::Ex_is_less
Definition: Compare.hh:383
cadabra::Ex_comparator::replacement_map_t
std::map< Ex, Ex, tree_exact_less_no_wildcards_obj > replacement_map_t
Map for the replacement of nodes (indices, patterns).
Definition: Compare.hh:271
cadabra::tree_less_obj
Compare two trees by pattern logic, i.e. modulo index names.
Definition: Compare.hh:92
cadabra::Ex_comparator::can_swap_sum_sum
int can_swap_sum_sum(Ex::iterator sum1, Ex::iterator sum2, bool)
Definition: Compare.cc:1357
cadabra::tree_exact_less_for_indexmap_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:262
cadabra::tree_exact_equal_mod_prel_obj::tree_exact_equal_mod_prel_obj
tree_exact_equal_mod_prel_obj(const Properties *)
cadabra::tree_less_obj::tree_less_obj
tree_less_obj(const Properties *)
Definition: Compare.cc:187
cadabra::tree_exact_less_for_indexmap_obj
Compare for indexmap_t.
Definition: Compare.hh:157
snoop::error
const char error[]
Definition: Snoop.hh:161
cadabra::tree_less_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:192
cadabra::Ex_comparator::match_t::node_match
cadabra::tree_exact_equal_obj::properties
const Properties * properties
Definition: Compare.hh:139
Indices.hh
cadabra::Ex_comparator
Definition: Compare.hh:189
operator<<
std::ostream & operator<<(std::ostream &, cadabra::Ex_comparator::useprops_t up)
Definition: Compare.cc:1705
cadabra::Ex_comparator::match_subtree
match_t match_subtree(const Ex &, Ex::iterator i1, Ex::iterator i2, Ex::iterator conditions)
Match two subtrees, new-style equal_subtree that handles conditions; this is what substitute uses.
Definition: Compare.cc:282
cadabra::tree_exact_less_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:222
cadabra::Ex_comparator::subtree_replacement_map_t
std::map< nset_t::iterator, Ex::iterator, nset_it_less > subtree_replacement_map_t
Map for the replacement of entire subtrees (object patterns).
Definition: Compare.hh:276
cadabra::Ex_is_less::Ex_is_less
Ex_is_less(const Properties &, int mod_prel)
Definition: Compare.cc:1681
cadabra::tree_exact_equal_obj::operator()
bool operator()(const Ex &first, const Ex &second) const
Definition: Compare.cc:242