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::stringget_name () const
bool is_canonical (const vec_basic &arg) const
RCP< const Basiccreate (const vec_basic &x) const override
 Method to construct classes with canonicalization.
- Public Member Functions inherited from SymEngine::MultiArgFunction
 MultiArgFunction (const vec_basic &arg)
vec_basic get_args () const override
 Returns the list of arguments.
const vec_basicget_vec () const
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 Basic ()
 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
std::string dumps () const
 Returns a string of the instance serialized.
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_FUNCTIONSYMBOL
 The f in f(x+y, z) More...

Protected Attributes

std::string name_

Additional Inherited Members

- Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basicloads (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.

Member Function Documentation

◆ __eq__()

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

Equality comparator

oObject to be compared with
whether the 2 objects are equal

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1885 of file functions.cpp.

1886 {
1887  if (is_a<FunctionSymbol>(o)
1888  and name_ == down_cast<const FunctionSymbol &>(o).name_
1889  and unified_eq(get_vec(),
1890  down_cast<const FunctionSymbol &>(o).get_vec()))
1891  return true;
1892  return false;
1893 }

◆ __hash__()

hash_t SymEngine::FunctionSymbol::__hash__ ( ) const
Size of the hash

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1876 of file functions.cpp.

1877 {
1879  for (const auto &a : get_vec())
1880  hash_combine<Basic>(seed, *a);
1881  hash_combine<std::string>(seed, name_);
1882  return seed;
1883 }

◆ get_name()

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

Definition at line 654 of file functions.h.

655  {
656  return name_;
657  }

◆ is_canonical()

bool SymEngine::FunctionSymbol::is_canonical ( const vec_basic arg) const
true if canonical

Definition at line 1871 of file functions.cpp.

1872 {
1873  return true;
1874 }

Field Documentation

◆ type_code_id

const TypeID SymEngine::FunctionSymbol::type_code_id = SYMENGINE_FUNCTIONSYMBOL

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: