SymEngine::Expression Class Reference

Collaboration diagram for SymEngine::Expression:

Public Member Functions
	Expression ()
	Plain constructor of Expression.
template<class T >
	Expression (T n, typename std::enable_if< std::is_integral< T >::value >::type *=nullptr)
	Construct Expression from integral types.
template<class T >
	Expression (T n, typename std::enable_if< std::is_floating_point< T >::value >::type *=nullptr)
	Construct Expression from floating point types.
template<class T >
	Expression (std::complex< T > n, typename std::enable_if< std::is_floating_point< T >::value >::type *=nullptr)
	Construct Expression from std::complex<> types.
	Expression (const integer_class &n)
	Expression (const rational_class &n)
	Expression (RCP< const Basic > &&o)
	Expression (const RCP< const Basic > &o)
	Expression (const std::string &s)
	Expression (const Expression &)=default
	Construct Expression from Expression.
	Expression (Expression &&other) SYMENGINE_NOEXCEPT
	Construct Expression from reference to Expression.
Expression &	operator= (const Expression &)=default
	Overload assignment operator.
Expression &	operator= (Expression &&other) SYMENGINE_NOEXCEPT
	Overload assignment operator for reference.
virtual	~Expression () SYMENGINE_NOEXCEPT
	Destructor of Expression.
Expression &	operator+= (const Expression &other)
	Overload addition and assignment(+=)
Expression &	operator+= (const RCP< const Basic > &other)
	operator const RCP< const Basic > & () const
Expression	diff (const RCP< const Symbol > &x, bool cache=true) const
	Differentiation.
Expression	diff (const RCP< const Basic > &x, bool cache=true) const
	Differentiation.
Expression	subs (const map_basic_basic &subs_map) const
	Substitution.
template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>
	operator T () const
	Evaluation to a floating point type.
template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>
	operator std::complex< T > () const
	Evaluation to a complex floating point type.
	operator const Basic & () const
Expression	operator- () const
	Overload unary negative.
Expression &	operator-= (const Expression &other)
	Overload subtraction and assignment(-=)
Expression &	operator-= (const RCP< const Basic > &other)
Expression &	operator*= (const Expression &other)
	Overload multiplication and assignment (*=)
Expression &	operator*= (const RCP< const Basic > &other)
Expression &	operator/= (const Expression &other)
	Overload Division and assignment (/=)
Expression &	operator/= (const RCP< const Basic > &other)
bool	operator== (const Expression &other) const
	Overload check equality (==)
bool	operator== (const RCP< const Basic > &other) const
bool	operator!= (const Expression &other) const
	Overload check not equal (!=)
bool	operator!= (const RCP< const Basic > &other) const
const RCP< const Basic > &	get_basic () const
	Method to get Basic from Expression.

Private Attributes
RCP< const Basic >	m_basic

Friends
std::ostream &	operator<< (std::ostream &os, const Expression &expr)
	Overload stream operator.
Expression	operator+ (const Expression &a, const Expression &b)
	Overload addition.
Expression	operator+ (const RCP< const Basic > &a, const Expression &b)
Expression	operator+ (const Expression &a, const RCP< const Basic > &b)
Expression	operator- (const Expression &a, const Expression &b)
	Overload subtraction.
Expression	operator- (const RCP< const Basic > &a, const Expression &b)
Expression	operator- (const Expression &a, const RCP< const Basic > &b)
Expression	operator* (const Expression &a, const Expression &b)
	Overload multiplication.
Expression	operator* (const RCP< const Basic > &a, const Expression &b)
Expression	operator* (const Expression &a, const RCP< const Basic > &b)
Expression	operator/ (const Expression &a, const Expression &b)
	Overload Division.
Expression	operator/ (const RCP< const Basic > &a, const Expression &b)
Expression	operator/ (const Expression &a, const RCP< const Basic > &b)

Detailed Description

Definition at line 28 of file expression.h.

Constructor & Destructor Documentation

Expression() [1/10]

SymEngine::Expression::Expression ( )

inline

Plain constructor of Expression.

Definition at line 35 of file expression.h.

: m_basic(integer(0)) {}

Expression() [2/10]

template<class T >

SymEngine::Expression::Expression ( T  n, typename std::enable_if< std::is_integral< T >::value >::type *  = nullptr  )

inline

Construct Expression from integral types.

Definition at line 38 of file expression.h.

        : m_basic(integer(n))
    {
    }

Expression() [3/10]

template<class T >

SymEngine::Expression::Expression ( T  n, typename std::enable_if< std::is_floating_point< T >::value >::type *  = nullptr  )

inline

Construct Expression from floating point types.

Definition at line 46 of file expression.h.

        : m_basic(real_double(n))
    {
    }

Expression() [4/10]

template<class T >

SymEngine::Expression::Expression ( std::complex< T >  n, typename std::enable_if< std::is_floating_point< T >::value >::type *  = nullptr  )

inline

Construct Expression from std::complex<> types.

