Loading...
Searching...
No Matches
SymEngine::FunctionSymbol Class Reference
+ Inheritance diagram for SymEngine::FunctionSymbol:
+ Collaboration diagram for SymEngine::FunctionSymbol:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 FunctionSymbol (std::string name, const vec_basic &arg)
 FunctionSymbol Constructors. More...
 
 FunctionSymbol (std::string name, const RCP< const Basic > &arg)
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 
virtual int compare (const Basic &o) const
 Structural equality comparator. More...
 
const std::stringget_name () const
 
bool is_canonical (const vec_basic &arg) const
 
virtual RCP< const Basiccreate (const vec_basic &x) const
 Method to construct classes with canonicalization. More...
 
- Public Member Functions inherited from SymEngine::MultiArgFunction
 MultiArgFunction (const vec_basic &arg)
 Constructor. More...
 
hash_t __hash__ () const
 
virtual vec_basic get_args () const
 Returns the list of arguments. More...
 
const vec_basicget_vec () const
 
virtual RCP< const Basiccreate (const vec_basic &v) const =0
 Method to construct classes with canonicalization. More...
 
virtual bool __eq__ (const Basic &o) const
 
virtual int compare (const Basic &o) const
 Structural equality comparator. More...
 
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 
 Basic ()
 Constructor. More...
 
 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.
 
virtual hash_t __hash__ () const =0
 
hash_t hash () const
 
virtual bool __eq__ (const Basic &o) const =0
 Test equality. More...
 
bool __neq__ (const Basic &o) const
 true if this is not equal to o. More...
 
int __cmp__ (const Basic &o) const
 Comparison operator. More...
 
virtual int compare (const Basic &o) const =0
 
std::string __str__ () const
 
std::string dumps () const
 Returns a string of the instance serialized. More...
 
RCP< const Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'. More...
 
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 More...
 
virtual vec_basic get_args () const =0
 Returns the list of arguments. More...
 
virtual void accept (Visitor &v) const =0
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const =0
 
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) More...
 
RCP< const Basicrcp_from_this () const
 Get RCP<const T> pointer to self (it will cast the pointer to const T) More...
 
RCP< const T2 > rcp_from_this_cast () const
 Get RCP<T2> pointer to self (it will cast the pointer to T2) More...
 
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. More...
 
- 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.

1865 : MultiArgFunction(arg), name_{name}
1866{
1867 SYMENGINE_ASSIGN_TYPEID()
1868 SYMENGINE_ASSERT(is_canonical(get_vec()))
1869}
bool is_canonical(const vec_basic &arg) const
Definition: functions.cpp:1871
MultiArgFunction(const vec_basic &arg)
Constructor.
Definition: functions.h:150

◆ FunctionSymbol() [2/2]

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

Definition at line 1859 of file functions.cpp.

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

Member Function Documentation

◆ __eq__()

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

Equality comparator

Parameters
oObject to be compared with
Returns
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
virtual
Returns
Size of the hash

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1876 of file functions.cpp.

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

◆ accept() [1/2]

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

Implements SymEngine::Basic.

◆ accept() [2/2]

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

Implements SymEngine::Basic.

◆ compare()

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

Structural equality comparator.

Reimplemented from SymEngine::MultiArgFunction.

Definition at line 1895 of file functions.cpp.

1896{
1897 SYMENGINE_ASSERT(is_a<FunctionSymbol>(o))
1898 const FunctionSymbol &s = down_cast<const FunctionSymbol &>(o);
1899 if (name_ == s.name_)
1900 return unified_compare(get_vec(), s.get_vec());
1901 else
1902 return name_ < s.name_ ? -1 : 1;
1903}
FunctionSymbol(std::string name, const vec_basic &arg)
FunctionSymbol Constructors.
Definition: functions.cpp:1864
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

◆ create()

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

Method to construct classes with canonicalization.

Implements SymEngine::MultiArgFunction.

Reimplemented in SymEngine::FunctionWrapper.

Definition at line 1905 of file functions.cpp.

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

◆ get_name()

const std::string & SymEngine::FunctionSymbol::get_name ( ) const
inline
Returns
name_

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
Returns
true if canonical

Definition at line 1871 of file functions.cpp.

1872{
1873 return true;
1874}

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: