SymEngine::FiniteSet Class Reference

Inheritance diagram for SymEngine::FiniteSet:

Collaboration diagram for SymEngine::FiniteSet:

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.
	FiniteSet (const set_basic &container)
RCP< const Set >	set_union (const RCP< const Set > &o) const override
RCP< const Set >	set_intersection (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
RCP< const Set >	create (const set_basic &container) const
const set_basic &	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 Set >	set_intersection (const RCP< const Set > &o) const =0
virtual RCP< const Set >	set_union (const RCP< const Set > &o) const =0
virtual RCP< const Set >	set_complement (const RCP< const Set > &o) const =0
virtual RCP< const Boolean >	contains (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.
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.
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 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
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 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 bool	is_canonical (const set_basic &container)
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_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.

Constructor & Destructor Documentation

FiniteSet()

SymEngine::FiniteSet::FiniteSet

(

const set_basic &

container

)

Definition at line 850 of file sets.cpp.

                                               : container_(container)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(FiniteSet::is_canonical(container_));
}

Member Function Documentation

__eq__()

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

{
    if (is_a<FiniteSet>(o)) {
        const FiniteSet &other = down_cast<const FiniteSet &>(o);
        return unified_eq(container_, other.container_);
    }
    return false;
}

__hash__()

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

{
    hash_t seed = SYMENGINE_FINITESET;
    for (const auto &a : container_)
        hash_combine<Basic>(seed, *a);
    return seed;
}

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

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

{
    // compares two FiniteSet based on their length
    SYMENGINE_ASSERT(is_a<FiniteSet>(o))
    const FiniteSet &other = down_cast<const FiniteSet &>(o);
    return unified_compare(container_, other.container_);
}

contains()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 886 of file sets.cpp.

{
    set_basic rest;
    for (const auto &elem : container_) {
        auto cont = Eq(elem, a);
        if (eq(*cont, *boolTrue))
            return boolTrue;
        if (not eq(*cont, *boolFalse))
            rest.insert(elem);
    }
    if (rest.empty()) {
        return boolFalse;
    } else {
        return make_rcp<Contains>(a, finiteset(rest));
    }
}

create()

RCP< const Set > SymEngine::FiniteSet::create

(

const set_basic &

container

)

const

Definition at line 1182 of file sets.cpp.

{
    return finiteset(container);
}

get_args()

vec_basic SymEngine::FiniteSet::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 125 of file sets.h.

    {
        return vec_basic(container_.begin(), container_.end());
    }

get_container()

const set_basic & SymEngine::FiniteSet::get_container ( ) const

inline

Definition at line 139 of file sets.h.

    {
        return this->container_;
    }

is_canonical()

bool SymEngine::FiniteSet::is_canonical ( const set_basic &  container )

static

Definition at line 856 of file sets.cpp.

{
    return container.size() != 0;
}

set_complement()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1126 of file sets.cpp.

{
    if (is_a<FiniteSet>(*o)) {
        const FiniteSet &other = down_cast<const FiniteSet &>(*o);
        set_basic container;
        std::set_difference(other.container_.begin(), other.container_.end(),
                            container_.begin(), container_.end(),
                            std::inserter(container, container.begin()),
                            RCPBasicKeyLess{});
        return finiteset(container);
    }
 
    if (is_a<Interval>(*o)) {
        set_set intervals;
        auto &other = down_cast<const Interval &>(*o);
        RCP<const Number> last = other.get_start();
        RCP<const Number> a_num;
        set_basic rest;
        bool left_open = other.get_left_open(),
             right_open = other.get_right_open();
        for (auto it = container_.begin(); it != container_.end(); it++) {
            if (eq(*max({*it, other.get_start()}), *other.get_start())) {
                if (eq(**it, *other.get_start()))
                    left_open = true;
                continue;
            }
            if (eq(*max({*it, other.get_end()}), **it)) {
                if (eq(**it, *other.get_end()))
                    right_open = true;
                break;
            }
            if (is_a_Number(**it)) {
                a_num = rcp_static_cast<const Number>(*it);
                intervals.insert(interval(last, a_num, left_open, true));
                last = a_num;
                left_open = true;
            } else {
                rest.insert(*it);
            }
        }
 
        if (eq(*max({last, other.get_end()}), *other.get_end())) {
            intervals.insert(
                interval(last, other.get_end(), left_open, right_open));
        }
        if (rest.empty()) {
            return SymEngine::make_set_union(intervals);
        } else {
            return make_rcp<const Complement>(
                SymEngine::make_set_union(intervals), finiteset(rest));
        }
    }
 
    return SymEngine::set_complement_helper(rcp_from_this_cast<const Set>(), o);
}

set_intersection()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1031 of file sets.cpp.

{
    if (is_a<FiniteSet>(*o)) {
        return SymEngine::set_intersection(
            {rcp_from_this_cast<const Set>(), o});
    }
    if (is_a<Interval>(*o)) {
        set_basic container;
        for (const auto &a : container_) {
            auto contain = o->contains(a);
            if (eq(*contain, *boolTrue))
                container.insert(a);
            if (is_a<Contains>(*contain))
                return make_set_intersection(
                    {rcp_from_this_cast<const Set>(), o});
        }
        return finiteset(container);
    }
    if (is_a<Complexes>(*o) or is_a<Reals>(*o) or is_a<Rationals>(*o)) {
        set_basic kept;
        set_basic others;
        for (const auto &elem : container_) {
            if (is_a_Number(*elem)) {
                if (!down_cast<const Number &>(*elem).is_complex()) {
                    if (!is_a<Rationals>(*o)
                        or down_cast<const Number &>(*elem).is_exact()) {
                        kept.insert(elem);
                    }
                } else {
                    if (is_a<Complexes>(*o)) {
                        kept.insert(elem);
                    }
                }
            } else {
                others.insert(elem);
            }
        }
        if (kept.empty()) {
            if (others.empty()) {
                return emptyset();
            } else {
                return SymEngine::make_set_intersection({o, finiteset(others)});
            }
        } else {
            if (others.empty()) {
                return finiteset(kept);
            } else {
                others.insert(kept.begin(), kept.end());
                return SymEngine::make_set_intersection({o, finiteset(others)});
            }
        }
    }
    if (is_a<Integers>(*o) or is_a<Naturals>(*o) or is_a<Naturals0>(*o)) {
        set_basic kept_integers;
        set_basic others;
        for (const auto &elem : container_) {
            if (is_a_Number(*elem)) {
                if (is_a<Integers>(*o) and is_a<Integer>(*elem)) {
                    kept_integers.insert(elem);
                } else if (is_a<Naturals>(*o) and is_a<Integer>(*elem)
                           and down_cast<const Integer &>(*elem)
                                   .is_positive()) {
                    kept_integers.insert(elem);
                } else if (is_a<Naturals0>(*o) and is_a<Integer>(*elem)
                           and (not down_cast<const Integer &>(*elem)
                                        .is_negative())) {
                    kept_integers.insert(elem);
                }
            } else {
                others.insert(elem);
            }
        }
        if (kept_integers.empty()) {
            if (others.empty()) {
                return emptyset();
            } else {
                return SymEngine::make_set_intersection(
                    {integers(), finiteset(others)});
            }
        } else {
            if (others.empty()) {
                return finiteset(kept_integers);
            } else {
                others.insert(kept_integers.begin(), kept_integers.end());
                return SymEngine::make_set_intersection(
                    {integers(), finiteset(others)});
            }
        }
    }
    if (is_a<UniversalSet>(*o) or is_a<EmptySet>(*o) or is_a<Union>(*o)) {
        return (*o).set_intersection(rcp_from_this_cast<const Set>());
    }
    return make_set_intersection({rcp_from_this_cast<const Set>(), o});
}

set_union()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 903 of file sets.cpp.

{
    if (is_a<FiniteSet>(*o)) {
        const FiniteSet &other = down_cast<const FiniteSet &>(*o);
        set_basic container;
        std::set_union(container_.begin(), container_.end(),
                       other.container_.begin(), other.container_.end(),
                       std::inserter(container, container.begin()),
                       RCPBasicKeyLess{});
        return finiteset(container);
    }
    if (is_a<Interval>(*o)) {
        set_basic container;
        const Interval &other = down_cast<const Interval &>(*o);
        bool left = other.get_left_open(), right = other.get_right_open();
        for (const auto &a : container_) {
            auto contain = o->contains(a);
            if (eq(*contain, *boolFalse)) {
                if (left)
                    if (eq(*other.get_start(), *a)) {
                        left = false;
                        continue;
                    }
                if (right)
                    if (eq(*other.get_end(), *a)) {
                        right = false;
                        continue;
                    }
                container.insert(a);
            } else if (is_a<Contains>(*contain)) {
                container.insert(a);
            }
        }
        if (not container.empty()) {
            if (left == other.get_left_open()
                and right == other.get_right_open()) {
                return SymEngine::make_set_union({finiteset(container), o});
            } else {
                return SymEngine::make_set_union(
                    set_set({finiteset(container),
                             interval(other.get_start(), other.get_end(), left,
                                      right)}));
            }
        } else {
            if (left == other.get_left_open()
                and right == other.get_right_open()) {
                return o;
            } else {
                return interval(other.get_start(), other.get_end(), left,
                                right);
            }
        }
    }
    if (is_a<Complexes>(*o)) {
        set_basic container;
        for (const auto &elem : container_) {
            if (!is_a_Number(*elem)) {
                container.insert(elem);
            }
        }
        if (container.empty()) {
            return complexes();
        } else {
            return SymEngine::make_set_union(
                {complexes(), finiteset(container)});
        }
    }
    if (is_a<Reals>(*o)) {
        set_basic container;
        for (const auto &elem : container_) {
            if (!is_a_Number(*elem)
                || down_cast<const Number &>(*elem).is_complex()) {
                container.insert(elem);
            }
        }
        if (container.empty()) {
            return reals();
        } else {
            return SymEngine::make_set_union({reals(), finiteset(container)});
        }
    }
    if (is_a<Rationals>(*o)) {
        set_basic container;
        for (const auto &elem : container_) {
            if (!is_a_Number(*elem)
                || down_cast<const Number &>(*elem).is_complex()) {
                container.insert(elem);
            }
        }
        if (container.empty()) {
            return rationals();
        } else {
            return SymEngine::make_set_union(
                {rationals(), finiteset(container)});
        }
    }
    if (is_a<Integers>(*o) or is_a<Naturals>(*o) or is_a<Naturals0>(*o)) {
        set_basic container;
        for (const auto &elem : container_) {
            if (is_a<Integers>(*o)) {
                if (not is_a<Integer>(*elem)) {
                    container.insert(elem);
                }
            } else if (is_a<Naturals>(*o)) {
                if (not(is_a<Integer>(*elem)
                        and down_cast<const Integer &>(*elem).is_positive())) {
                    container.insert(elem);
                }
            } else {
                if (not(is_a<Integer>(*elem)
                        and not down_cast<const Integer &>(*elem)
                                    .is_negative())) {
                    container.insert(elem);
                }
            }
        }
        if (container.empty()) {
            return o;
        } else {
            return SymEngine::make_set_union({o, finiteset(container)});
        }
    }
    if (is_a<UniversalSet>(*o) or is_a<EmptySet>(*o) or is_a<Union>(*o)) {
        return (*o).set_union(rcp_from_this_cast<const Set>());
    }
    return SymEngine::make_set_union({rcp_from_this_cast<const Set>(), o});
}

Field Documentation

container_

set_basic SymEngine::FiniteSet::container_

private

Definition at line 118 of file sets.h.

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:

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