SymEngine::Pow Class Reference

Inheritance diagram for SymEngine::Pow:

Collaboration diagram for SymEngine::Pow:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Pow (const RCP< const Basic > &base, const RCP< const Basic > &exp)
	Pow Constructor.
hash_t	__hash__ () const override
bool	__eq__ (const Basic &o) const override
int	compare (const Basic &o) const override
bool	is_canonical (const Basic &base, const Basic &exp) const
RCP< const Basic >	get_base () const
RCP< const Basic >	get_exp () const
vec_basic	get_args () const override
	Returns the list of arguments.
Public Member Functions inherited from SymEngine::Basic
TypeID	get_type_code () const
	Basic ()
	Constructor.
	Basic (const Basic &)=delete
	Delete the copy constructor and assignment.
Basic &	operator= (const Basic &)=delete
	Assignment operator in continuation with above.
	Basic (Basic &&)=delete
	Delete the move constructor and assignment.
Basic &	operator= (Basic &&)=delete
	Assignment operator in continuation with above.
virtual hash_t	__hash__ () const =0
hash_t	hash () const
virtual bool	__eq__ (const Basic &o) const =0
	Test equality.
bool	__neq__ (const Basic &o) const
	true if this is not equal to o.
int	__cmp__ (const Basic &o) const
	Comparison operator.
virtual int	compare (const Basic &o) const =0
std::string	__str__ () const
std::string	dumps () const
	Returns a string of the instance serialized.
RCP< const Basic >	subs (const map_basic_basic &subs_dict) const
	Substitutes 'subs_dict' into 'self'.
RCP< const Basic >	xreplace (const map_basic_basic &subs_dict) const
virtual RCP< const Basic >	expand_as_exp () const
	expands the special function in terms of exp function
virtual vec_basic	get_args () const =0
	Returns the list of arguments.
virtual void	accept (Visitor &v) const =0
virtual void	accept (EvalRealDoubleVisitorFinal &v) const =0
RCP< const Basic >	diff (const RCP< const Symbol > &x, bool cache=true) const
Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basic >	rcp_from_this ()
	Get RCP<T> pointer to self (it will cast the pointer to T)
RCP< const Basic >	rcp_from_this () const
	Get RCP<const T> pointer to self (it will cast the pointer to const T)
RCP< const T2 >	rcp_from_this_cast () const
	Get RCP<T2> pointer to self (it will cast the pointer to T2)
unsigned int	use_count () const

Static Public Attributes
static const TypeID	type_code_id = SYMENGINE_POW
	base**exp

Private Attributes
RCP< const Basic >	base_
RCP< const Basic >	exp_

Additional Inherited Members
Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basic >	loads (const std::string &)
	Creates an instance of a serialized string.
Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

Definition at line 17 of file pow.h.

Constructor & Destructor Documentation

Pow()

SymEngine::Pow::Pow	(	const RCP< const Basic > &	base,
		const RCP< const Basic > &	exp
	)

Pow Constructor.

Definition at line 10 of file pow.cpp.

    : base_{base}, exp_{exp}
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(*base, *exp))
}

Member Function Documentation

__eq__()

bool SymEngine::Pow::__eq__ ( const Basic &  o ) const

overridevirtual

Equality comparator

Parameters

o	- Object to be compared with

Returns

whether the 2 objects are equal

Implements SymEngine::Basic.

Definition at line 72 of file pow.cpp.

{
    if (is_a<Pow>(o) and eq(*base_, *(down_cast<const Pow &>(o).base_))
        and eq(*exp_, *(down_cast<const Pow &>(o).exp_)))
        return true;
 
    return false;
}

__hash__()

hash_t SymEngine::Pow::__hash__ ( ) const

overridevirtual

Returns

Size of the hash

Implements SymEngine::Basic.

Definition at line 64 of file pow.cpp.

{
    hash_t seed = SYMENGINE_POW;
    hash_combine<Basic>(seed, *base_);
    hash_combine<Basic>(seed, *exp_);
    return seed;
}

accept() [1/2]

