#include <functions.h>

Inheritance diagram for SymEngine::Subs:

Collaboration diagram for SymEngine::Subs:

Public Member Functions
void	accept (Visitor &v) const override

void	accept (EvalRealDoubleVisitorFinal &v) const override

	Subs (const RCP< const Basic > &arg, const map_basic_basic &x)

hash_t	__hash__ () const override

bool	__eq__ (const Basic &o) const override
	Test equality. More...

int	compare (const Basic &o) const override

const RCP< const Basic > &	get_arg () const

const map_basic_basic &	get_dict () const

virtual vec_basic	get_variables () const

virtual vec_basic	get_point () const

vec_basic	get_args () const override
	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.

Basic &	operator= (const Basic &)=delete
	Assignment operator in continuation with above.

	Basic (Basic &&)=delete
	Delete the move constructor and assignment.

Basic &	operator= (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 Basic >	subs (const map_basic_basic &subs_dict) const
	Substitutes 'subs_dict' into 'self'.

RCP< const Basic >	xreplace (const map_basic_basic &subs_dict) const

virtual RCP< const Basic >	expand_as_exp () const
	expands the special function in terms of exp function

RCP< const Basic >	diff (const RCP< const Symbol > &x, bool cache=true) const

Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basic >	rcp_from_this ()
	Get RCP<T> pointer to self (it will cast the pointer to T)

RCP< const Basic >	rcp_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 Subs >	create (const RCP< const Basic > &arg, const map_basic_basic &x)

Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basic >	loads (const std::string &)
	Creates an instance of a serialized string.

Static Public Attributes
static const TypeID	type_code_id = SYMENGINE_SUBS

Private Attributes
RCP< const Basic >	arg_

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

overridevirtual

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

o	a constant reference to object to test against

Returns: True if this is equal to o

Implements SymEngine::Basic.

Definition at line 2056 of file functions.cpp.

 {
     if (is_a<Subs>(o) and eq(*arg_, *(down_cast<const Subs &>(o).arg_))
         and unified_eq(dict_, down_cast<const Subs &>(o).dict_))
         return true;
     return false;
 }

◆ hash()

hash_t SymEngine::Subs::__hash__ ( ) const

overridevirtual

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 2045 of file functions.cpp.

 {
     hash_t seed = SYMENGINE_SUBS;
     hash_combine<Basic>(seed, *arg_);
     for (const auto &p : dict_) {
         hash_combine<Basic>(seed, *p.first);
         hash_combine<Basic>(seed, *p.second);
     }
     return seed;
 }

◆ compare()

int SymEngine::Subs::compare ( const Basic & o ) const

overridevirtual

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 2064 of file functions.cpp.

 {
     SYMENGINE_ASSERT(is_a<Subs>(o))
     const Subs &s = down_cast<const Subs &>(o);
     int cmp = arg_->__cmp__(*(s.arg_));
     if (cmp != 0)
         return cmp;
     cmp = unified_compare(dict_, s.dict_);
     return cmp;
 }

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:

/home/runner/work/symengine/symengine/symengine/functions.h
/home/runner/work/symengine/symengine/symengine/functions.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ compare()

Field Documentation

◆ type_code_id

◆ eq()

◆ hash()