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

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.
 
 FiniteSet (const set_basic &container)
 
virtual RCP< const Setset_union (const RCP< const Set > &o) const
 
virtual RCP< const Setset_intersection (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
 
RCP< const Setcreate (const set_basic &container) const
 
const set_basicget_container () 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 set_basic &container)
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_FINITESET
 

Private Attributes

set_basic container_
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 115 of file sets.h.

Member Function Documentation

◆ __eq__()

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

594 {
595  if (is_a<FiniteSet>(o)) {
596  const FiniteSet &other = down_cast<const FiniteSet &>(o);
597  return unified_eq(container_, other.container_);
598  }
599  return false;
600 }

◆ __hash__()

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

586 {
587  hash_t seed = SYMENGINE_FINITESET;
588  for (const auto &a : container_)
589  hash_combine<Basic>(seed, *a);
590  return seed;
591 }

◆ compare()

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

603 {
604  // compares two FiniteSet based on their length
605  SYMENGINE_ASSERT(is_a<FiniteSet>(o))
606  const FiniteSet &other = down_cast<const FiniteSet &>(o);
607  return unified_compare(container_, other.container_);
608 }
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

Field Documentation

◆ type_code_id

const TypeID SymEngine::FiniteSet::type_code_id = SYMENGINE_FINITESET
static

Type_code_id shared by all instances

Definition at line 121 of file sets.h.


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