SymEngine::Union Class Reference

Inheritance diagram for SymEngine::Union:

Collaboration diagram for SymEngine::Union:

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.
	Union (const set_set &in)
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
const set_set &	get_container () const
RCP< const Set >	create (const set_set &in) const
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 bool	is_canonical (const set_set &in)
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_UNION

Private Attributes
set_set	container_

Additional Inherited Members
Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

Definition at line 368 of file sets.h.

Constructor & Destructor Documentation

Union()

SymEngine::Union::Union

(

const set_set &

in

)

Definition at line 1187 of file sets.cpp.

    : container_(in){SYMENGINE_ASSIGN_TYPEID()
                         SYMENGINE_ASSERT(Union::is_canonical(in))}

Member Function Documentation

__eq__()

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

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

__hash__()

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

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

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

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

{
    SYMENGINE_ASSERT(is_a<Union>(o))
    const Union &other = down_cast<const Union &>(o);
    return unified_compare(container_, other.container_);
}

contains()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1266 of file sets.cpp.

{
    for (auto &a : container_) {
        auto contain = a->contains(o);
        if (eq(*contain, *boolTrue)) {
            return boolean(true);
        }
        if (is_a<Contains>(*contain))
            throw NotImplementedError("Not implemented");
    }
    return boolean(false);
}

create()

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

(

const set_set &

in

)

const

Definition at line 1279 of file sets.cpp.

{
    return SymEngine::set_union(in);
}

get_args()

vec_basic SymEngine::Union::get_args ( ) const

overridevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 1284 of file sets.cpp.

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

get_container()

const set_set & SymEngine::Union::get_container ( ) const

inline

Definition at line 387 of file sets.h.

    {
        return this->container_;
    }

is_canonical()

bool SymEngine::Union::is_canonical ( const set_set &  in )

static

Definition at line 1208 of file sets.cpp.

{
    if (in.size() <= 1)
        return false;
    int count = 0;
    for (const auto &s : in) {
        if (is_a<FiniteSet>(*s)) {
            count++;
        }
        if (count >= 2)
            return false;
    }
    return true;
}

set_complement()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1257 of file sets.cpp.

{
    set_set container;
    for (auto &a : container_) {
        container.insert(a->set_complement(o));
    }
    return SymEngine::set_intersection(container);
}

set_intersection()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1248 of file sets.cpp.

{
    set_set container;
    for (auto &a : container_) {
        container.insert(a->set_intersection(o));
    }
    return SymEngine::set_union(container);
}

set_union()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1230 of file sets.cpp.

{
    set_set container(container_);
    for (auto iter = container.begin(); iter != container.end(); ++iter) {
        auto temp = o->set_union(*iter);
        // If we are able to do union with `*iter`, we replace `*iter` with
        // the result of union.
        auto un = SymEngine::make_set_union({o, *iter});
        if (not eq(*temp, *un)) {
            iter = container.erase(iter);
            container.insert(temp);
            return SymEngine::set_union(container);
        }
    }
    container.insert(o);
    return SymEngine::make_set_union(container);
}

Field Documentation

container_

set_set SymEngine::Union::container_

private

Definition at line 371 of file sets.h.

type_code_id

const TypeID SymEngine::Union::type_code_id = SYMENGINE_UNION

static

Type_code_id shared by all instances

Definition at line 374 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