SymEngine::ConditionSet Class Reference

Inheritance diagram for SymEngine::ConditionSet:

Collaboration diagram for SymEngine::ConditionSet:

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.
	ConditionSet (const RCP< const Basic > &sym, const RCP< const Boolean > &condition)
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 RCP< const Basic > &	get_symbol () const
const RCP< const Boolean > &	get_condition () 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 RCP< const Basic > &sym, const RCP< const Boolean > &condition)
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_CONDITIONSET

Private Attributes
RCP< const Basic >	sym
RCP< const Boolean >	condition_

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

Detailed Description

Definition at line 455 of file sets.h.

Constructor & Destructor Documentation

ConditionSet()

SymEngine::ConditionSet::ConditionSet	(	const RCP< const Basic > &	sym,
		const RCP< const Boolean > &	condition
	)

Definition at line 1445 of file sets.cpp.

    : sym(sym), condition_(condition)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(ConditionSet::is_canonical(sym, condition))
}

Member Function Documentation

__eq__()

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

{
    if (is_a<ConditionSet>(o)) {
        const ConditionSet &other = down_cast<const ConditionSet &>(o);
        return unified_eq(sym, other.get_symbol())
               and unified_eq(condition_, other.get_condition());
    }
    return false;
}

__hash__()

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

{
    hash_t seed = SYMENGINE_CONDITIONSET;
    hash_combine<Basic>(seed, *sym);
    hash_combine<Basic>(seed, *condition_);
    return seed;
}

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

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

{
    SYMENGINE_ASSERT(is_a<ConditionSet>(o))
    const ConditionSet &other = down_cast<const ConditionSet &>(o);
    int c1 = unified_compare(sym, other.get_symbol());
    if (c1 != 0) {
        return c1;
    } else {
        return unified_compare(condition_, other.get_condition());
    }
}

contains()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1513 of file sets.cpp.

{
    map_basic_basic d;
    d[sym] = o;
    auto cond = condition_->subs(d);
    if (not is_a_Boolean(*cond)) {
        throw SymEngineException("expected an object of type Boolean");
    }
    return rcp_static_cast<const Boolean>(cond);
}

get_args()

vec_basic SymEngine::ConditionSet::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 466 of file sets.h.

    {
        return {sym, condition_};
    }

get_condition()

const RCP< const Boolean > & SymEngine::ConditionSet::get_condition ( ) const

inline

Definition at line 482 of file sets.h.

    {
        return this->condition_;
    }

get_symbol()

const RCP< const Basic > & SymEngine::ConditionSet::get_symbol ( ) const

inline

Definition at line 478 of file sets.h.

    {
        return this->sym;
    }

is_canonical()

bool SymEngine::ConditionSet::is_canonical ( const RCP< const Basic > &  sym, const RCP< const Boolean > &  condition  )

static

Definition at line 1453 of file sets.cpp.

{
    if (eq(*condition, *boolFalse) or eq(*condition, *boolTrue)
        or not is_a_sub<Symbol>(*sym)) {
        return false;
    } else if (is_a<Contains>(*condition)) {
        return false;
    }
    return true;
}

set_complement()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1508 of file sets.cpp.

{
    return make_rcp<const Complement>(o, rcp_from_this_cast<const Set>());
}

set_intersection()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1500 of file sets.cpp.

{
    if (not is_a<ConditionSet>(*o)) {
        return conditionset(sym, logical_and({condition_, o->contains(sym)}));
    }
    return make_set_intersection({rcp_from_this_cast<const Set>(), o});
}

set_union()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1495 of file sets.cpp.

{
    return SymEngine::make_set_union({o, rcp_from_this_cast<const Set>()});
}

Field Documentation

condition_

RCP<const Boolean> SymEngine::ConditionSet::condition_

private

Definition at line 459 of file sets.h.

sym

RCP<const Basic> SymEngine::ConditionSet::sym

private

Definition at line 458 of file sets.h.

type_code_id

const TypeID SymEngine::ConditionSet::type_code_id = SYMENGINE_CONDITIONSET

static

Type_code_id shared by all instances

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