No Matches
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_basicget_terms () const
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 Basic ()
 Basic (const Basic &)=delete
 Delete the copy constructor and assignment.
Basicoperator= (const Basic &)=delete
 Assignment operator in continuation with above.
 Basic (Basic &&)=delete
 Delete the move constructor and assignment.
Basicoperator= (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 Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'.
RCP< const Basicxreplace (const map_basic_basic &subs_dict) const
virtual RCP< const Basicexpand_as_exp () const
 expands the special function in terms of exp function
RCP< const Basicdiff (const RCP< const Symbol > &x, bool cache=true) const
- Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basicrcp_from_this ()
 Get RCP<T> pointer to self (it will cast the pointer to T)
RCP< const Basicrcp_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 Basicloads (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)

Definition at line 17 of file matrix_add.h.

17 : terms_(terms)
18 {
20 SYMENGINE_ASSERT(is_canonical(terms));
21 }
void hash_combine(hash_t &seed, const T &v)
Definition basic-inl.h:95

Member Function Documentation

◆ __eq__()

bool SymEngine::MatrixAdd::__eq__ ( const Basic o) const

Test equality.

A virtual function for testing the equality of two Basic objects

Use eq(const Basic &a, const Basic &b) non-member method
oa constant reference to object to test against
True if this is equal to o

Implements SymEngine::Basic.

Definition at line 19 of file matrix_add.cpp.

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

◆ __hash__()

hash_t SymEngine::MatrixAdd::__hash__ ( ) const

Calculates the hash of the given SymEngine class. Use Basic.hash() which gives a cached version of the hash.

64-bit integer value for the hash

Implements SymEngine::Basic.

Definition at line 10 of file matrix_add.cpp.

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

◆ accept() [1/2]

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

Implements SymEngine::Basic.

◆ accept() [2/2]

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

Implements SymEngine::Basic.

◆ compare()

int SymEngine::MatrixAdd::compare ( const Basic o) const

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.

30 SYMENGINE_ASSERT(is_a<MatrixAdd>(o));
31 const MatrixAdd &other = down_cast<const MatrixAdd &>(o);
32 return unified_compare(terms_, other.terms_);
int unified_compare(const T &a, const T &b)
Definition dict.h:205

◆ get_args()

vec_basic SymEngine::MatrixAdd::get_args ( ) const

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 28 of file matrix_add.h.

29 {
30 return vec_basic(terms_.begin(), terms_.end());
31 }
T begin(T... args)
T end(T... args)

◆ get_terms()

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

Definition at line 32 of file matrix_add.h.

33 {
34 return terms_;
35 }

◆ is_canonical()

bool SymEngine::MatrixAdd::is_canonical ( const vec_basic terms) const

Definition at line 35 of file matrix_add.cpp.

37 if (terms.size() < 2) {
38 return false;
39 }
40 size_t num_diag = 0;
41 size_t num_dense = 0;
42 for (auto term : terms) {
44 return false;
45 } else if (is_a<DiagonalMatrix>(*term)) {
46 num_diag++;
47 } else if (is_a<ImmutableDenseMatrix>(*term)) {
48 num_dense++;
49 }
50 }
51 if (num_diag > 1 || num_dense > 1) {
52 return false;
53 }
54 if (num_diag == 1 && num_dense == 1) {
55 return false;
56 }
57 return true;

Field Documentation

◆ terms_

vec_basic SymEngine::MatrixAdd::terms_

Definition at line 14 of file matrix_add.h.

◆ type_code_id

const TypeID SymEngine::MatrixAdd::type_code_id = SYMENGINE_MATRIXADD

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: