Loading...
Searching...
No Matches
SymEngine::ImageSet Class Reference
+ Inheritance diagram for SymEngine::ImageSet:
+ Collaboration diagram for SymEngine::ImageSet:

Public Member Functions

void accept (Visitor &v) const override
 
void accept (EvalRealDoubleVisitorFinal &v) const override
 
hash_t __hash__ () const override
 
bool __eq__ (const Basic &o) const override
 Test equality.
 
int compare (const Basic &o) const override
 
vec_basic get_args () const override
 Returns the list of arguments.
 
 ImageSet (const RCP< const Basic > &sym, const RCP< const Basic > &expr, const RCP< const Set > &base)
 
RCP< const Setset_intersection (const RCP< const Set > &o) const override
 
RCP< const Setset_union (const RCP< const Set > &o) const override
 
RCP< const Setset_complement (const RCP< const Set > &o) const override
 
RCP< const Booleancontains (const RCP< const Basic > &a) const override
 
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
vec_basic get_args () const override=0
 Returns the list of arguments.
 
virtual RCP< const Setset_intersection (const RCP< const Set > &o) const =0
 
virtual RCP< const Setset_union (const RCP< const Set > &o) const =0
 
virtual RCP< const Setset_complement (const RCP< const Set > &o) const =0
 
virtual RCP< const Booleancontains (const RCP< const Basic > &a) const =0
 
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.
 
virtual hash_t __hash__ () const =0
 
hash_t hash () const
 
virtual bool __eq__ (const Basic &o) const =0
 Test equality.
 
bool __neq__ (const Basic &o) const
 true if this is not equal to o.
 
int __cmp__ (const Basic &o) const
 Comparison operator.
 
virtual int compare (const Basic &o) const =0
 
std::string __str__ () const
 
std::string dumps () const
 Returns a string of the instance serialized.
 
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
 
virtual vec_basic get_args () const =0
 Returns the list of arguments.
 
virtual void accept (Visitor &v) const =0
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const =0
 
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 Member Functions inherited from SymEngine::Basic
static RCP< const Basicloads (const std::string &)
 Creates an instance of a serialized string.
 

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 488 of file sets.h.

Constructor & Destructor Documentation

◆ ImageSet()

SymEngine::ImageSet::ImageSet ( const RCP< const Basic > &  sym,
const RCP< const Basic > &  expr,
const RCP< const Set > &  base 
)

Definition at line 1524 of file sets.cpp.

1526 : sym_(sym), expr_(expr), base_(base)
1527{
1528 SYMENGINE_ASSIGN_TYPEID()
1529 SYMENGINE_ASSERT(ImageSet::is_canonical(sym, expr, base));
1530}

Member Function Documentation

◆ __eq__()

bool SymEngine::ImageSet::__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
oa constant reference to object to test against
Returns
True if this is equal to o

Implements SymEngine::Basic.

Definition at line 1541 of file sets.cpp.

1542{
1543 if (is_a<ImageSet>(o)) {
1544 const ImageSet &other = down_cast<const ImageSet &>(o);
1545 return unified_eq(sym_, other.sym_) and unified_eq(expr_, other.expr_)
1546 and unified_eq(base_, other.base_);
1547 }
1548 return false;
1549}

◆ __hash__()

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

1533{
1534 hash_t seed = SYMENGINE_IMAGESET;
1535 hash_combine<Basic>(seed, *sym_);
1536 hash_combine<Basic>(seed, *expr_);
1537 hash_combine<Basic>(seed, *base_);
1538 return seed;
1539}

◆ accept() [1/2]

void SymEngine::ImageSet::accept ( EvalRealDoubleVisitorFinal v) const
overridevirtual

Implements SymEngine::Basic.

◆ accept() [2/2]

void SymEngine::ImageSet::accept ( Visitor v) const
overridevirtual

Implements SymEngine::Basic.

◆ compare()

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

