SymEngine::Tuple Class Reference

Inheritance diagram for SymEngine::Tuple:

Collaboration diagram for SymEngine::Tuple:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Tuple (const vec_basic &container)
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.
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 vec_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_TUPLE

Private Attributes
vec_basic	container_

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

Detailed Description

Definition at line 9 of file tuple.h.

Constructor & Destructor Documentation

Tuple()

SymEngine::Tuple::Tuple

(

const vec_basic &

container

)

Definition at line 7 of file tuple.cpp.

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

Member Function Documentation

__eq__()

bool SymEngine::Tuple::__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 26 of file tuple.cpp.

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

__hash__()

hash_t SymEngine::Tuple::__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 18 of file tuple.cpp.

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

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

int SymEngine::Tuple::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 35 of file tuple.cpp.

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

get_args()

vec_basic SymEngine::Tuple::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 23 of file tuple.h.

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

is_canonical()

bool SymEngine::Tuple::is_canonical ( const vec_basic &  container )

static

Definition at line 13 of file tuple.cpp.

{
    return true;
}

Field Documentation

container_

vec_basic SymEngine::Tuple::container_

private

Definition at line 12 of file tuple.h.

type_code_id

const TypeID SymEngine::Tuple::type_code_id = SYMENGINE_TUPLE

static

Type_code_id shared by all instances

Definition at line 15 of file tuple.h.

---

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

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