Inheritance diagram for SymEngine::Symbol:

Collaboration diagram for SymEngine::Symbol:

Public Member Functions
void	accept (Visitor &v) const override

void	accept (EvalRealDoubleVisitorFinal &v) const override

	Symbol (const std::string &name)
	Symbol Constructor.

hash_t	__hash__ () const override

bool	__eq__ (const Basic &o) const override

int	compare (const Basic &o) const override

const std::string &	get_name () const

vec_basic	get_args () const override
	Returns the list of arguments.

RCP< const Symbol >	as_dummy () const

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`. More...

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

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_SYMBOL

Private Attributes
std::string	name_
	name of Symbol

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 14 of file symbol.h.

Member Function Documentation

◆ eq()

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

Reimplemented in SymEngine::Dummy.

Definition at line 17 of file symbol.cpp.

 {
     if (is_a<Symbol>(o))
         return name_ == down_cast<const Symbol &>(o).name_;
     return false;
 }

◆ hash()

hash_t SymEngine::Symbol::__hash__ ( ) const

overridevirtual

Returns: Size of the hash

Implements SymEngine::Basic.

Reimplemented in SymEngine::Dummy.

Definition at line 10 of file symbol.cpp.

 {
     hash_t seed = 0;
     hash_combine(seed, name_);
     return seed;
 }

◆ compare()

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

overridevirtual

Comparison operator

Parameters

o	- Object to be compared with

Returns: 0 if equal, -1 , 1 according to string compare

Implements SymEngine::Basic.

Reimplemented in SymEngine::Dummy.

Definition at line 24 of file symbol.cpp.

 {
     SYMENGINE_ASSERT(is_a<Symbol>(o))
     const Symbol &s = down_cast<const Symbol &>(o);
     if (name_ == s.name_)
         return 0;
     return name_ < s.name_ ? -1 : 1;
 }

◆ get_name()

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

inline

Returns: name of the Symbol.

Definition at line 38 of file symbol.h.

     {
         return name_;
     }

Field Documentation

◆ type_code_id

const TypeID SymEngine::Symbol::type_code_id = SYMENGINE_SYMBOL

static

Type_code_id shared by all instances

Definition at line 21 of file symbol.h.

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

/home/runner/work/symengine/symengine/symengine/symbol.h
/home/runner/work/symengine/symengine/symengine/symbol.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ compare()

◆ get_name()

Field Documentation

◆ type_code_id

◆ eq()

◆ hash()