SymEngine::MultiArgFunction Class Reference

Inheritance diagram for SymEngine::MultiArgFunction:

Collaboration diagram for SymEngine::MultiArgFunction:

Public Member Functions
	MultiArgFunction (const vec_basic &arg)
	Constructor.
hash_t	__hash__ () const override
vec_basic	get_args () const override
	Returns the list of arguments.
const vec_basic &	get_vec () const
virtual RCP< const Basic >	create (const vec_basic &v) const =0
	Method to construct classes with canonicalization.
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

Private Attributes
vec_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 143 of file functions.h.

Constructor & Destructor Documentation

MultiArgFunction()

SymEngine::MultiArgFunction::MultiArgFunction ( const vec_basic &  arg )

inline

Constructor.

Definition at line 150 of file functions.h.

: arg_{arg} {};

Member Function Documentation

__eq__()

bool SymEngine::MultiArgFunction::__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.

Reimplemented in SymEngine::FunctionSymbol.

Definition at line 173 of file functions.h.

    {
        return is_same_type(*this, o)
               and unified_eq(get_vec(),
                              down_cast<const MultiArgFunction &>(o).get_vec());
    }

__hash__()

hash_t SymEngine::MultiArgFunction::__hash__ ( ) const

inlineoverridevirtual

Returns

the hash

Implements SymEngine::Basic.

Reimplemented in SymEngine::FunctionSymbol.

Definition at line 152 of file functions.h.

    {
        hash_t seed = this->get_type_code();
        for (const auto &a : arg_)
            hash_combine<Basic>(seed, *a);
        return seed;
    }

compare()

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

inlineoverridevirtual

Structural equality comparator.

Implements SymEngine::Basic.

Reimplemented in SymEngine::FunctionSymbol.

Definition at line 180 of file functions.h.

    {
        SYMENGINE_ASSERT(is_same_type(*this, o))
        return unified_compare(
            get_vec(), down_cast<const MultiArgFunction &>(o).get_vec());
    }

create()

virtual RCP< const Basic > SymEngine::MultiArgFunction::create ( const vec_basic &  v ) const

pure virtual

Method to construct classes with canonicalization.

Implemented in SymEngine::LeviCivita, SymEngine::Max, SymEngine::Min, SymEngine::FunctionWrapper, and SymEngine::FunctionSymbol.

get_args()

vec_basic SymEngine::MultiArgFunction::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 159 of file functions.h.

    {
        return arg_;
    }

get_vec()

const vec_basic & SymEngine::MultiArgFunction::get_vec ( ) const

inline

Definition at line 163 of file functions.h.

    {
        return arg_;
    }

Field Documentation

arg_

vec_basic SymEngine::MultiArgFunction::arg_

private

Definition at line 146 of file functions.h.

---

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

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