SymEngine::MatrixAdd Class Reference

Inheritance diagram for SymEngine::MatrixAdd:

Collaboration diagram for SymEngine::MatrixAdd:

Public Member Functions
	MatrixAdd (const vec_basic &terms)
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
bool	is_canonical (const vec_basic &terms) const
vec_basic	get_args () const override
	Returns the list of arguments.
const vec_basic &	get_terms () 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_MATRIXADD

Private Attributes
vec_basic	terms_

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 11 of file matrix_add.h.

Constructor & Destructor Documentation

MatrixAdd()

SymEngine::MatrixAdd::MatrixAdd ( const vec_basic &  terms )

inline

Definition at line 17 of file matrix_add.h.

                                      : terms_(terms)
    {
        SYMENGINE_ASSIGN_TYPEID();
        SYMENGINE_ASSERT(is_canonical(terms));
    }

Member Function Documentation

__eq__()

bool SymEngine::MatrixAdd::__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 19 of file matrix_add.cpp.

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

__hash__()

hash_t SymEngine::MatrixAdd::__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 10 of file matrix_add.cpp.

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

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

int SymEngine::MatrixAdd::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 28 of file matrix_add.cpp.

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

get_args()

vec_basic SymEngine::MatrixAdd::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 28 of file matrix_add.h.

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

get_terms()

const vec_basic & SymEngine::MatrixAdd::get_terms ( ) const

inline

Definition at line 32 of file matrix_add.h.

    {
        return terms_;
    }

is_canonical()

bool SymEngine::MatrixAdd::is_canonical

(

const vec_basic &

terms

)

const

Definition at line 35 of file matrix_add.cpp.

{
    if (terms.size() < 2) {
        return false;
    }
    size_t num_diag = 0;
    size_t num_dense = 0;
    for (auto term : terms) {
        if (is_a<ZeroMatrix>(*term) || is_a<MatrixAdd>(*term)) {
            return false;
        } else if (is_a<DiagonalMatrix>(*term)) {
            num_diag++;
        } else if (is_a<ImmutableDenseMatrix>(*term)) {
            num_dense++;
        }
    }
    if (num_diag > 1 || num_dense > 1) {
        return false;
    }
    if (num_diag == 1 && num_dense == 1) {
        return false;
    }
    return true;
}

Field Documentation

terms_

vec_basic SymEngine::MatrixAdd::terms_

private

Definition at line 14 of file matrix_add.h.

type_code_id

const TypeID SymEngine::MatrixAdd::type_code_id = SYMENGINE_MATRIXADD

static

Type_code_id shared by all instances

Definition at line 23 of file matrix_add.h.

---

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

• /home/runner/work/symengine/symengine/symengine/matrices/matrix_add.h
• /home/runner/work/symengine/symengine/symengine/matrices/matrix_add.cpp