#define __GINAC_EX_H__
#include <iosfwd>
+#include <iterator>
#include <functional>
#include "basic.h"
class ex
{
friend class archive_node;
- friend bool are_ex_trivially_equal(const ex &, const ex &);
- template<class T> friend const T &ex_to(const ex &);
- template<class T> friend bool is_a(const ex &);
- template<class T> friend bool is_exactly_a(const ex &);
+ friend inline bool are_ex_trivially_equal(const ex &, const ex &);
+ template<class T> friend inline const T &ex_to(const ex &);
+ template<class T> friend inline bool is_a(const ex &);
+ template<class T> friend inline bool is_exactly_a(const ex &);
// default constructor, copy constructor and assignment operator
public:
* Undefined symbols and other parser errors will throw an exception. */
ex(const std::string &s, const ex &l);
+public:
+ // Iterators
+ class const_iterator : public std::iterator<std::random_access_iterator_tag, ex, ptrdiff_t, const ex *, const ex &>
+ {
+ friend class ex;
+
+ public:
+ const_iterator() {}
+ const_iterator(const basic *bp_, size_t i_) : bp(bp_), i(i_) {}
+
+ bool operator==(const const_iterator &other) const
+ {
+ return bp == other.bp && i == other.i;
+ }
+
+ bool operator!=(const const_iterator &other) const
+ {
+ return !(*this == other);
+ }
+
+ bool operator<(const const_iterator &other) const
+ {
+ return i < other.i;
+ }
+
+ bool operator>(const const_iterator &other) const
+ {
+ return other < *this;
+ }
+
+ bool operator<=(const const_iterator &other) const
+ {
+ return !(other < *this);
+ }
+
+ bool operator>=(const const_iterator &other) const
+ {
+ return !(*this < other);
+ }
+
+ // This should return an ex&, but that would be a reference to a
+ // temporary value
+ ex operator*() const
+ {
+ return bp->op(i);
+ }
+
+#if 0
+ // How do we make this work in the context of the "reference to
+ // temporary" problem? Return an auto_ptr?
+ pointer operator->() const
+ {
+ return &(operator*());
+ }
+#endif
+
+ const_iterator &operator++()
+ {
+ ++i;
+ return *this;
+ }
+
+ const_iterator operator++(int)
+ {
+ const_iterator tmp = *this;
+ ++i;
+ return tmp;
+ }
+
+ const_iterator &operator+=(difference_type n)
+ {
+ i += n;
+ return *this;
+ }
+
+ const_iterator operator+(difference_type n) const
+ {
+ return const_iterator(bp, i + n);
+ }
+
+ inline friend const_iterator operator+(difference_type n, const const_iterator &it)
+ {
+ return const_iterator(it.bp, it.i + n);
+ }
+
+ const_iterator &operator--()
+ {
+ --i;
+ return *this;
+ }
+
+ const_iterator operator--(int)
+ {
+ const_iterator tmp = *this;
+ --i;
+ return tmp;
+ }
+
+ const_iterator &operator-=(difference_type n)
+ {
+ i -= n;
+ return *this;
+ }
+
+ const_iterator operator-(difference_type n) const
+ {
+ return const_iterator(bp, i - n);
+ }
+
+ inline friend difference_type operator-(const const_iterator &lhs, const const_iterator &rhs)
+ {
+ return lhs.i - rhs.i;
+ }
+
+ reference operator[](difference_type n) const
+ {
+ }
+
+ protected:
+ const basic *bp;
+ size_t i;
+ };
+
+ const_iterator begin() const { return const_iterator(get_pointer(bp), 0); }
+ const_iterator end() const { return const_iterator(get_pointer(bp), bp->nops()); }
+
+#if 0
+ // This doesn't work because of the "reference to temporary" problem
+ // in operator*()
+ typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
+ const_reverse_iterator rbegin() const { return const_reverse_iterator(end()); }
+ const_reverse_iterator rend() const { return const_reverse_iterator(begin()); }
+#endif
+
// non-virtual functions in this class
public:
/** Efficiently swap the contents of two expressions. */
bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
// substitutions
- ex subs(const lst & ls, const lst & lr, unsigned options = 0) const { return bp->subs(ls, lr, options); }
- ex subs(const ex & e, unsigned options = 0) const { return bp->subs(e, options); }
+ ex subs(const exmap & m, unsigned options = 0) const;
+ ex subs(const lst & ls, const lst & lr, unsigned options = 0) const;
+ ex subs(const ex & e, unsigned options = 0) const;
// function mapping
ex map(map_function & f) const { return bp->map(f); }
inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
{ return thisex.match(pattern, repl_lst); }
-inline ex subs(const ex & thisex, const ex & e, unsigned options = 0)
-{ return thisex.subs(e, options); }
-
-inline ex subs(const ex & thisex, const lst & ls, const lst & lr, unsigned options = 0)
-{ return thisex.subs(ls, lr, options); }
-
inline ex simplify_indexed(const ex & thisex)
{ return thisex.simplify_indexed(); }
inline void swap(ex & e1, ex & e2)
{ e1.swap(e2); }
-
-// This makes STL algorithms use the more efficient swap operation for ex objects
-inline void iter_swap(std::vector<ex>::iterator i1, std::vector<ex>::iterator i2)
-{ i1->swap(*i2); }
-
-
/* Function objects for STL sort() etc. */
struct ex_is_less : public std::binary_function<ex, ex, bool> {
bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
};
+inline ex ex::subs(const exmap & m, unsigned options) const
+{
+ return bp->subs(m, options);
+}
+
+inline ex subs(const ex & thisex, const exmap & m, unsigned options = 0)
+{ return thisex.subs(m, options); }
+
+inline ex subs(const ex & thisex, const lst & ls, const lst & lr, unsigned options = 0)
+{ return thisex.subs(ls, lr, options); }
+
+inline ex subs(const ex & thisex, const ex & e, unsigned options = 0)
+{ return thisex.subs(e, options); }
+
/* Convert function pointer to function object suitable for map(). */
class pointer_to_map_function : public map_function {
protected:
ex (*ptr)(const ex &);
public:
- explicit pointer_to_map_function(ex (*x)(const ex &)) : ptr(x) {}
+ explicit pointer_to_map_function(ex x(const ex &)) : ptr(x) {}
ex operator()(const ex & e) { return ptr(e); }
};
ex (*ptr)(const ex &, T1);
T1 arg1;
public:
- explicit pointer_to_map_function_1arg(ex (*x)(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
+ explicit pointer_to_map_function_1arg(ex x(const ex &, T1), T1 a1) : ptr(x), arg1(a1) {}
ex operator()(const ex & e) { return ptr(e, arg1); }
};
T1 arg1;
T2 arg2;
public:
- explicit pointer_to_map_function_2args(ex (*x)(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
+ explicit pointer_to_map_function_2args(ex x(const ex &, T1, T2), T1 a1, T2 a2) : ptr(x), arg1(a1), arg2(a2) {}
ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
};
T2 arg2;
T3 arg3;
public:
- explicit pointer_to_map_function_3args(ex (*x)(const ex &, T1, T2, T3), T1 a1, T2 a2, T3 a3) : ptr(x), arg1(a1), arg2(a2), arg3(a3) {}
+ explicit pointer_to_map_function_3args(ex x(const ex &, T1, T2, T3), T1 a1, T2 a2, T3 a3) : ptr(x), arg1(a1), arg2(a2), arg3(a3) {}
ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
};
-inline ex ex::map(ex (*f)(const ex & e)) const
+inline ex ex::map(ex f(const ex &)) const
{
pointer_to_map_function fcn(f);
return bp->map(fcn);
}
+// convenience type checker template functions
+
+/** Check if ex is a handle to a T, including base classes. */
+template <class T>
+inline bool is_a(const ex &obj)
+{
+ return is_a<T>(*obj.bp);
+}
+
+/** Check if ex is a handle to a T, not including base classes. */
+template <class T>
+inline bool is_exactly_a(const ex &obj)
+{
+ return is_exactly_a<T>(*obj.bp);
+}
+
+/** Return a reference to the basic-derived class T object embedded in an
+ * expression. This is fast but unsafe: the result is undefined if the
+ * expression does not contain a T object at its top level. Hence, you
+ * should generally check the type of e first.
+ *
+ * @param e expression
+ * @return reference to object of class T
+ * @see is_exactly_a<class T>() */
+template <class T>
+inline const T &ex_to(const ex &e)
+{
+ GINAC_ASSERT(is_a<T>(e));
+ return static_cast<const T &>(*e.bp);
+}
} // namespace GiNaC
+
+// Specializations of Standard Library algorithms
+namespace std {
+
+/** Specialization of std::swap() for ex objects. */
+template <>
+inline void swap(GiNaC::ex &a, GiNaC::ex &b)
+{
+ a.swap(b);
+}
+
+/** Specialization of std::iter_swap() for vector<ex> iterators. */
+template <>
+inline void iter_swap(vector<GiNaC::ex>::iterator i1, vector<GiNaC::ex>::iterator i2)
+{
+ i1->swap(*i2);
+}
+
+/** Specialization of std::iter_swap() for list<ex> iterators. */
+template <>
+inline void iter_swap(list<GiNaC::ex>::iterator i1, list<GiNaC::ex>::iterator i2)
+{
+ i1->swap(*i2);
+}
+
+} // namespace std
+
#endif // ndef __GINAC_EX_H__