Inheritance diagram for SymEngine::ImageSet:

Collaboration diagram for SymEngine::ImageSet:

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.

	ImageSet (const RCP< const Basic > &sym, const RCP< const Basic > &expr, const RCP< const Set > &base)

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 Basic > &	get_expr () const

const RCP< const Set > &	get_baseset () const

RCP< const Set >	create (const RCP< const Basic > &sym, const RCP< const Basic > &expr, const RCP< const Set > &base) 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 Basic > &expr, const RCP< const Set > &base)

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_IMAGESET

Private Attributes
RCP< const Basic >	sym_

RCP< const Basic >	expr_

RCP< const Set >	base_

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

Detailed Description

Definition at line 488 of file sets.h.

Constructor & Destructor Documentation

◆ ImageSet()

SymEngine::ImageSet::ImageSet	(	const RCP< const Basic > &	sym,
		const RCP< const Basic > &	expr,
		const RCP< const Set > &	base
	)

Definition at line 1524 of file sets.cpp.

    : sym_(sym), expr_(expr), base_(base)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(ImageSet::is_canonical(sym, expr, base));
}

Member Function Documentation

◆ eq()

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

{
    if (is_a<ImageSet>(o)) {
        const ImageSet &other = down_cast<const ImageSet &>(o);
        return unified_eq(sym_, other.sym_) and unified_eq(expr_, other.expr_)
               and unified_eq(base_, other.base_);
    }
    return false;
}

◆ hash()

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

{
    hash_t seed = SYMENGINE_IMAGESET;
    hash_combine<Basic>(seed, *sym_);
    hash_combine<Basic>(seed, *expr_);
    hash_combine<Basic>(seed, *base_);
    return seed;
}

◆ accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

◆ accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

◆ compare()

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

{
    SYMENGINE_ASSERT(is_a<ImageSet>(o))
    const ImageSet &other = down_cast<const ImageSet &>(o);
    int c1 = unified_compare(sym_, other.sym_);
    if (c1 != 0) {
        return c1;
    } else {
        int c2 = unified_compare(expr_, other.expr_);
        if (c2 != 0) {
            return c2;
        } else {
            return unified_compare(base_, other.base_);
        }
    }
}

◆ contains()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1578 of file sets.cpp.

{
    throw SymEngineException("Not implemented");
}

◆ create()

RCP< const Set > SymEngine::ImageSet::create	(	const RCP< const Basic > &	sym,
		const RCP< const Basic > &	expr,
		const RCP< const Set > &	base
	)		const

Definition at line 1598 of file sets.cpp.

{
    return imageset(sym, expr, base);
}

◆ get_args()

vec_basic SymEngine::ImageSet::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Set.

Definition at line 501 of file sets.h.

    {
        return {sym_, expr_, base_};
    }

◆ get_baseset()

const RCP< const Set > & SymEngine::ImageSet::get_baseset ( ) const

inline

Definition at line 524 of file sets.h.

    {
        return this->base_;
    }

◆ get_expr()

const RCP< const Basic > & SymEngine::ImageSet::get_expr ( ) const

inline

Definition at line 520 of file sets.h.

    {
        return this->expr_;
    }

◆ get_symbol()

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

inline

Definition at line 516 of file sets.h.

    {
        return this->sym_;
    }

◆ is_canonical()

bool SymEngine::ImageSet::is_canonical	(	const RCP< const Basic > &	sym,
		const RCP< const Basic > &	expr,
		const RCP< const Set > &	base
	)

static

Definition at line 1568 of file sets.cpp.

{
    if (not is_a_sub<Symbol>(*sym) or eq(*expr, *sym) or is_a_Number(*expr)
        or eq(*base, *emptyset()))
        return false;
    return true;
}

◆ set_complement()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1593 of file sets.cpp.

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

◆ set_intersection()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1588 of file sets.cpp.

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

◆ set_union()

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

overridevirtual

Implements SymEngine::Set.

Definition at line 1583 of file sets.cpp.

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

Field Documentation

◆ base_

RCP<const Set> SymEngine::ImageSet::base_

private

Definition at line 494 of file sets.h.

◆ expr_

RCP<const Basic> SymEngine::ImageSet::expr_

private

Definition at line 493 of file sets.h.

◆ sym_

RCP<const Basic> SymEngine::ImageSet::sym_

private

Definition at line 492 of file sets.h.

◆ type_code_id

const TypeID SymEngine::ImageSet::type_code_id = SYMENGINE_IMAGESET

static

Type_code_id shared by all instances

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageSet()

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ accept() [1/2]

◆ accept() [2/2]

◆ compare()

◆ contains()

◆ create()

◆ get_args()

◆ get_baseset()

◆ get_expr()

◆ get_symbol()

◆ is_canonical()

◆ set_complement()

◆ set_intersection()

◆ set_union()

Field Documentation

◆ base_

◆ expr_

◆ sym_

◆ type_code_id

◆ eq()

◆ hash()