SymEngine::Symbol Class Reference
+ Inheritance diagram for SymEngine::Symbol:
+ Collaboration diagram for SymEngine::Symbol:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Symbol (const std::string &name)
 Symbol Constructor.
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 
virtual int compare (const Basic &o) const
 
const std::stringget_name () const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
RCP< const Symbolas_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.
 
Basicoperator= (const Basic &)=delete
 Assignment operator in continuation with above.
 
 Basic (Basic &&)=delete
 Delete the move constructor and assignment.
 
Basicoperator= (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
 
RCP< const Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'.
 
RCP< const Basicxreplace (const map_basic_basic &subs_dict) const
 
virtual RCP< const Basicexpand_as_exp () const
 expands the special function in terms of exp function
 
RCP< const Basicdiff (const RCP< const Symbol > &x, bool cache=true) const
 
- Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basicrcp_from_this ()
 Get RCP<T> pointer to self (it will cast the pointer to T)
 
RCP< const Basicrcp_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

- 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
virtual

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.

18 {
19  if (is_a<Symbol>(o))
20  return name_ == down_cast<const Symbol &>(o).name_;
21  return false;
22 }
std::string name_
name of Symbol
Definition: symbol.h:18

◆ __hash__()

hash_t SymEngine::Symbol::__hash__ ( ) const
virtual
Returns
Size of the hash

Implements SymEngine::Basic.

Reimplemented in SymEngine::Dummy.

Definition at line 10 of file symbol.cpp.

11 {
12  hash_t seed = 0;
13  hash_combine(seed, name_);
14  return seed;
15 }
void hash_combine(hash_t &seed, const T &v)
Definition: basic-inl.h:137

◆ compare()

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

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.

25 {
26  SYMENGINE_ASSERT(is_a<Symbol>(o))
27  const Symbol &s = down_cast<const Symbol &>(o);
28  if (name_ == s.name_)
29  return 0;
30  return name_ < s.name_ ? -1 : 1;
31 }
Symbol(const std::string &name)
Symbol Constructor.
Definition: symbol.cpp:7

◆ get_name()

const std::string& SymEngine::Symbol::get_name ( ) const
inline
Returns
name of the Symbol.

Definition at line 38 of file symbol.h.

39  {
40  return name_;
41  }

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: