SymEngine::Derivative Class Reference

#include <functions.h>

+ Inheritance diagram for SymEngine::Derivative:
+ Collaboration diagram for SymEngine::Derivative:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Derivative (const RCP< const Basic > &arg, const multiset_basic &x)
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 Test equality. More...
 
virtual int compare (const Basic &o) const
 
RCP< const Basicget_arg () const
 
const multiset_basicget_symbols () const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
bool is_canonical (const RCP< const Basic > &arg, const multiset_basic &x) 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 Member Functions

static RCP< const Derivativecreate (const RCP< const Basic > &arg, const multiset_basic &x)
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_DERIVATIVE
 x, y, ... More...
 

Private Attributes

RCP< const Basicarg_
 
multiset_basic x_
 The expression to be differentiated.
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Derivative operator Derivative(f, [x, y, ...]) represents a derivative of f with respect to x, y, and so on.

Definition at line 686 of file functions.h.

Member Function Documentation

◆ __eq__()

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

Test equality.

A virtual function for testing the equality of two Basic objects

Deprecated:
Use eq(const Basic &a, const Basic &b) non-member method
Parameters
oa constant reference to object to test against
Returns
True if this is equal to o

Implements SymEngine::Basic.

Definition at line 1965 of file functions.cpp.

1966 {
1967  if (is_a<Derivative>(o)
1968  and eq(*arg_, *(down_cast<const Derivative &>(o).arg_))
1969  and unified_eq(x_, down_cast<const Derivative &>(o).x_))
1970  return true;
1971  return false;
1972 }
multiset_basic x_
The expression to be differentiated.
Definition: functions.h:701
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21

◆ __hash__()

hash_t SymEngine::Derivative::__hash__ ( ) const
virtual

Calculates the hash of the given SymEngine class. Use Basic.hash() which gives a cached version of the hash.

Returns
64-bit integer value for the hash

Implements SymEngine::Basic.

Definition at line 1955 of file functions.cpp.

1956 {
1957  hash_t seed = SYMENGINE_DERIVATIVE;
1958  hash_combine<Basic>(seed, *arg_);
1959  for (auto &p : x_) {
1960  hash_combine<Basic>(seed, *p);
1961  }
1962  return seed;
1963 }

◆ compare()

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

Returns -1, 0, 1 for this < o, this == o, this > o. This method is used when you want to sort things like x+y+z into canonical order. This function assumes that o is the same type as this. Use __cmp__ if you want general comparison.

Implements SymEngine::Basic.

Definition at line 1974 of file functions.cpp.

1975 {
1976  SYMENGINE_ASSERT(is_a<Derivative>(o))
1977  const Derivative &s = down_cast<const Derivative &>(o);
1978  int cmp = arg_->__cmp__(*(s.arg_));
1979  if (cmp != 0)
1980  return cmp;
1981  cmp = unified_compare(x_, s.x_);
1982  return cmp;
1983 }
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

Field Documentation

◆ type_code_id

const TypeID SymEngine::Derivative::type_code_id = SYMENGINE_DERIVATIVE
static

x, y, ...

Type_code_id shared by all instances

Definition at line 704 of file functions.h.


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