SymEngine::Conjugate Class Reference

Inheritance diagram for SymEngine::Conjugate:

Collaboration diagram for SymEngine::Conjugate:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Conjugate (const RCP< const Basic > &arg)
	Conjugate constructor.
bool	is_canonical (const RCP< const Basic > &arg) const
RCP< const Basic >	create (const RCP< const Basic > &arg) const override
Public Member Functions inherited from SymEngine::OneArgFunction
	OneArgFunction (const RCP< const Basic > &arg)
	The arg in OneArgFunction(arg)
hash_t	__hash__ () const override
RCP< const Basic >	get_arg () const
vec_basic	get_args () const override
	Returns the list of arguments.
virtual RCP< const Basic >	create (const RCP< const Basic > &arg) const =0
	Method to construct classes with canonicalization.
RCP< const Basic >	create (const vec_basic &b) const
bool	__eq__ (const Basic &o) const override
int	compare (const Basic &o) const override
	Structural equality comparator.
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_CONJUGATE

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 248 of file functions.h.

Constructor & Destructor Documentation

Conjugate()

SymEngine::Conjugate::Conjugate

(

const RCP< const Basic > &

arg

)

Conjugate constructor.

Definition at line 92 of file functions.cpp.

                                                : OneArgFunction(arg)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(arg))
}

Member Function Documentation

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

create()

RCP< const Basic > SymEngine::Conjugate::create ( const RCP< const Basic > &  arg ) const

overridevirtual

Returns

Canonicalized conjugate

Implements SymEngine::OneArgFunction.

Definition at line 144 of file functions.cpp.

{
    return conjugate(arg);
}

is_canonical()

bool SymEngine::Conjugate::is_canonical

(

const RCP< const Basic > &

arg

)

const

Returns

true if canonical

Definition at line 98 of file functions.cpp.

{
    if (is_a_Number(*arg)) {
        if (eq(*arg, *ComplexInf)) {
            return true;
        }
        return false;
    }
    if (is_a<Constant>(*arg)) {
        return false;
    }
    if (is_a<Mul>(*arg)) {
        return false;
    }
    if (is_a<Pow>(*arg)) {
        if (is_a<Integer>(*down_cast<const Pow &>(*arg).get_exp())) {
            return false;
        }
    }
    // OneArgFunction classes
    if (is_a<Sign>(*arg) or is_a<Conjugate>(*arg) or is_a<Erf>(*arg)
        or is_a<Erfc>(*arg) or is_a<Gamma>(*arg) or is_a<LogGamma>(*arg)
        or is_a<Abs>(*arg)) {
        return false;
    }
    if (is_a<Sin>(*arg) or is_a<Cos>(*arg) or is_a<Tan>(*arg) or is_a<Cot>(*arg)
        or is_a<Sec>(*arg) or is_a<Csc>(*arg)) {
        return false;
    }
    if (is_a<Sinh>(*arg) or is_a<Cosh>(*arg) or is_a<Tanh>(*arg)
        or is_a<Coth>(*arg) or is_a<Sech>(*arg) or is_a<Csch>(*arg)) {
        return false;
    }
    // TwoArgFunction classes
    if (is_a<KroneckerDelta>(*arg) or is_a<ATan2>(*arg)
        or is_a<LowerGamma>(*arg) or is_a<UpperGamma>(*arg)
        or is_a<Beta>(*arg)) {
        return false;
    }
    // MultiArgFunction class
    if (is_a<LeviCivita>(*arg)) {
        return false;
    }
    return true;
}

Field Documentation

type_code_id

const TypeID SymEngine::Conjugate::type_code_id = SYMENGINE_CONJUGATE

static

Type_code_id shared by all instances

Definition at line 251 of file functions.h.

---

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

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