* Interface to GiNaC's light-weight expression handles. */
/*
- * GiNaC Copyright (C) 1999-2006 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2019 Johannes Gutenberg University Mainz, Germany
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef __GINAC_EX_H__
-#define __GINAC_EX_H__
+#ifndef GINAC_EX_H
+#define GINAC_EX_H
+#include "basic.h"
+#include "ptr.h"
+
+#include <functional>
#include <iosfwd>
#include <iterator>
-#include <functional>
+#include <memory>
#include <stack>
-#include "basic.h"
-#include "ptr.h"
-
namespace GiNaC {
-
+#ifdef _MSC_VER
+ // MSVC produces a different symbol for _ex0 when it is declared inside
+ // ex::is_zero() than when it is declared at top level as follows
+ extern const ex _ex0;
+#endif
/** Helper class to initialize the library. There must be one static object
* of this class in every object file that makes use of our flyweights in
*
* @see utils.cpp */
class library_init {
+ static void init_unarchivers();
public:
library_init();
~library_init();
/** For construction of flyweights, etc. */
static library_init library_initializer;
-
class scalar_products;
class const_iterator;
class const_preorder_iterator;
class const_postorder_iterator;
-/** Lightweight wrapper for GiNaC's symbolic objects. Basically all it does is
- * to hold a pointer to the other objects, manage the reference counting and
- * provide methods for manipulation of these objects. (Some people call such
- * a thing a proxy class.) */
+/** Lightweight wrapper for GiNaC's symbolic objects. It holds a pointer to
+ * the other object in order to do garbage collection by the method of
+ * reference counting. I.e., it is a smart pointer. Also, the constructor
+ * ex::ex(const basic & other) calls the methods that do automatic
+ * evaluation. E.g., x-x turns automatically into 0. */
class ex {
friend class archive_node;
friend inline bool are_ex_trivially_equal(const ex &, const ex &);
// default constructor, copy constructor and assignment operator
public:
- ex() throw();
+ ex() noexcept;
// other constructors
public:
// non-virtual functions in this class
public:
/** Efficiently swap the contents of two expressions. */
- void swap(ex & other) throw()
+ void swap(ex & other) noexcept
{
GINAC_ASSERT(bp->flags & status_flags::dynallocated);
GINAC_ASSERT(other.bp->flags & status_flags::dynallocated);
}
// iterators
- const_iterator begin() const throw();
- const_iterator end() const throw();
+ const_iterator begin() const noexcept;
+ const_iterator end() const noexcept;
const_preorder_iterator preorder_begin() const;
- const_preorder_iterator preorder_end() const throw();
+ const_preorder_iterator preorder_end() const noexcept;
const_postorder_iterator postorder_begin() const;
- const_postorder_iterator postorder_end() const throw();
+ const_postorder_iterator postorder_end() const noexcept;
// evaluation
- ex eval(int level = 0) const { return bp->eval(level); }
- ex evalf(int level = 0) const { return bp->evalf(level); }
+ ex eval() const { return bp->eval(); }
+ ex evalf() const { return bp->evalf(); }
ex evalm() const { return bp->evalm(); }
ex eval_ncmul(const exvector & v) const { return bp->eval_ncmul(v); }
ex eval_integ() const { return bp->eval_integ(); }
// pattern matching
bool has(const ex & pattern, unsigned options = 0) const { return bp->has(pattern, options); }
- bool find(const ex & pattern, lst & found) const;
+ bool find(const ex & pattern, exset& found) const;
bool match(const ex & pattern) const;
- bool match(const ex & pattern, lst & repl_lst) const { return bp->match(pattern, repl_lst); }
+ bool match(const ex & pattern, exmap & repls) const { return bp->match(pattern, repls); }
// substitutions
ex subs(const exmap & m, unsigned options = 0) const;
ex series(const ex & r, int order, unsigned options = 0) const;
// rational functions
- ex normal(int level = 0) const;
+ ex normal() const;
ex to_rational(exmap & repl) const;
- ex to_rational(lst & repl_lst) const;
ex to_polynomial(exmap & repl) const;
- ex to_polynomial(lst & repl_lst) const;
ex numer() const;
ex denom() const;
ex numer_denom() const;
// comparison
int compare(const ex & other) const;
bool is_equal(const ex & other) const;
- bool is_zero() const { extern const ex _ex0; return is_equal(_ex0); }
+ bool is_zero() const {
+#ifndef _MSC_VER
+ extern const ex _ex0;
+#endif
+ return is_equal(_ex0);
+ }
+ bool is_zero_matrix() const;
// symmetry
ex symmetrize() const;
// noncommutativity
unsigned return_type() const { return bp->return_type(); }
- tinfo_t return_type_tinfo() const { return bp->return_type_tinfo(); }
+ return_type_t return_type_tinfo() const { return bp->return_type_tinfo(); }
unsigned gethash() const { return bp->gethash(); }
extern const basic *_num0_bp;
inline
-ex::ex() throw() : bp(*const_cast<basic *>(_num0_bp))
+ex::ex() noexcept : bp(*const_cast<basic *>(_num0_bp))
{
GINAC_ASSERT(bp->flags & status_flags::dynallocated);
}
friend class const_postorder_iterator;
public:
- const_iterator() throw() {}
+ const_iterator() noexcept {}
private:
- const_iterator(const ex &e_, size_t i_) throw() : e(e_), i(i_) {}
+ const_iterator(const ex &e_, size_t i_) noexcept : e(e_), i(i_) {}
public:
// This should return an ex&, but that would be a reference to a
// This should return an ex*, but that would be a pointer to a
// temporary value
- std::auto_ptr<ex> operator->() const
+ std::unique_ptr<ex> operator->() const
{
- return std::auto_ptr<ex>(new ex(operator*()));
+ return std::unique_ptr<ex>(new ex(operator*()));
}
ex operator[](difference_type n) const
return e.op(i + n);
}
- const_iterator &operator++() throw()
+ const_iterator &operator++() noexcept
{
++i;
return *this;
}
- const_iterator operator++(int) throw()
+ const_iterator operator++(int) noexcept
{
const_iterator tmp = *this;
++i;
return tmp;
}
- const_iterator &operator+=(difference_type n) throw()
+ const_iterator &operator+=(difference_type n) noexcept
{
i += n;
return *this;
}
- const_iterator operator+(difference_type n) const throw()
+ const_iterator operator+(difference_type n) const noexcept
{
return const_iterator(e, i + n);
}
- inline friend const_iterator operator+(difference_type n, const const_iterator &it) throw()
+ inline friend const_iterator operator+(difference_type n, const const_iterator &it) noexcept
{
return const_iterator(it.e, it.i + n);
}
- const_iterator &operator--() throw()
+ const_iterator &operator--() noexcept
{
--i;
return *this;
}
- const_iterator operator--(int) throw()
+ const_iterator operator--(int) noexcept
{
const_iterator tmp = *this;
--i;
return tmp;
}
- const_iterator &operator-=(difference_type n) throw()
+ const_iterator &operator-=(difference_type n) noexcept
{
i -= n;
return *this;
}
- const_iterator operator-(difference_type n) const throw()
+ const_iterator operator-(difference_type n) const noexcept
{
return const_iterator(e, i - n);
}
- inline friend difference_type operator-(const const_iterator &lhs, const const_iterator &rhs) throw()
+ inline friend difference_type operator-(const const_iterator &lhs, const const_iterator &rhs) noexcept
{
return lhs.i - rhs.i;
}
- bool operator==(const const_iterator &other) const throw()
+ bool operator==(const const_iterator &other) const noexcept
{
return are_ex_trivially_equal(e, other.e) && i == other.i;
}
- bool operator!=(const const_iterator &other) const throw()
+ bool operator!=(const const_iterator &other) const noexcept
{
return !(*this == other);
}
- bool operator<(const const_iterator &other) const throw()
+ bool operator<(const const_iterator &other) const noexcept
{
return i < other.i;
}
- bool operator>(const const_iterator &other) const throw()
+ bool operator>(const const_iterator &other) const noexcept
{
return other < *this;
}
- bool operator<=(const const_iterator &other) const throw()
+ bool operator<=(const const_iterator &other) const noexcept
{
return !(other < *this);
}
- bool operator>=(const const_iterator &other) const throw()
+ bool operator>=(const const_iterator &other) const noexcept
{
return !(*this < other);
}
struct _iter_rep {
_iter_rep(const ex &e_, size_t i_, size_t i_end_) : e(e_), i(i_), i_end(i_end_) {}
- bool operator==(const _iter_rep &other) const throw()
+ bool operator==(const _iter_rep &other) const noexcept
{
return are_ex_trivially_equal(e, other.e) && i == other.i;
}
- bool operator!=(const _iter_rep &other) const throw()
+ bool operator!=(const _iter_rep &other) const noexcept
{
return !(*this == other);
}
class const_preorder_iterator : public std::iterator<std::forward_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
public:
- const_preorder_iterator() throw() {}
+ const_preorder_iterator() noexcept {}
const_preorder_iterator(const ex &e, size_t n)
{
return tmp;
}
- bool operator==(const const_preorder_iterator &other) const throw()
+ bool operator==(const const_preorder_iterator &other) const noexcept
{
return s == other.s;
}
- bool operator!=(const const_preorder_iterator &other) const throw()
+ bool operator!=(const const_preorder_iterator &other) const noexcept
{
return !(*this == other);
}
private:
- std::stack<internal::_iter_rep, std::vector<internal::_iter_rep> > s;
+ std::stack<internal::_iter_rep, std::vector<internal::_iter_rep>> s;
void increment()
{
class const_postorder_iterator : public std::iterator<std::forward_iterator_tag, ex, ptrdiff_t, const ex *, const ex &> {
public:
- const_postorder_iterator() throw() {}
+ const_postorder_iterator() noexcept {}
const_postorder_iterator(const ex &e, size_t n)
{
return tmp;
}
- bool operator==(const const_postorder_iterator &other) const throw()
+ bool operator==(const const_postorder_iterator &other) const noexcept
{
return s == other.s;
}
- bool operator!=(const const_postorder_iterator &other) const throw()
+ bool operator!=(const const_postorder_iterator &other) const noexcept
{
return !(*this == other);
}
private:
- std::stack<internal::_iter_rep, std::vector<internal::_iter_rep> > s;
+ std::stack<internal::_iter_rep, std::vector<internal::_iter_rep>> s;
void descend()
{
}
};
-inline const_iterator ex::begin() const throw()
+inline const_iterator ex::begin() const noexcept
{
return const_iterator(*this, 0);
}
-inline const_iterator ex::end() const throw()
+inline const_iterator ex::end() const noexcept
{
return const_iterator(*this, nops());
}
return const_preorder_iterator(*this, nops());
}
-inline const_preorder_iterator ex::preorder_end() const throw()
+inline const_preorder_iterator ex::preorder_end() const noexcept
{
return const_preorder_iterator();
}
return const_postorder_iterator(*this, nops());
}
-inline const_postorder_iterator ex::postorder_end() const throw()
+inline const_postorder_iterator ex::postorder_end() const noexcept
{
return const_postorder_iterator();
}
}
/* Function objects for STL sort() etc. */
-struct ex_is_less : public std::binary_function<ex, ex, bool> {
+struct ex_is_less {
bool operator() (const ex &lh, const ex &rh) const { return lh.compare(rh) < 0; }
};
-struct ex_is_equal : public std::binary_function<ex, ex, bool> {
+struct ex_is_equal {
bool operator() (const ex &lh, const ex &rh) const { return lh.is_equal(rh); }
};
-struct op0_is_equal : public std::binary_function<ex, ex, bool> {
+struct op0_is_equal {
bool operator() (const ex &lh, const ex &rh) const { return lh.op(0).is_equal(rh.op(0)); }
};
-struct ex_swap : public std::binary_function<ex, ex, void> {
+struct ex_swap {
void operator() (ex &lh, ex &rh) const { lh.swap(rh); }
};
+// Make it possible to print exvectors and exmaps
+std::ostream & operator<<(std::ostream & os, const exvector & e);
+std::ostream & operator<<(std::ostream & os, const exset & e);
+std::ostream & operator<<(std::ostream & os, const exmap & e);
+
// wrapper functions around member functions
inline size_t nops(const ex & thisex)
{ return thisex.nops(); }
inline bool has(const ex & thisex, const ex & pattern, unsigned options = 0)
{ return thisex.has(pattern, options); }
-inline bool find(const ex & thisex, const ex & pattern, lst & found)
+inline bool find(const ex & thisex, const ex & pattern, exset& found)
{ return thisex.find(pattern, found); }
inline bool is_polynomial(const ex & thisex, const ex & vars)
inline ex numer_denom(const ex & thisex)
{ return thisex.numer_denom(); }
-inline ex normal(const ex & thisex, int level=0)
-{ return thisex.normal(level); }
-
-inline ex to_rational(const ex & thisex, lst & repl_lst)
-{ return thisex.to_rational(repl_lst); }
+inline ex normal(const ex & thisex)
+{ return thisex.normal(); }
inline ex to_rational(const ex & thisex, exmap & repl)
{ return thisex.to_rational(repl); }
inline ex to_polynomial(const ex & thisex, exmap & repl)
{ return thisex.to_polynomial(repl); }
-inline ex to_polynomial(const ex & thisex, lst & repl_lst)
-{ return thisex.to_polynomial(repl_lst); }
-
inline ex collect(const ex & thisex, const ex & s, bool distributed = false)
{ return thisex.collect(s, distributed); }
-inline ex eval(const ex & thisex, int level = 0)
-{ return thisex.eval(level); }
+inline ex eval(const ex & thisex)
+{ return thisex.eval(); }
-inline ex evalf(const ex & thisex, int level = 0)
-{ return thisex.evalf(level); }
+inline ex evalf(const ex & thisex)
+{ return thisex.evalf(); }
inline ex evalm(const ex & thisex)
{ return thisex.evalm(); }
inline ex series(const ex & thisex, const ex & r, int order, unsigned options = 0)
{ return thisex.series(r, order, options); }
-inline bool match(const ex & thisex, const ex & pattern, lst & repl_lst)
+inline bool match(const ex & thisex, const ex & pattern, exmap& repl_lst)
{ return thisex.match(pattern, repl_lst); }
inline ex simplify_indexed(const ex & thisex, unsigned options = 0)
ex (*ptr)(const ex &);
public:
explicit pointer_to_map_function(ex x(const ex &)) : ptr(x) {}
- ex operator()(const ex & e) { return ptr(e); }
+ ex operator()(const ex & e) override { return ptr(e); }
};
template<class T1>
T1 arg1;
public:
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); }
+ ex operator()(const ex & e) override { return ptr(e, arg1); }
};
template<class T1, class T2>
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) {}
- ex operator()(const ex & e) { return ptr(e, arg1, arg2); }
+ ex operator()(const ex & e) override { return ptr(e, arg1, arg2); }
};
template<class T1, class T2, class T3>
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) {}
- ex operator()(const ex & e) { return ptr(e, arg1, arg2, arg3); }
+ ex operator()(const ex & e) override { return ptr(e, arg1, arg2, arg3); }
+};
+
+template<class C>
+class pointer_to_member_to_map_function : public map_function {
+protected:
+ ex (C::*ptr)(const ex &);
+ C &c;
+public:
+ explicit pointer_to_member_to_map_function(ex (C::*member)(const ex &), C &obj) : ptr(member), c(obj) {}
+ ex operator()(const ex & e) override { return (c.*ptr)(e); }
+};
+
+template<class C, class T1>
+class pointer_to_member_to_map_function_1arg : public map_function {
+protected:
+ ex (C::*ptr)(const ex &, T1);
+ C &c;
+ T1 arg1;
+public:
+ explicit pointer_to_member_to_map_function_1arg(ex (C::*member)(const ex &, T1), C &obj, T1 a1) : ptr(member), c(obj), arg1(a1) {}
+ ex operator()(const ex & e) override { return (c.*ptr)(e, arg1); }
+};
+
+template<class C, class T1, class T2>
+class pointer_to_member_to_map_function_2args : public map_function {
+protected:
+ ex (C::*ptr)(const ex &, T1, T2);
+ C &c;
+ T1 arg1;
+ T2 arg2;
+public:
+ explicit pointer_to_member_to_map_function_2args(ex (C::*member)(const ex&, T1, T2), C &obj, T1 a1, T2 a2) : ptr(member), c(obj), arg1(a1), arg2(a2) {}
+ ex operator()(const ex & e) override { return (c.*ptr)(e, arg1, arg2); }
+};
+
+template<class C, class T1, class T2, class T3>
+class pointer_to_member_to_map_function_3args : public map_function {
+protected:
+ ex (C::*ptr)(const ex &, T1, T2, T3);
+ C &c;
+ T1 arg1;
+ T2 arg2;
+ T3 arg3;
+public:
+ explicit pointer_to_member_to_map_function_3args(ex (C::*member)(const ex &, T1, T2, T3), C &obj, T1 a1, T2 a2, T3 a3) : ptr(member), c(obj), arg1(a1), arg2(a2), arg3(a3) {}
+ ex operator()(const ex & e) override { return (c.*ptr)(e, arg1, arg2, arg3); }
};
inline ex ex::map(ex f(const ex &)) const
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__
+#endif // ndef GINAC_EX_H