SymEngine::Naturals Class Reference

Inheritance diagram for SymEngine::Naturals:

Collaboration diagram for SymEngine::Naturals:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
void	operator= (Naturals const &)=delete
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.
RCP< const Set >	set_intersection (const RCP< const Set > &o) const override
RCP< const Set >	set_union (const RCP< const Set > &o) const override
RCP< const Set >	set_complement (const RCP< const Set > &o) const override
RCP< const Boolean >	contains (const RCP< const Basic > &a) const override
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.
Basic &	operator= (const Basic &)=delete
	Assignment operator in continuation with above.
	Basic (Basic &&)=delete
	Delete the move constructor and assignment.
Basic &	operator= (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.
int	__cmp__ (const Basic &o) const
	Comparison operator.
std::string	__str__ () const
std::string	dumps () const
	Returns a string of the instance serialized.
RCP< const Basic >	subs (const map_basic_basic &subs_dict) const
	Substitutes 'subs_dict' into 'self'.
RCP< const Basic >	xreplace (const map_basic_basic &subs_dict) const
virtual RCP< const Basic >	expand_as_exp () const
	expands the special function in terms of exp function
RCP< const Basic >	diff (const RCP< const Symbol > &x, bool cache=true) const
Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basic >	rcp_from_this ()
	Get RCP<T> pointer to self (it will cast the pointer to T)
RCP< const Basic >	rcp_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 const RCP< const Naturals > &	getInstance ()
Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basic >	loads (const std::string &)
	Creates an instance of a serialized string.

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.

    {
        SYMENGINE_ASSIGN_TYPEID()
    }

Member Function Documentation

__eq__()

bool SymEngine::Naturals::__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

o	a 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.

{
    if (is_a<Naturals>(o))
        return true;
    return false;
}

__hash__()

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

{
    hash_t seed = SYMENGINE_NATURALS;
    return seed;
}

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

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

{
    SYMENGINE_ASSERT(is_a<Naturals>(o))
    return 0;
}

contains()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 646 of file sets.cpp.

{
    if (not is_a_Number(*a)) {
        if (is_a_Set(*a)) {
            return boolean(false);
        } else {
            return make_rcp<Contains>(a, rcp_from_this_cast<const Set>());
        }
    } else if (is_a<Integer>(*a)
               and down_cast<const Integer &>(*a).is_positive()) {
        return boolean(true);
    } else {
        return boolean(false);
    }
}

get_args()

vec_basic SymEngine::Naturals::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 325 of file sets.h.

    {
        return {};
    }

getInstance()

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

static

Definition at line 681 of file sets.cpp.

{
    const static auto a = make_rcp<const Naturals>();
    return a;
}

set_complement()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 631 of file sets.cpp.

{
    if (is_a<EmptySet>(*o) or is_a<Naturals>(*o)) {
        return emptyset();
    }
    if (is_a<Naturals0>(*o)) {
        finiteset({zero});
    }
    if (is_a<UniversalSet>(*o) or is_a<Integers>(*o) or is_a<Rationals>(*o)
        or is_a<Reals>(*o) or is_a<Complexes>(*o)) {
        return make_rcp<const Complement>(o, naturals());
    }
    return SymEngine::set_complement_helper(rcp_from_this_cast<const Set>(), o);
}

set_intersection()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 601 of file sets.cpp.

{
    if (is_a<EmptySet>(*o) or is_a<Naturals>(*o)) {
        return o;
    } else if (is_a<Naturals0>(*o) or is_a<Integers>(*o) or is_a<Complexes>(*o)
               or is_a<Reals>(*o) or is_a<Rationals>(*o)) {
        return naturals();
    } else if (is_a<FiniteSet>(*o) or is_a<Interval>(*o)) {
        return (*o).set_intersection(rcp_from_this_cast<const Set>());
    } else {
        return SymEngine::set_intersection(
            {rcp_from_this_cast<const Set>(), o});
    }
}

set_union()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 616 of file sets.cpp.

{
    if (is_a<EmptySet>(*o)) {
        return naturals();
    } else if (is_a<Naturals>(*o) or is_a<Naturals0>(*o) or is_a<Integers>(*o)
               or is_a<Complexes>(*o) or is_a<Reals>(*o) or is_a<Rationals>(*o)
               or is_a<UniversalSet>(*o)) {
        return o;
    } else if (is_a<FiniteSet>(*o)) {
        return (*o).set_union(rcp_from_this_cast<const Set>());
    } else {
        return SymEngine::make_set_union({rcp_from_this_cast<const Set>(), o});
    }
}

Friends And Related Symbol Documentation

make_rcp

template<typename T_ , typename... Args>

RCP< T_ > make_rcp ( Args &&...  args )

friend

Definition at line 367 of file symengine_rcp.h.

{
#if defined(WITH_SYMENGINE_RCP)
    return rcp(new T(std::forward<Args>(args)...));
#else
    RCP<T> p = rcp(new T(std::forward<Args>(args)...));
    p->set_weak_self_ptr(p.create_weak());
    return p;
#endif
}

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:

• /home/runner/work/symengine/symengine/symengine/sets.h
• /home/runner/work/symengine/symengine/symengine/sets.cpp