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

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.
 
 Complement (const RCP< const Set > &universe, const RCP< const Set > &container)
 
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 Set > & get_universe () const
 
const RCP< const Set > & get_container () 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 Attributes

static const TypeID type_code_id = SYMENGINE_COMPLEMENT
 

Private Attributes

RCP< const Setuniverse_
 
RCP< const Setcontainer_
 

Additional Inherited Members

- Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basicloads (const std::string &)
 Creates an instance of a serialized string.
 
- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 422 of file sets.h.

Constructor & Destructor Documentation

◆ Complement()

SymEngine::Complement::Complement ( const RCP< const Set > &  universe,
const RCP< const Set > &  container 
)

Definition at line 1385 of file sets.cpp.

1387 : universe_(universe), container_(container){SYMENGINE_ASSIGN_TYPEID()}

Member Function Documentation

◆ __eq__()

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

1398{
1399 if (is_a<Complement>(o)) {
1400 const Complement &other = down_cast<const Complement &>(o);
1401 return unified_eq(universe_, other.universe_)
1402 and unified_eq(container_, other.container_);
1403 }
1404 return false;
1405}

◆ __hash__()

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

1390{
1391 hash_t seed = SYMENGINE_COMPLEMENT;
1392 hash_combine<Basic>(seed, *universe_);
1393 hash_combine<Basic>(seed, *container_);
1394 return seed;
1395}

◆ accept() [1/2]

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

Implements SymEngine::Basic.

◆ accept() [2/2]

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

Implements SymEngine::Basic.

◆ compare()

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

1408{
1409 SYMENGINE_ASSERT(is_a<Complement>(o))
1410 const Complement &other = down_cast<const Complement &>(o);
1411 int c1 = unified_compare(universe_, other.universe_);
1412 if (c1 != 0) {
1413 return c1;
1414 } else {
1415 return unified_compare(container_, other.container_);
1416 }
1417}
int unified_compare(const T &a, const T &b)
Definition: dict.h:205

◆ contains()

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

Implements SymEngine::Set.

Definition at line 1419 of file sets.cpp.

1420{
1421 return logical_and(
1422 {universe_->contains(a), logical_not(container_->contains(a))});
1423}

◆ get_args()

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

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 434 of file sets.h.

435 {
436 return {universe_, container_};
437 }

◆ get_container()

const RCP< const Set > & SymEngine::Complement::get_container ( ) const
inline

Definition at line 449 of file sets.h.

450 {
451 return this->container_;
452 }

◆ get_universe()

const RCP< const Set > & SymEngine::Complement::get_universe ( ) const
inline

Definition at line 445 of file sets.h.

446 {
447 return this->universe_;
448 }

◆ set_complement()

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

Implements SymEngine::Set.

Definition at line 1439 of file sets.cpp.

1440{
1441 auto newuniv = SymEngine::set_union({o, universe_});
1442 return container_->set_complement(newuniv);
1443}

◆ set_intersection()

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

Implements SymEngine::Set.

Definition at line 1434 of file sets.cpp.

1435{
1436 return SymEngine::set_intersection({rcp_from_this_cast<const Set>(), o});
1437}

◆ set_union()

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

Implements SymEngine::Set.

Definition at line 1425 of file sets.cpp.

1426{
1427 // A' U C = (A n C')'
1428 RCP<const Set> ocomplement = o->set_complement(universe_);
1429 RCP<const Set> intersect
1430 = SymEngine::set_intersection({container_, ocomplement});
1431 return intersect->set_complement(universe_);
1432}

Field Documentation

◆ container_

RCP<const Set> SymEngine::Complement::container_
private

Definition at line 427 of file sets.h.

◆ type_code_id

const TypeID SymEngine::Complement::type_code_id = SYMENGINE_COMPLEMENT
static

Type_code_id shared by all instances

Definition at line 430 of file sets.h.

◆ universe_

RCP<const Set> SymEngine::Complement::universe_
private

Definition at line 426 of file sets.h.


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