Definition at line 54 of file expression.h.

        : m_basic(complex_double(n))
    {
    }

Expression() [5/10]

SymEngine::Expression::Expression ( const integer_class &  n )

inline

Definition at line 61 of file expression.h.

: m_basic(integer(n)) {}

Expression() [6/10]

SymEngine::Expression::Expression ( const rational_class &  n )

inline

Definition at line 63 of file expression.h.

: m_basic(Rational::from_mpq(n)) {}

Expression() [7/10]

SymEngine::Expression::Expression ( RCP< const Basic > &&  o )

inline

Definition at line 65 of file expression.h.

: m_basic(o) {}

Expression() [8/10]

SymEngine::Expression::Expression ( const RCP< const Basic > &  o )

inline

Definition at line 67 of file expression.h.

: m_basic(o) {}

Expression() [9/10]

SymEngine::Expression::Expression

(

const std::string &

s

)

Definition at line 19 of file expression.cpp.

{
    m_basic = parse(s);
}

Expression() [10/10]

SymEngine::Expression::Expression ( Expression &&  other )

inline

Construct Expression from reference to Expression.

Definition at line 74 of file expression.h.

        : m_basic(std::move(other.m_basic))
    {
    }

~Expression()

virtual SymEngine::Expression::~Expression ( )

inlinevirtual

Destructor of Expression.

Definition at line 89 of file expression.h.

{}

Member Function Documentation

diff() [1/2]

Expression SymEngine::Expression::diff ( const RCP< const Basic > &  x, bool  cache = true  ) const

inline

Differentiation.

Definition at line 143 of file expression.h.

    {
        return Expression(sdiff(m_basic, x, cache));
    }

diff() [2/2]

Expression SymEngine::Expression::diff ( const RCP< const Symbol > &  x, bool  cache = true  ) const

inline

Differentiation.

Definition at line 138 of file expression.h.

    {
        return Expression(SymEngine::diff(m_basic, x, cache));
    }

get_basic()

const RCP< const Basic > & SymEngine::Expression::get_basic ( ) const

inline

Method to get Basic from Expression.

Definition at line 259 of file expression.h.

    {
        return m_basic;
    }

operator const Basic &()

SymEngine::Expression::operator const Basic & ( ) const

inline

Definition at line 168 of file expression.h.

    {
        return *m_basic;
    }

operator const RCP< const Basic > &()

SymEngine::Expression::operator const RCP< const Basic > & ( ) const

inline

Definition at line 133 of file expression.h.

    {
        return m_basic;
    }

operator std::complex< T >()

template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

SymEngine::Expression::operator std::complex< T > ( ) const

inlineexplicit

Evaluation to a complex floating point type.

Definition at line 164 of file expression.h.

    {
        return std::complex<T>(eval_complex_double(*get_basic()));
    }

operator T()

template<typename T , typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>

SymEngine::Expression::operator T ( ) const

inlineexplicit

Evaluation to a floating point type.

Definition at line 156 of file expression.h.

    {
        return T(eval_double(*get_basic()));
    }

operator!=() [1/2]

bool SymEngine::Expression::operator!= ( const Expression &  other ) const

inline

Overload check not equal (!=)

Definition at line 249 of file expression.h.

    {
        return not(*this == other);
    }

operator!=() [2/2]

bool SymEngine::Expression::operator!= ( const RCP< const Basic > &  other ) const

inline

Definition at line 253 of file expression.h.

    {
        return not(*this == other);
    }

operator*=() [1/2]

Expression & SymEngine::Expression::operator*= ( const Expression &  other )

inline

Overload multiplication and assignment (*=)

Definition at line 204 of file expression.h.

    {
        m_basic = mul(m_basic, other.m_basic);
        return *this;
    }

operator*=() [2/2]

Expression & SymEngine::Expression::operator*= ( const RCP< const Basic > &  other )

inline

Definition at line 209 of file expression.h.

    {
        m_basic = mul(m_basic, other);
        return *this;
    }

operator+=() [1/2]

Expression & SymEngine::Expression::operator+= ( const Expression &  other )

inline

Overload addition and assignment(+=)

Definition at line 110 of file expression.h.

    {
        m_basic = add(m_basic, other.m_basic);
        return *this;
    }

operator+=() [2/2]

Expression & SymEngine::Expression::operator+= ( const RCP< const Basic > &  other )

inline

Definition at line 115 of file expression.h.

    {
        m_basic = add(m_basic, other);
        return *this;
    }

operator-()

Expression SymEngine::Expression::operator- ( ) const

inline

Overload unary negative.

Definition at line 173 of file expression.h.

    {
        Expression retval(*this);
        retval *= -1;
        return retval;
    }

operator-=() [1/2]

Expression & SymEngine::Expression::operator-= ( const Expression &  other )

inline

Overload subtraction and assignment(-=)

Definition at line 180 of file expression.h.

    {
        m_basic = sub(m_basic, other.m_basic);
        return *this;
    }