1552{
1553 SYMENGINE_ASSERT(is_a<ImageSet>(o))
1554 const ImageSet &other = down_cast<const ImageSet &>(o);
1555 int c1 = unified_compare(sym_, other.sym_);
1556 if (c1 != 0) {
1557 return c1;
1558 } else {
1559 int c2 = unified_compare(expr_, other.expr_);
1560 if (c2 != 0) {
1561 return c2;
1562 } else {
1563 return unified_compare(base_, other.base_);
1564 }
1565 }
1566}
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

◆ contains()

RCP< const Boolean > SymEngine::ImageSet::contains ( const RCP< const Basic > &  a) const
overridevirtual

Implements SymEngine::Set.

Definition at line 1578 of file sets.cpp.

1579{
1580 throw SymEngineException("Not implemented");
1581}

◆ create()

RCP< const Set > SymEngine::ImageSet::create ( const RCP< const Basic > &  sym,
const RCP< const Basic > &  expr,
const RCP< const Set > &  base 
) const

Definition at line 1598 of file sets.cpp.

1601{
1602 return imageset(sym, expr, base);
1603}

◆ get_args()

vec_basic SymEngine::ImageSet::get_args ( ) const
inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 501 of file sets.h.

502 {
503 return {sym_, expr_, base_};
504 }

◆ get_baseset()

const RCP< const Set > & SymEngine::ImageSet::get_baseset ( ) const
inline

Definition at line 524 of file sets.h.

525 {
526 return this->base_;
527 }

◆ get_expr()

const RCP< const Basic > & SymEngine::ImageSet::get_expr ( ) const
inline

Definition at line 520 of file sets.h.

521 {
522 return this->expr_;
523 }

◆ get_symbol()

const RCP< const Basic > & SymEngine::ImageSet::get_symbol ( ) const
inline

Definition at line 516 of file sets.h.

517 {
518 return this->sym_;
519 }

◆ is_canonical()

bool SymEngine::ImageSet::is_canonical ( const RCP< const Basic > &  sym,
const RCP< const Basic > &  expr,
const RCP< const Set > &  base 
)
static

Definition at line 1568 of file sets.cpp.

1571{
1572 if (not is_a_sub<Symbol>(*sym) or eq(*expr, *sym) or is_a_Number(*expr)
1573 or eq(*base, *emptyset()))
1574 return false;
1575 return true;
1576}
bool is_a_Number(const Basic &b)
Definition: number.h:130
RCP< const EmptySet > emptyset()
Definition: sets.h:590
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21

◆ set_complement()

RCP< const Set > SymEngine::ImageSet::set_complement ( const RCP< const Set > &  o) const
overridevirtual

Implements SymEngine::Set.

Definition at line 1593 of file sets.cpp.

1594{
1595 return SymEngine::set_complement(rcp_from_this_cast<const Set>(), o);
1596}

◆ set_intersection()

RCP< const Set > SymEngine::ImageSet::set_intersection ( const RCP< const Set > &  o) const
overridevirtual

Implements SymEngine::Set.

Definition at line 1588 of file sets.cpp.

1589{
1590 return SymEngine::set_intersection({rcp_from_this_cast<const Set>(), o});
1591}

◆ set_union()

RCP< const Set > SymEngine::ImageSet::set_union ( const RCP< const Set > &  o) const
overridevirtual

Implements SymEngine::Set.

Definition at line 1583 of file sets.cpp.

1584{
1585 return make_set_union({rcp_from_this_cast<const Set>(), o});
1586}

Field Documentation

◆ base_

RCP<const Set> SymEngine::ImageSet::base_
private

Definition at line 494 of file sets.h.

◆ expr_

RCP<const Basic> SymEngine::ImageSet::expr_
private

Definition at line 493 of file sets.h.

◆ sym_

RCP<const Basic> SymEngine::ImageSet::sym_
private

Definition at line 492 of file sets.h.

◆ type_code_id

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

Type_code_id shared by all instances

Definition at line 497 of file sets.h.


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