SymEngine::MatrixSymbol Class Reference
+ Inheritance diagram for SymEngine::MatrixSymbol:
+ Collaboration diagram for SymEngine::MatrixSymbol:

Public Member Functions

 MatrixSymbol (const std::string &name)
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. More...
int compare (const Basic &o) const override
const std::stringget_name () const
vec_basic get_args () const override
 Returns the list of arguments.
- 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. More...
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_MATRIXSYMBOL

Private Attributes

std::string name_

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 10 of file matrix_symbol.h.

Member Function Documentation

◆ __eq__()

bool SymEngine::MatrixSymbol::__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 13 of file matrix_symbol.cpp.

14 {
15  return (is_a<MatrixSymbol>(o)
16  && name_ == down_cast<const MatrixSymbol &>(o).name_);
17 }

◆ __hash__()

hash_t SymEngine::MatrixSymbol::__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 6 of file matrix_symbol.cpp.

7 {
9  hash_combine(seed, name_);
10  return seed;
11 }
void hash_combine(hash_t &seed, const T &v)
Definition: basic-inl.h:95

◆ compare()

int SymEngine::MatrixSymbol::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 19 of file matrix_symbol.cpp.

20 {
21  SYMENGINE_ASSERT(is_a<MatrixSymbol>(o));
23  const MatrixSymbol &s = down_cast<const MatrixSymbol &>(o);
24  if (name_ == s.name_)
25  return 0;
26  return name_ < s.name_ ? -1 : 1;
27 }

Field Documentation

◆ type_code_id

const TypeID SymEngine::MatrixSymbol::type_code_id = SYMENGINE_MATRIXSYMBOL

Type_code_id shared by all instances

Definition at line 21 of file matrix_symbol.h.

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