Inheritance diagram for SymEngine::ZeroMatrix:

Collaboration diagram for SymEngine::ZeroMatrix:

Public Member Functions
	ZeroMatrix (const RCP< const Basic > &m, 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 > &m, const RCP< const Basic > &n) const

const RCP< const Basic > &	nrows () const

const RCP< const Basic > &	ncols () 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.

virtual hash_t	__hash__ () const =0

hash_t	hash () const

virtual bool	__eq__ (const Basic &o) const =0
	Test equality.

bool	__neq__ (const Basic &o) const
	true if `this` is not equal to `o`.

int	__cmp__ (const Basic &o) const
	Comparison operator.

virtual int	compare (const Basic &o) const =0

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

virtual vec_basic	get_args () const =0
	Returns the list of arguments.

virtual void	accept (Visitor &v) const =0

virtual void	accept (EvalRealDoubleVisitorFinal &v) const =0

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_ZEROMATRIX

Private Attributes
RCP< const Basic >	m_

RCP< const Basic >	n_

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

Constructor & Destructor Documentation

◆ ZeroMatrix()

SymEngine::ZeroMatrix::ZeroMatrix	(	const RCP< const Basic > &	m,
		const RCP< const Basic > &	n
	)

inline

Definition at line 16 of file zero_matrix.h.

        : m_(m), n_(n)
    {
        SYMENGINE_ASSIGN_TYPEID();
        SYMENGINE_ASSERT(is_canonical(m, n));
    }

Member Function Documentation

◆ eq()

bool SymEngine::ZeroMatrix::__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 16 of file zero_matrix.cpp.

{
    return (is_a<ZeroMatrix>(o)
            && m_->__eq__(*down_cast<const ZeroMatrix &>(o).m_)
            && n_->__eq__(*down_cast<const ZeroMatrix &>(o).n_));
}

◆ hash()

hash_t SymEngine::ZeroMatrix::__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 8 of file zero_matrix.cpp.

{
    hash_t seed = SYMENGINE_ZEROMATRIX;
    hash_combine<Basic>(seed, *m_);
    hash_combine<Basic>(seed, *n_);
    return seed;
}

◆ accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

◆ accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

◆ compare()

int SymEngine::ZeroMatrix::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 23 of file zero_matrix.cpp.

{
    SYMENGINE_ASSERT(is_a<ZeroMatrix>(o));
 
    const ZeroMatrix &other = down_cast<const ZeroMatrix &>(o);
    auto temp = m_->compare(*(other.m_));
    if (temp != 0) {
        return temp;
    } else {
        return n_->compare(*(other.n_));
    }
}

◆ get_args()

vec_basic SymEngine::ZeroMatrix::get_args ( ) const

overridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 36 of file zero_matrix.cpp.

{
    return {m_, n_};
}

◆ is_canonical()

bool SymEngine::ZeroMatrix::is_canonical	(	const RCP< const Basic > &	m,
		const RCP< const Basic > &	n
	)		const

Definition at line 41 of file zero_matrix.cpp.

{
    if (is_a_Number(*m)) {
        if (is_a<Integer>(*m)) {
            if (down_cast<const Integer &>(*m).is_negative()) {
                return false;
            }
        } else {
            return false;
        }
    }
    if (is_a_Number(*n)) {
        if (is_a<Integer>(*n)) {
            if (down_cast<const Integer &>(*n).is_negative()) {
                return false;
            }
        } else {
            return false;
        }
    }
    return true;
}

◆ ncols()

const RCP< const Basic > & SymEngine::ZeroMatrix::ncols ( ) const

inline

Definition at line 36 of file zero_matrix.h.

    {
        return n_;
    }

◆ nrows()

const RCP< const Basic > & SymEngine::ZeroMatrix::nrows ( ) const

inline

Definition at line 31 of file zero_matrix.h.

    {
        return m_;
    }

Field Documentation

◆ m_

RCP<const Basic> SymEngine::ZeroMatrix::m_

private

Definition at line 13 of file zero_matrix.h.

◆ n_

RCP<const Basic> SymEngine::ZeroMatrix::n_

private

Definition at line 13 of file zero_matrix.h.

◆ type_code_id

const TypeID SymEngine::ZeroMatrix::type_code_id = SYMENGINE_ZEROMATRIX

static

Type_code_id shared by all instances

Definition at line 23 of file zero_matrix.h.

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

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

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZeroMatrix()

Member Function Documentation

◆ __eq__()

◆ __hash__()

◆ accept() [1/2]

◆ accept() [2/2]

◆ compare()

◆ get_args()

◆ is_canonical()

◆ ncols()

◆ nrows()

Field Documentation

◆ m_

◆ n_

◆ type_code_id

◆ eq()

◆ hash()