void SymEngine::Pow::accept ( EvalRealDoubleVisitorFinal &  v ) const

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

void SymEngine::Pow::accept ( Visitor &  v ) const

overridevirtual

Implements SymEngine::Basic.

compare()

int SymEngine::Pow::compare ( const Basic &  o ) const

overridevirtual

Returns -1, 0, 1 for this < o, this == o, this > o. This method is used when you want to sort things like x+y+z into canonical order. This function assumes that o is the same type as this. Use __cmp__ if you want general comparison.

Implements SymEngine::Basic.

Definition at line 81 of file pow.cpp.

{
    SYMENGINE_ASSERT(is_a<Pow>(o))
    const Pow &s = down_cast<const Pow &>(o);
    int base_cmp = base_->__cmp__(*s.base_);
    if (base_cmp == 0)
        return exp_->__cmp__(*s.exp_);
    else
        return base_cmp;
}

get_args()

vec_basic SymEngine::Pow::get_args ( ) const

overridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 266 of file pow.cpp.

{
    return {base_, exp_};
}

get_base()

RCP< const Basic > SymEngine::Pow::get_base ( ) const

inline

Returns

base of base**exp

Definition at line 37 of file pow.h.

    {
        return base_;
    }

get_exp()

RCP< const Basic > SymEngine::Pow::get_exp ( ) const

inline

Returns

exp of base**exp

Definition at line 42 of file pow.h.

    {
        return exp_;
    }

is_canonical()

bool SymEngine::Pow::is_canonical	(	const Basic &	base,
		const Basic &	exp
	)		const

Returns

true if canonical

Definition at line 17 of file pow.cpp.

{
    // e.g. 0**x
    if (is_a<Integer>(base) and down_cast<const Integer &>(base).is_zero()) {
        if (is_a_Number(exp)) {
            return false;
        } else {
            return true;
        }
    }
    // e.g. 1**x
    if (is_a<Integer>(base) and down_cast<const Integer &>(base).is_one())
        return false;
    // e.g. x**0.0
    if (is_number_and_zero(exp))
        return false;
    // e.g. x**1
    if (is_a<Integer>(exp) and down_cast<const Integer &>(exp).is_one())
        return false;
    // e.g. 2**3, (2/3)**4
    if ((is_a<Integer>(base) or is_a<Rational>(base)) and is_a<Integer>(exp))
        return false;
    // e.g. (x*y)**2, should rather be x**2*y**2
    if (is_a<Mul>(base) and is_a<Integer>(exp))
        return false;
    // e.g. (x**y)**2, should rather be x**(2*y)
    if (is_a<Pow>(base) and is_a<Integer>(exp))
        return false;
    // If exp is a rational, it should be between 0  and 1, i.e. we don't
    // allow things like 2**(-1/2) or 2**(3/2)
    if ((is_a<Rational>(base) or is_a<Integer>(base)) and is_a<Rational>(exp)
        and (down_cast<const Rational &>(exp).as_rational_class() < 0
             or down_cast<const Rational &>(exp).as_rational_class() > 1))
        return false;
    // Purely Imaginary complex numbers with integral powers are expanded
    // e.g (2I)**3
    if (is_a<Complex>(base) and down_cast<const Complex &>(base).is_re_zero()
        and is_a<Integer>(exp))
        return false;
    // e.g. 0.5^2.0 should be represented as 0.25
    if (is_a_Number(base) and is_a_Number(exp)
        and (not down_cast<const Number &>(base).is_exact()
             or not down_cast<const Number &>(exp).is_exact()))
        return false;
    return true;
}

Field Documentation

base_

RCP<const Basic> SymEngine::Pow::base_

private

Definition at line 20 of file pow.h.

exp_

RCP<const Basic> SymEngine::Pow::exp_

private

Definition at line 20 of file pow.h.

type_code_id

const TypeID SymEngine::Pow::type_code_id = SYMENGINE_POW

static

base**exp

Type_code_id shared by all instances

Definition at line 23 of file pow.h.

---

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

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