SymEngine::OneArgFunction Class Reference

Inheritance diagram for SymEngine::OneArgFunction:

Collaboration diagram for SymEngine::OneArgFunction:

Public Member Functions
	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.
hash_t	hash () const
bool	__neq__ (const Basic &o) const
	true if this is not equal to o.
int	__cmp__ (const Basic &o) const
	Comparison operator.
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 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

Private Attributes
RCP< const Basic >	arg_

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

Constructor & Destructor Documentation

OneArgFunction()

SymEngine::OneArgFunction::OneArgFunction ( const RCP< const Basic > &  arg )

inline

The arg in OneArgFunction(arg)

Constructor

Definition at line 27 of file functions.h.

: arg_{arg} {};

Member Function Documentation

__eq__()

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

inlineoverridevirtual

Equality comparator

Parameters

o	- Object to be compared with

Returns

whether the 2 objects are equal

Implements SymEngine::Basic.

Definition at line 57 of file functions.h.

    {
        return is_same_type(*this, o)
               and eq(*get_arg(),
                      *down_cast<const OneArgFunction &>(o).get_arg());
    }

__hash__()

hash_t SymEngine::OneArgFunction::__hash__ ( ) const

inlineoverridevirtual

Returns

the hash

Implements SymEngine::Basic.

Definition at line 29 of file functions.h.

    {
        hash_t seed = this->get_type_code();
        hash_combine<Basic>(seed, *arg_);
        return seed;
    }

compare()

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

inlineoverridevirtual

Structural equality comparator.

Implements SymEngine::Basic.

Definition at line 64 of file functions.h.

    {
        SYMENGINE_ASSERT(is_same_type(*this, o))
        return get_arg()->__cmp__(
            *(down_cast<const OneArgFunction &>(o).get_arg()));
    }

create() [1/2]

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

pure virtual

Method to construct classes with canonicalization.

Implemented in SymEngine::Sign, SymEngine::Floor, SymEngine::Ceiling, SymEngine::Truncate, SymEngine::Conjugate, SymEngine::Sin, SymEngine::Cos, SymEngine::Tan, SymEngine::Cot, SymEngine::Csc, SymEngine::Sec, SymEngine::ASin, SymEngine::ACos, SymEngine::ASec, SymEngine::ACsc, SymEngine::ATan, SymEngine::ACot, SymEngine::Log, SymEngine::LambertW, SymEngine::Dirichlet_eta, SymEngine::Sinh, SymEngine::Csch, SymEngine::Cosh, SymEngine::Sech, SymEngine::Tanh, SymEngine::Coth, SymEngine::ASinh, SymEngine::ACsch, SymEngine::ACosh, SymEngine::ATanh, SymEngine::ACoth, SymEngine::ASech, SymEngine::Erf, SymEngine::Erfc, SymEngine::Gamma, SymEngine::LogGamma, SymEngine::Abs, SymEngine::UnevaluatedExpr, SymEngine::PrimePi, SymEngine::Primorial, and SymEngine::Dirichlet_eta.

create() [2/2]

RCP< const Basic > SymEngine::OneArgFunction::create ( const vec_basic &  b ) const

inline

Definition at line 47 of file functions.h.

    {
        SYMENGINE_ASSERT(b.size() == 1);
        return create(b[0]);
    }

get_arg()

RCP< const Basic > SymEngine::OneArgFunction::get_arg ( ) const

inline

Returns

arg_

Definition at line 36 of file functions.h.

    {
        return arg_;
    }

get_args()

vec_basic SymEngine::OneArgFunction::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 40 of file functions.h.

    {
        return {arg_};
    }

Field Documentation

arg_

RCP<const Basic> SymEngine::OneArgFunction::arg_

private

Definition at line 24 of file functions.h.

---

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

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