Inheritance diagram for SymEngine::DiagonalMatrix:

Collaboration diagram for SymEngine::DiagonalMatrix:

Public Member Functions
	DiagonalMatrix (const vec_basic &container)

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 &container) const

vec_basic	get_args () const override
	Returns the list of arguments.

const vec_basic &	get_container () const

RCP< const Basic >	get (size_t i) 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_DIAGONALMATRIX

Private Attributes
vec_basic	diag_

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

Constructor & Destructor Documentation

◆ DiagonalMatrix()

SymEngine::DiagonalMatrix::DiagonalMatrix ( const vec_basic & container )

inline

Definition at line 16 of file diagonal_matrix.h.

                                               : diag_(container)
    {
        SYMENGINE_ASSIGN_TYPEID();
        SYMENGINE_ASSERT(is_canonical(container));
    }

Member Function Documentation

◆ eq()

bool SymEngine::DiagonalMatrix::__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 17 of file diagonal_matrix.cpp.

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

◆ hash()

hash_t SymEngine::DiagonalMatrix::__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 9 of file diagonal_matrix.cpp.

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

◆ accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

◆ accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

◆ compare()

int SymEngine::DiagonalMatrix::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 26 of file diagonal_matrix.cpp.

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

◆ get()

RCP< const Basic > SymEngine::DiagonalMatrix::get ( size_t i ) const

inline

Definition at line 38 of file diagonal_matrix.h.

    {
        return diag_[i];
    }

◆ get_args()

vec_basic SymEngine::DiagonalMatrix::get_args ( ) const

inlineoverridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 28 of file diagonal_matrix.h.

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

◆ get_container()

const vec_basic & SymEngine::DiagonalMatrix::get_container ( ) const

inline

Definition at line 33 of file diagonal_matrix.h.

    {
        return diag_;
    }

◆ is_canonical()

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

Definition at line 53 of file diagonal_matrix.cpp.

{
    if (container.size() == 0) {
        return false;
    }
    if (is_zero_vec(container)) {
        return false;
    }
    if (is_identity_vec(container)) {
        return false;
    }
    return true;
}

Field Documentation

◆ diag_

vec_basic SymEngine::DiagonalMatrix::diag_

private

Definition at line 13 of file diagonal_matrix.h.

◆ type_code_id

const TypeID SymEngine::DiagonalMatrix::type_code_id = SYMENGINE_DIAGONALMATRIX

static

Type_code_id shared by all instances

Definition at line 22 of file diagonal_matrix.h.

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

/home/runner/work/symengine/symengine/symengine/matrices/diagonal_matrix.h
/home/runner/work/symengine/symengine/symengine/matrices/diagonal_matrix.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DiagonalMatrix()

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ accept() [1/2]

◆ accept() [2/2]

◆ compare()

◆ get()

◆ get_args()

◆ get_container()

◆ is_canonical()

Field Documentation

◆ diag_

◆ type_code_id

◆ eq()

◆ hash()