SymEngine::ImageSet Class Reference
+ Inheritance diagram for SymEngine::ImageSet:
+ Collaboration diagram for SymEngine::ImageSet:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
virtual hash_t __hash__ () const
 
virtual bool __eq__ (const Basic &o) const
 Test equality. More...
 
virtual int compare (const Basic &o) const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
 ImageSet (const RCP< const Basic > &sym, const RCP< const Basic > &expr, const RCP< const Set > &base)
 
virtual RCP< const Setset_intersection (const RCP< const Set > &o) const
 
virtual RCP< const Setset_union (const RCP< const Set > &o) const
 
virtual RCP< const Setset_complement (const RCP< const Set > &o) const
 
virtual RCP< const Booleancontains (const RCP< const Basic > &a) const
 
const RCP< const Basic > & get_symbol () const
 
const RCP< const Basic > & get_expr () const
 
const RCP< const Set > & get_baseset () const
 
RCP< const Setcreate (const RCP< const Basic > &sym, const RCP< const Basic > &expr, const RCP< const Set > &base) const
 
- Public Member Functions inherited from SymEngine::Set
bool is_subset (const RCP< const Set > &o) const
 
bool is_proper_subset (const RCP< const Set > &o) const
 
bool is_superset (const RCP< const Set > &o) const
 
bool is_proper_superset (const RCP< const Set > &o) 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 bool is_canonical (const RCP< const Basic > &sym, const RCP< const Basic > &expr, const RCP< const Set > &base)
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_IMAGESET
 

Private Attributes

RCP< const Basicsym_
 
RCP< const Basicexpr_
 
RCP< const Setbase_
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 374 of file sets.h.

Member Function Documentation

◆ __eq__()

bool SymEngine::ImageSet::__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 1136 of file sets.cpp.

1137 {
1138  if (is_a<ImageSet>(o)) {
1139  const ImageSet &other = down_cast<const ImageSet &>(o);
1140  return unified_eq(sym_, other.sym_) and unified_eq(expr_, other.expr_)
1141  and unified_eq(base_, other.base_);
1142  }
1143  return false;
1144 }

◆ __hash__()

hash_t SymEngine::ImageSet::__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 1127 of file sets.cpp.

1128 {
1129  hash_t seed = SYMENGINE_IMAGESET;
1130  hash_combine<Basic>(seed, *sym_);
1131  hash_combine<Basic>(seed, *expr_);
1132  hash_combine<Basic>(seed, *base_);
1133  return seed;
1134 }

◆ compare()

int SymEngine::ImageSet::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 1146 of file sets.cpp.

1147 {
1148  SYMENGINE_ASSERT(is_a<ImageSet>(o))
1149  const ImageSet &other = down_cast<const ImageSet &>(o);
1150  int c1 = unified_compare(sym_, other.sym_);
1151  if (c1 != 0) {
1152  return c1;
1153  } else {
1154  int c2 = unified_compare(expr_, other.expr_);
1155  if (c2 != 0) {
1156  return c2;
1157  } else {
1158  return unified_compare(base_, other.base_);
1159  }
1160  }
1161 }
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

Field Documentation

◆ type_code_id

const TypeID SymEngine::ImageSet::type_code_id = SYMENGINE_IMAGESET
static

Type_code_id shared by all instances

Definition at line 383 of file sets.h.


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