32 #include <initializer_list>
39 typedef std::set<std::string>
nset_t;
40 typedef std::set<multiplier_t>
rset_t;
128 void zero(rset_t::iterator&);
129 void one(rset_t::iterator&);
131 void half(rset_t::iterator&);
142 class Ex :
public std::enable_shared_from_this<Ex>,
public tree<str_node> {
146 Ex(tree<str_node>::iterator);
150 Ex(
const std::string&);
203 static std::ostream&
print_python(std::ostream& str, Ex::iterator it);
211 std::ostream&
print_repr(std::ostream& str, Ex::iterator it)
const;
214 iterator
named_parent(iterator it,
const std::string&)
const;
221 static sibling_iterator
arg(iterator,
unsigned int);
222 static unsigned int arg_size(sibling_iterator);
241 unsigned int&)
const;
259 iterator
replace_index(iterator position,
const iterator& from,
bool keep_parent_rel=
false);
263 iterator
move_index(iterator position,
const iterator& from);
302 std::vector<std::vector<Ex::path_t> >
terms;
312 bool operator()(nset_t::iterator first, nset_t::iterator second)
const;
315 template <
typename T>
316 bool is_in(
const T& val,
const std::initializer_list<T>& list)
318 for (
const auto& i : list) {
337 std::ostream&
operator<<(std::ostream&, cadabra::Ex::iterator);
Basic storage class for symbolic mathemematical expressions.
Definition: Storage.hh:142
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:621
void list_unwrap_single_element(iterator &)
Definition: Storage.cc:643
multiplier_t arg_to_num(sibling_iterator, unsigned int) const
Definition: Storage.cc:464
static std::ostream & print_python(std::ostream &str, Ex::iterator it)
Display expression in Python/Cadabra input form.
Definition: Storage.cc:178
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:718
std::string equation_number_or_name(iterator it, unsigned int last_used_equation) const
Definition: Storage.cc:704
result_t
Keeping track of what algorithms have done to this expression.
Definition: Storage.hh:164
@ l_cached
Definition: Storage.hh:170
@ l_error
Definition: Storage.hh:169
@ l_checkpointed
Definition: Storage.hh:165
@ l_no_action
Definition: Storage.hh:166
@ l_applied_no_new_dummies
Definition: Storage.hh:168
@ l_applied
Definition: Storage.hh:167
hashval_t calc_hash(iterator it) const
Calculate the hash value for the subtree starting at 'it'.
Definition: Storage.cc:426
void reset_state()
Definition: Storage.cc:130
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:406
static sibling_iterator arg(iterator, unsigned int)
Quick access to arguments or argument lists for A(B)(C,D) type nodes.
Definition: Storage.cc:449
iterator erase_expression(iterator it)
Definition: Storage.cc:419
result_t state() const
Definition: Storage.cc:110
std::ostream & print_entire_tree(std::ostream &str) const
Output helpers mainly for debugging purposes.
Definition: Storage.cc:314
result_t state_
Definition: Storage.hh:298
bool is_integer() const
Definition: Storage.cc:158
static unsigned int arg_size(sibling_iterator)
Definition: Storage.cc:458
void list_wrap_single_element(iterator &)
Make sure that the node pointed to is a \comma object, i.e.
Definition: Storage.cc:632
long to_integer() const
Definition: Storage.cc:166
iterator equation_by_name(nset_t::iterator it) const
Definition: Storage.cc:548
bool changed_state()
A status query method mainly to implement a simple method to apply algorithms until they converge.
Definition: Storage.cc:135
unsigned int equation_number(iterator it) const
Definition: Storage.cc:472
int history_size() const
Return the size of the history; 0 means no history, just the current expression.
Definition: Storage.cc:744
bool is_hidden(iterator) const
Definition: Storage.cc:578
Ex()
Definition: Storage.cc:57
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:735
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:729
iterator procedure_by_name(nset_t::iterator it) const
Definition: Storage.cc:589
unsigned int number_of_steps(iterator it) const
Ex & operator=(Ex)
Definition: Storage.cc:78
bool is_empty() const
Test if the expression is empty (no content at all).
Definition: Storage.cc:173
bool is_rational() const
Test if the expression is a rational number.
Definition: Storage.cc:143
iterator equation_by_number(unsigned int i) const
Definition: Storage.cc:530
std::vector< tree< str_node > > history
Definition: Storage.hh:300
std::ostream & print_repr(std::ostream &str, Ex::iterator it) const
Print a representation like Python's 'repr'.
Definition: Storage.cc:281
multiplier_t to_rational() const
Definition: Storage.cc:151
iterator flatten_and_erase(iterator position)
Replace the node with the children of the node, useful for e.g.
Definition: Storage.cc:653
nset_t::iterator equation_label(iterator it) const
Definition: Storage.cc:493
std::vector< std::vector< Ex::path_t > > terms
Patterns which describe how to get from one history step to the next.
Definition: Storage.hh:302
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:609
static std::ostream & print_recursive_treeform(std::ostream &str, Ex::iterator it)
Definition: Storage.cc:292
iterator equation_by_number_or_name(iterator it, unsigned int last_used_equation) const
Definition: Storage.cc:698
unsigned int number_of_equations() const
Definition: Storage.cc:664
void update_state(result_t)
Definition: Storage.cc:115
Compare two nset iterators by comparing the strings to which they point.
Definition: Storage.hh:310
bool operator()(nset_t::iterator first, nset_t::iterator second) const
Definition: Storage.cc:1021
Elementary building block for a mathematical expression.
Definition: Storage.hh:56
bool is_indexstar_wildcard() const
Definition: Storage.cc:938
bool is_index() const
Definition: Storage.cc:852
bool is_unsimplified_integer() const
Definition: Storage.cc:842
bool operator<(const str_node &) const
Definition: Storage.cc:1073
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:799
bracket_t
Definition: Storage.hh:58
@ b_round
Definition: Storage.hh:58
@ b_none
Definition: Storage.hh:58
@ b_square
Definition: Storage.hh:58
@ b_no
Definition: Storage.hh:58
@ b_pointy
Definition: Storage.hh:58
@ b_curly
Definition: Storage.hh:58
@ b_invalid
Definition: Storage.hh:58
bool is_numbered_symbol() const
Definition: Storage.cc:956
str_node(void)
Definition: Storage.cc:749
static bool compare_name_brack_par(const str_node &, const str_node &)
Definition: Storage.cc:1004
bool is_quoted_string() const
Definition: Storage.cc:860
bool is_unsimplified_rational() const
Definition: Storage.cc:832
bool is_siblings_wildcard() const
Definition: Storage.cc:921
nset_t::iterator name_only()
Definition: Storage.cc:965
bool is_command() const
Definition: Storage.cc:868
bool is_object_wildcard() const
Definition: Storage.cc:903
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:62
@ p_exponent
Definition: Storage.hh:62
@ p_sub
Definition: Storage.hh:62
@ p_invalid
Definition: Storage.hh:62
@ p_property
Definition: Storage.hh:62
@ p_none
Definition: Storage.hh:62
@ p_super
Definition: Storage.hh:62
@ p_components
Definition: Storage.hh:62
rset_t::iterator multiplier
Definition: Storage.hh:73
static bool compare_name_inverse_par(const str_node &, const str_node &)
Definition: Storage.cc:1012
bool is_inert_command() const
Definition: Storage.cc:881
bool is_indexplus_wildcard() const
Definition: Storage.cc:947
bool is_range_wildcard() const
Definition: Storage.cc:912
bool is_identity() const
Definition: Storage.cc:812
bool is_name_wildcard() const
Definition: Storage.cc:890
bool is_autodeclare_wildcard() const
Definition: Storage.cc:930
nset_t::iterator name
Definition: Storage.hh:72
static bool compare_names_only(const str_node &, const str_node &)
Definition: Storage.cc:998
bool is_zero() const
Definition: Storage.cc:806
flag_t fl
Definition: Storage.hh:91
bool operator==(const str_node &) const
Definition: Storage.cc:988
bool is_integer() const
Definition: Storage.cc:823
bool is_rational() const
Definition: Storage.cc:818
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:1084
void multiply(rset_t::iterator &num, multiplier_t fac)
Helper functions for manipulation of multipliers.
Definition: Storage.cc:1029
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Adjform.cc:83
rset_t rat_set
Definition: Storage.cc:36
std::set< multiplier_t > rset_t
Definition: Storage.hh:40
void flip_sign(rset_t::iterator &num)
Definition: Storage.cc:1059
double to_double(multiplier_t mul)
Definition: Storage.cc:43
uintptr_t hashval_t
Definition: Storage.hh:41
void zero(rset_t::iterator &num)
Definition: Storage.cc:1049
bool is_in(const T &val, const std::initializer_list< T > &list)
Definition: Storage.hh:316
std::set< std::string > nset_t
Definition: Storage.hh:39
void one(rset_t::iterator &num)
Definition: Storage.cc:1054
void half(rset_t::iterator &num)
Definition: Storage.cc:1066
void set(rset_t::iterator &num, multiplier_t fac)
Definition: Storage.cc:1036
void add(rset_t::iterator &num, multiplier_t fac)
Definition: Storage.cc:1042
long to_long(multiplier_t mul)
Definition: Storage.cc:38
mpq_class multiplier_t
Definition: Storage.hh:38
nset_t name_set
Definition: Storage.cc:35
std::string to_string(long num)
Definition: Storage.cc:48
Definition: Storage.hh:83
bracket_t bracket
Definition: Storage.hh:85
bool line_per_node
Definition: Storage.hh:87
bool keep_after_eval
Definition: Storage.hh:84
parent_rel_t parent_rel
Definition: Storage.hh:86