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

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
void operator= (Naturals const &)=delete
 
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. More...
 
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
 
- Public Member Functions inherited from SymEngine::Set
virtual vec_basic get_args () const =0
 Returns the list of arguments. More...
 
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. More...
 
 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. More...
 
bool __neq__ (const Basic &o) const
 true if this is not equal to o. More...
 
int __cmp__ (const Basic &o) const
 Comparison operator. More...
 
virtual int compare (const Basic &o) const =0
 
std::string __str__ () const
 
std::string dumps () const
 Returns a string of the instance serialized. More...
 
RCP< const Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'. More...
 
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 More...
 
virtual vec_basic get_args () const =0
 Returns the list of arguments. More...
 
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) More...
 
RCP< const Basicrcp_from_this () const
 Get RCP<const T> pointer to self (it will cast the pointer to const T) More...
 
RCP< const T2 > rcp_from_this_cast () const
 Get RCP<T2> pointer to self (it will cast the pointer to T2) More...
 
unsigned int use_count () const
 

Static Public Member Functions

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

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_NATURALS
 

Friends

template<typename T_ , typename... Args>
RCP< T_ > make_rcp (Args &&...args)
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 310 of file sets.h.

Constructor & Destructor Documentation

◆ Naturals()

SymEngine::Naturals::Naturals ( )
inline

Definition at line 313 of file sets.h.

314 {
315 SYMENGINE_ASSIGN_TYPEID()
316 }

Member Function Documentation

◆ __eq__()

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

669{
670 if (is_a<Naturals>(o))
671 return true;
672 return false;
673}

◆ __hash__()

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

663{
664 hash_t seed = SYMENGINE_NATURALS;
665 return seed;
666}

◆ accept() [1/2]

virtual void SymEngine::Naturals::accept ( EvalRealDoubleVisitorFinal v) const
virtual

Implements SymEngine::Basic.

◆ accept() [2/2]

virtual void SymEngine::Naturals::accept ( Visitor v) const
virtual

Implements SymEngine::Basic.

◆ compare()

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

676{
677 SYMENGINE_ASSERT(is_a<Naturals>(o))
678 return 0;
679}

◆ contains()

RCP< const Boolean > SymEngine::Naturals::contains ( const RCP< const Basic > &  a) const
virtual

Implements SymEngine::Set.

Definition at line 646 of file sets.cpp.

647{
648 if (not is_a_Number(*a)) {
649 if (is_a_Set(*a)) {
650 return boolean(false);
651 } else {
652 return make_rcp<Contains>(a, rcp_from_this_cast<const Set>());
653 }
654 } else if (is_a<Integer>(*a)
655 and down_cast<const Integer &>(*a).is_positive()) {
656 return boolean(true);
657 } else {
658 return boolean(false);
659 }
660}
bool is_a_Number(const Basic &b)
Definition: number.h:130

◆ get_args()

virtual vec_basic SymEngine::Naturals::get_args ( ) const
inlinevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 325 of file sets.h.

326 {
327 return {};
328 }

◆ getInstance()

const RCP< const Naturals > & SymEngine::Naturals::getInstance ( )
static

Definition at line 681 of file sets.cpp.

682{
683 const static auto a = make_rcp<const Naturals>();
684 return a;
685}

◆ set_complement()

RCP< const Set > SymEngine::Naturals::set_complement ( const RCP< const Set > &  o) const
virtual

Implements SymEngine::Set.

Definition at line 631 of file sets.cpp.

632{
633 if (is_a<EmptySet>(*o) or is_a<Naturals>(*o)) {
634 return emptyset();
635 }
636 if (is_a<Naturals0>(*o)) {
637 finiteset({zero});
638 }
639 if (is_a<UniversalSet>(*o) or is_a<Integers>(*o) or is_a<Rationals>(*o)
640 or is_a<Reals>(*o) or is_a<Complexes>(*o)) {
641 return make_rcp<const Complement>(o, naturals());
642 }
643 return SymEngine::set_complement_helper(rcp_from_this_cast<const Set>(), o);
644}
RCP< const EmptySet > emptyset()
Definition: sets.h:590
RCP< const Set > finiteset(const set_basic &container)
Definition: sets.h:602
RCP< const Naturals > naturals()
Definition: sets.h:578

◆ set_intersection()

RCP< const Set > SymEngine::Naturals::set_intersection ( const RCP< const Set > &  o) const
virtual

Implements SymEngine::Set.

Definition at line 601 of file sets.cpp.

602{
603 if (is_a<EmptySet>(*o) or is_a<Naturals>(*o)) {
604 return o;
605 } else if (is_a<Naturals0>(*o) or is_a<Integers>(*o) or is_a<Complexes>(*o)
606 or is_a<Reals>(*o) or is_a<Rationals>(*o)) {
607 return naturals();
608 } else if (is_a<FiniteSet>(*o) or is_a<Interval>(*o)) {
609 return (*o).set_intersection(rcp_from_this_cast<const Set>());
610 } else {
611 return SymEngine::set_intersection(
612 {rcp_from_this_cast<const Set>(), o});
613 }
614}

◆ set_union()

RCP< const Set > SymEngine::Naturals::set_union ( const RCP< const Set > &  o) const
virtual

Implements SymEngine::Set.

Definition at line 616 of file sets.cpp.

617{
618 if (is_a<EmptySet>(*o)) {
619 return naturals();
620 } else if (is_a<Naturals>(*o) or is_a<Naturals0>(*o) or is_a<Integers>(*o)
621 or is_a<Complexes>(*o) or is_a<Reals>(*o) or is_a<Rationals>(*o)
622 or is_a<UniversalSet>(*o)) {
623 return o;
624 } else if (is_a<FiniteSet>(*o)) {
625 return (*o).set_union(rcp_from_this_cast<const Set>());
626 } else {
627 return SymEngine::make_set_union({rcp_from_this_cast<const Set>(), o});
628 }
629}

Friends And Related Function Documentation

◆ make_rcp

template<typename T_ , typename... Args>
RCP< T_ > make_rcp ( Args &&...  args)
friend

Definition at line 367 of file symengine_rcp.h.

368{
369#if defined(WITH_SYMENGINE_RCP)
370 return rcp(new T(std::forward<Args>(args)...));
371#else
372 RCP<T> p = rcp(new T(std::forward<Args>(args)...));
373 p->set_weak_self_ptr(p.create_weak());
374 return p;
375#endif
376}

Field Documentation

◆ type_code_id

const TypeID SymEngine::Naturals::type_code_id = SYMENGINE_NATURALS
static

Type_code_id shared by all instances

Definition at line 319 of file sets.h.


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