SymEngine::Xor Class Reference

Inheritance diagram for SymEngine::Xor:

Collaboration diagram for SymEngine::Xor:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Xor (const vec_boolean &s)
bool	is_canonical (const vec_boolean &container_)
hash_t	__hash__ () const override
vec_basic	get_args () const override
	Returns the list of arguments.
bool	__eq__ (const Basic &o) const override
	Test equality.
int	compare (const Basic &o) const override
const vec_boolean &	get_container () const
Public Member Functions inherited from SymEngine::Boolean
virtual RCP< const Boolean >	logical_not () 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 Attributes
static const TypeID	type_code_id = SYMENGINE_XOR

Private Attributes
vec_boolean	container_

Additional Inherited Members
Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basic >	loads (const std::string &)
	Creates an instance of a serialized string.
Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

Definition at line 162 of file logic.h.

Constructor & Destructor Documentation

Xor()

SymEngine::Xor::Xor

(

const vec_boolean &

s

)

Definition at line 398 of file logic.cpp.

                             : container_{s}
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(s));
}

Member Function Documentation

__eq__()

bool SymEngine::Xor::__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 418 of file logic.cpp.

{
    return is_a<Xor>(o)
           and unified_eq(container_,
                          down_cast<const Xor &>(o).get_container());
}

__hash__()

hash_t SymEngine::Xor::__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 404 of file logic.cpp.

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

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

int SymEngine::Xor::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 425 of file logic.cpp.

{
    SYMENGINE_ASSERT(is_a<Xor>(o))
    return unified_compare(container_,
                           down_cast<const Xor &>(o).get_container());
}

get_args()

vec_basic SymEngine::Xor::get_args ( ) const

overridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 412 of file logic.cpp.

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

get_container()

const vec_boolean & SymEngine::Xor::get_container

(

)

const

Definition at line 453 of file logic.cpp.

{
    return container_;
}

is_canonical()

bool SymEngine::Xor::is_canonical

(

const vec_boolean &

container_

)

Definition at line 432 of file logic.cpp.

{
    if (container_.size() >= 2) {
        set_boolean args;
        for (auto &a : container_) {
            if (is_a<BooleanAtom>(*a) or is_a<Xor>(*a)) {
                return false;
            }
            if (args.find(a) != args.end()) {
                return false;
            }
            if (args.find(SymEngine::logical_not(a)) != args.end()) {
                return false;
            }
            args.insert(a);
        }
        return true;
    }
    return false;
}

Field Documentation

container_

vec_boolean SymEngine::Xor::container_

private

Definition at line 165 of file logic.h.

type_code_id

const TypeID SymEngine::Xor::type_code_id = SYMENGINE_XOR

static

Type_code_id shared by all instances

Definition at line 168 of file logic.h.

---

The documentation for this class was generated from the following files:

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