SymEngine::FunctionSymbol Class Reference

Inheritance diagram for SymEngine::FunctionSymbol:

Collaboration diagram for SymEngine::FunctionSymbol:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	FunctionSymbol (std::string name, const vec_basic &arg)
	FunctionSymbol Constructors.
	FunctionSymbol (std::string name, const RCP< const Basic > &arg)
hash_t	__hash__ () const override
bool	__eq__ (const Basic &o) const override
int	compare (const Basic &o) const override
	Structural equality comparator.
const std::string &	get_name () const
bool	is_canonical (const vec_basic &arg) const
RCP< const Basic >	create (const vec_basic &x) const override
	Method to construct classes with canonicalization.
Public Member Functions inherited from SymEngine::MultiArgFunction
	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

Static Public Attributes
static const TypeID	type_code_id = SYMENGINE_FUNCTIONSYMBOL
	The f in f(x+y, z)

Protected Attributes
std::string	name_

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

Constructor & Destructor Documentation

FunctionSymbol() [1/2]

SymEngine::FunctionSymbol::FunctionSymbol	(	std::string	name,
		const vec_basic &	arg
	)

FunctionSymbol Constructors.

Definition at line 1864 of file functions.cpp.

    : MultiArgFunction(arg), name_{name}
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(get_vec()))
}

FunctionSymbol() [2/2]

SymEngine::FunctionSymbol::FunctionSymbol	(	std::string	name,
		const RCP< const Basic > &	arg
	)

Definition at line 1859 of file functions.cpp.

    : MultiArgFunction({arg}), name_{name} {SYMENGINE_ASSIGN_TYPEID()
                                                SYMENGINE_ASSERT(
                                                    is_canonical(get_vec()))}

Member Function Documentation

__eq__()

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

overridevirtual

Equality comparator

Parameters

o	Object to be compared with

Returns

whether the 2 objects are equal

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1885 of file functions.cpp.

{
    if (is_a<FunctionSymbol>(o)
        and name_ == down_cast<const FunctionSymbol &>(o).name_
        and unified_eq(get_vec(),
                       down_cast<const FunctionSymbol &>(o).get_vec()))
        return true;
    return false;
}

__hash__()

hash_t SymEngine::FunctionSymbol::__hash__ ( ) const

overridevirtual

Returns

Size of the hash

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1876 of file functions.cpp.

{
    hash_t seed = SYMENGINE_FUNCTIONSYMBOL;
    for (const auto &a : get_vec())
        hash_combine<Basic>(seed, *a);
    hash_combine<std::string>(seed, name_);
    return seed;
}

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

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

overridevirtual

Structural equality comparator.

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1895 of file functions.cpp.

{
    SYMENGINE_ASSERT(is_a<FunctionSymbol>(o))
    const FunctionSymbol &s = down_cast<const FunctionSymbol &>(o);
    if (name_ == s.name_)
        return unified_compare(get_vec(), s.get_vec());
    else
        return name_ < s.name_ ? -1 : 1;
}

create()

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

overridevirtual

Method to construct classes with canonicalization.

Implements SymEngine::MultiArgFunction.

Reimplemented in SymEngine::FunctionWrapper.

Definition at line 1905 of file functions.cpp.

{
    return make_rcp<const FunctionSymbol>(name_, x);
}

get_name()

const std::string & SymEngine::FunctionSymbol::get_name ( ) const

inline

Returns

name_

Definition at line 654 of file functions.h.

    {
        return name_;
    }

is_canonical()

bool SymEngine::FunctionSymbol::is_canonical

(

const vec_basic &

arg

)

const

Returns

true if canonical

Definition at line 1871 of file functions.cpp.

{
    return true;
}

Field Documentation

name_

std::string SymEngine::FunctionSymbol::name_

protected

Definition at line 638 of file functions.h.

type_code_id

const TypeID SymEngine::FunctionSymbol::type_code_id = SYMENGINE_FUNCTIONSYMBOL

static

The f in f(x+y, z)

Type_code_id shared by all instances

Definition at line 641 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