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

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Constant (const std::string &name)
 Constant Constructor.
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 
virtual int compare (const Basic &o) const
 
std::string get_name () const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
- 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_CONSTANT
 

Private Attributes

std::string name_
 name of Constant
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 18 of file constants.h.

Member Function Documentation

◆ __eq__()

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

Definition at line 20 of file constants.cpp.

21 {
22  if (is_a<Constant>(o))
23  return name_ == down_cast<const Constant &>(o).name_;
24  return false;
25 }
std::string name_
name of Constant
Definition: constants.h:22

◆ __hash__()

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

Implements SymEngine::Basic.

Definition at line 13 of file constants.cpp.

14 {
15  hash_t seed = SYMENGINE_CONSTANT;
16  hash_combine<std::string>(seed, name_);
17  return seed;
18 }

◆ compare()

int SymEngine::Constant::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.

Definition at line 27 of file constants.cpp.

28 {
29  SYMENGINE_ASSERT(is_a<Constant>(o))
30  const Constant &s = down_cast<const Constant &>(o);
31  if (name_ == s.name_)
32  return 0;
33  return name_ < s.name_ ? -1 : 1;
34 }
Constant(const std::string &name)
Constant Constructor.
Definition: constants.cpp:10

◆ get_name()

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

Definition at line 41 of file constants.h.

42  {
43  return name_;
44  }

Field Documentation

◆ type_code_id

const TypeID SymEngine::Constant::type_code_id = SYMENGINE_CONSTANT
static

Type_code_id shared by all instances

Definition at line 25 of file constants.h.


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