operator-=() [2/2]

Expression & SymEngine::Expression::operator-= ( const RCP< const Basic > &  other )

inline

Definition at line 185 of file expression.h.

    {
        m_basic = sub(m_basic, other);
        return *this;
    }

operator/=() [1/2]

Expression & SymEngine::Expression::operator/= ( const Expression &  other )

inline

Overload Division and assignment (/=)

Definition at line 228 of file expression.h.

    {
        m_basic = div(m_basic, other.m_basic);
        return *this;
    }

operator/=() [2/2]

Expression & SymEngine::Expression::operator/= ( const RCP< const Basic > &  other )

inline

Definition at line 233 of file expression.h.

    {
        m_basic = div(m_basic, other);
        return *this;
    }

operator=()

Expression & SymEngine::Expression::operator= ( Expression &&  other )

inline

Overload assignment operator for reference.

Definition at line 81 of file expression.h.

    {
        if (this != &other) {
            this->m_basic = std::move(other.m_basic);
        }
        return *this;
    }

operator==() [1/2]

bool SymEngine::Expression::operator== ( const Expression &  other ) const

inline

Overload check equality (==)

Definition at line 239 of file expression.h.

    {
        return eq(*m_basic, *other.m_basic);
    }

operator==() [2/2]

bool SymEngine::Expression::operator== ( const RCP< const Basic > &  other ) const

inline

Definition at line 243 of file expression.h.

    {
        return eq(*m_basic, *other);
    }

subs()

Expression SymEngine::Expression::subs ( const map_basic_basic &  subs_map ) const

inline

Substitution.

Definition at line 148 of file expression.h.

    {
        return Expression(m_basic->subs(subs_map));
    }

Friends And Related Function Documentation

operator* [1/3]

Expression operator* ( const Expression &  a, const Expression &  b  )

friend

Overload multiplication.

Definition at line 191 of file expression.h.

    {
        return Expression(mul(a.m_basic, b.m_basic));
    }

operator* [2/3]

Expression operator* ( const Expression &  a, const RCP< const Basic > &  b  )

friend

Definition at line 199 of file expression.h.

    {
        return Expression(mul(a.m_basic, b));
    }

operator* [3/3]

Expression operator* ( const RCP< const Basic > &  a, const Expression &  b  )

friend

Definition at line 195 of file expression.h.

    {
        return Expression(mul(a, b.m_basic));
    }

operator+ [1/3]

Expression operator+ ( const Expression &  a, const Expression &  b  )

friend

Overload addition.

Definition at line 97 of file expression.h.

    {
        return Expression(add(a.m_basic, b.m_basic));
    }

operator+ [2/3]

Expression operator+ ( const Expression &  a, const RCP< const Basic > &  b  )

friend

Definition at line 105 of file expression.h.

    {
        return Expression(add(a.m_basic, b));
    }

operator+ [3/3]

Expression operator+ ( const RCP< const Basic > &  a, const Expression &  b  )

friend

Definition at line 101 of file expression.h.

    {
        return Expression(add(a, b.m_basic));
    }

operator- [1/3]

Expression operator- ( const Expression &  a, const Expression &  b  )

friend

Overload subtraction.

Definition at line 121 of file expression.h.

    {
        return Expression(sub(a.m_basic, b.m_basic));
    }

operator- [2/3]

Expression operator- ( const Expression &  a, const RCP< const Basic > &  b  )

friend

Definition at line 129 of file expression.h.

    {
        return Expression(sub(a.m_basic, b));
    }

operator- [3/3]

Expression operator- ( const RCP< const Basic > &  a, const Expression &  b  )

friend

Definition at line 125 of file expression.h.

    {
        return Expression(sub(a, b.m_basic));
    }

operator/ [1/3]

Expression operator/ ( const Expression &  a, const Expression &  b  )

friend

Overload Division.

Definition at line 215 of file expression.h.

    {
        return Expression(div(a.m_basic, b.m_basic));
    }

operator/ [2/3]

Expression operator/ ( const Expression &  a, const RCP< const Basic > &  b  )

friend

Definition at line 223 of file expression.h.

    {
        return Expression(div(a.m_basic, b));
    }

operator/ [3/3]

Expression operator/ ( const RCP< const Basic > &  a, const Expression &  b  )

friend

Definition at line 219 of file expression.h.

    {
        return Expression(div(a, b.m_basic));
    }

operator<<

std::ostream & operator<< ( std::ostream &  os, const Expression &  expr  )

friend

Overload stream operator.

Definition at line 91 of file expression.h.

    {
        os << expr.m_basic->__str__();
        return os;
    }

Field Documentation

m_basic

RCP<const Basic> SymEngine::Expression::m_basic

private

Definition at line 31 of file expression.h.

---

The documentation for this class was generated from the following files:

• /home/runner/work/symengine/symengine/symengine/expression.h
• /home/runner/work/symengine/symengine/symengine/expression.cpp