Loading...
Searching...
No Matches
SymEngine::IdentityMatrix Class Reference
+ Inheritance diagram for SymEngine::IdentityMatrix:
+ Collaboration diagram for SymEngine::IdentityMatrix:

Public Member Functions

 IdentityMatrix (const RCP< const Basic > &n)
 
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
 
vec_basic get_args () const override
 Returns the list of arguments.
 
bool is_canonical (const RCP< const Basic > &n) const
 
const RCP< const Basic > & size () 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.
 
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_IDENTITYMATRIX
 

Private Attributes

RCP< const Basicn_
 

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 identity_matrix.h.

Constructor & Destructor Documentation

◆ IdentityMatrix()

SymEngine::IdentityMatrix::IdentityMatrix ( const RCP< const Basic > &  n)
inline

Definition at line 16 of file identity_matrix.h.

16 : n_(n)
17 {
18 SYMENGINE_ASSIGN_TYPEID();
19 SYMENGINE_ASSERT(is_canonical(n));
20 }

Member Function Documentation

◆ __eq__()

bool SymEngine::IdentityMatrix::__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
oa constant reference to object to test against
Returns
True if this is equal to o

Implements SymEngine::Basic.

Definition at line 15 of file identity_matrix.cpp.

16{
17 return (is_a<IdentityMatrix>(o)
18 && n_->__eq__(*down_cast<const IdentityMatrix &>(o).n_));
19}
void hash_combine(hash_t &seed, const T &v)
Definition basic-inl.h:95

◆ __hash__()

hash_t SymEngine::IdentityMatrix::__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 identity_matrix.cpp.

11{
12 return n_->__hash__();
13}

◆ accept() [1/2]

void SymEngine::IdentityMatrix::accept ( EvalRealDoubleVisitorFinal v) const
overridevirtual

Implements SymEngine::Basic.

◆ accept() [2/2]

void SymEngine::IdentityMatrix::accept ( Visitor v) const
overridevirtual

Implements SymEngine::Basic.

◆ compare()

int SymEngine::IdentityMatrix::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 21 of file identity_matrix.cpp.

22{
23 SYMENGINE_ASSERT(is_a<IdentityMatrix>(o));
24
25 return n_->compare(*down_cast<const IdentityMatrix &>(o).n_);
26}

◆ get_args()

vec_basic SymEngine::IdentityMatrix::get_args ( ) const
overridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 28 of file identity_matrix.cpp.

29{
30 return {n_};
31}

◆ is_canonical()

bool SymEngine::IdentityMatrix::is_canonical ( const RCP< const Basic > &  n) const

Definition at line 33 of file identity_matrix.cpp.

34{
35 if (is_a_Number(*n)) {
36 if (is_a<Integer>(*n)) {
37 if (down_cast<const Integer &>(*n).is_negative()) {
38 return false;
39 }
40 } else {
41 return false;
42 }
43 }
44 return true;
45}
bool is_a_Number(const Basic &b)
Definition number.h:130

◆ size()

const RCP< const Basic > & SymEngine::IdentityMatrix::size ( ) const
inline

Definition at line 29 of file identity_matrix.h.

30 {
31 return n_;
32 }

Field Documentation

◆ n_

RCP<const Basic> SymEngine::IdentityMatrix::n_
private

Definition at line 13 of file identity_matrix.h.

◆ type_code_id

const TypeID SymEngine::IdentityMatrix::type_code_id = SYMENGINE_IDENTITYMATRIX
static

Type_code_id shared by all instances

Definition at line 22 of file identity_matrix.h.


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