SymEngine::Subs Class Reference

#include <functions.h>

+ Inheritance diagram for SymEngine::Subs:
+ Collaboration diagram for SymEngine::Subs:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Subs (const RCP< const Basic > &arg, const map_basic_basic &x)
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 Test equality. More...
 
virtual int compare (const Basic &o) const
 
const RCP< const Basic > & get_arg () const
 
const map_basic_basicget_dict () const
 
virtual vec_basic get_variables () const
 
virtual vec_basic get_point () const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
bool is_canonical (const RCP< const Basic > &arg, const map_basic_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 Subscreate (const RCP< const Basic > &arg, const map_basic_basic &x)
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_SUBS
 

Private Attributes

RCP< const Basicarg_
 
map_basic_basic dict_
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Subs operator Subs(f, {x1 : x2, y1: y2, ...}) represents f after substituting x1 with x2, y1 with y2, and so on.

Definition at line 738 of file functions.h.

Member Function Documentation

◆ __eq__()

bool SymEngine::Subs::__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 2013 of file functions.cpp.

2014 {
2015  if (is_a<Subs>(o) and eq(*arg_, *(down_cast<const Subs &>(o).arg_))
2016  and unified_eq(dict_, down_cast<const Subs &>(o).dict_))
2017  return true;
2018  return false;
2019 }
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21

◆ __hash__()

hash_t SymEngine::Subs::__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 2002 of file functions.cpp.

2003 {
2004  hash_t seed = SYMENGINE_SUBS;
2005  hash_combine<Basic>(seed, *arg_);
2006  for (const auto &p : dict_) {
2007  hash_combine<Basic>(seed, *p.first);
2008  hash_combine<Basic>(seed, *p.second);
2009  }
2010  return seed;
2011 }

◆ compare()

int SymEngine::Subs::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 2021 of file functions.cpp.

2022 {
2023  SYMENGINE_ASSERT(is_a<Subs>(o))
2024  const Subs &s = down_cast<const Subs &>(o);
2025  int cmp = arg_->__cmp__(*(s.arg_));
2026  if (cmp != 0)
2027  return cmp;
2028  cmp = unified_compare(dict_, s.dict_);
2029  return cmp;
2030 }
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

Field Documentation

◆ type_code_id

const TypeID SymEngine::Subs::type_code_id = SYMENGINE_SUBS
static

Type_code_id shared by all instances

Definition at line 745 of file functions.h.


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