SymEngine::ConjugateMatrix Class Reference

Inheritance diagram for SymEngine::ConjugateMatrix:

Collaboration diagram for SymEngine::ConjugateMatrix:

Public Member Functions
	ConjugateMatrix (const RCP< const MatrixExpr > &arg)
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 RCP< const MatrixExpr > &arg) const
vec_basic	get_args () const override
	Returns the list of arguments.
RCP< const MatrixExpr >	get_arg () 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_CONJUGATEMATRIX

Private Attributes
RCP< const MatrixExpr >	arg_

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

Constructor & Destructor Documentation

ConjugateMatrix()

SymEngine::ConjugateMatrix::ConjugateMatrix ( const RCP< const MatrixExpr > &  arg )

inline

Definition at line 16 of file conjugate_matrix.h.

                                                      : arg_(arg)
    {
        SYMENGINE_ASSIGN_TYPEID();
        SYMENGINE_ASSERT(is_canonical(arg));
    }

Member Function Documentation

__eq__()

bool SymEngine::ConjugateMatrix::__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 conjugate_matrix.cpp.

{
    return (is_a<ConjugateMatrix>(o)
            && arg_->__eq__(*down_cast<const ConjugateMatrix &>(o).arg_));
}

__hash__()

hash_t SymEngine::ConjugateMatrix::__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 conjugate_matrix.cpp.

{
    hash_t seed = SYMENGINE_CONJUGATEMATRIX;
    hash_combine<Basic>(seed, *arg_);
    return seed;
}

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

compare()

int SymEngine::ConjugateMatrix::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 35 of file conjugate_matrix.cpp.

{
    SYMENGINE_ASSERT(is_a<ConjugateMatrix>(o));
 
    return arg_->compare(*down_cast<const ConjugateMatrix &>(o).arg_);
}

get_arg()

RCP< const MatrixExpr > SymEngine::ConjugateMatrix::get_arg ( ) const

inline

Definition at line 29 of file conjugate_matrix.h.

    {
        return arg_;
    }

get_args()

vec_basic SymEngine::ConjugateMatrix::get_args ( ) const

overridevirtual

Returns the list of arguments.

Implements SymEngine::Basic.

Definition at line 42 of file conjugate_matrix.cpp.

{
    return {arg_};
}

is_canonical()

bool SymEngine::ConjugateMatrix::is_canonical

(

const RCP< const MatrixExpr > &

arg

)

const

Definition at line 22 of file conjugate_matrix.cpp.

{
    // NOTE: For conjugate transpose always have the conjugate operation first
    // i.e. transpose(conjugate(A))
    if (is_a<IdentityMatrix>(*arg) || is_a<ZeroMatrix>(*arg)
        || is_a<DiagonalMatrix>(*arg) || is_a<ImmutableDenseMatrix>(*arg)
        || is_a<ConjugateMatrix>(*arg) || is_a<Transpose>(*arg)
        || is_a<MatrixAdd>(*arg) || is_a<HadamardProduct>(*arg)) {
        return false;
    }
    return true;
}

Field Documentation

arg_

RCP<const MatrixExpr> SymEngine::ConjugateMatrix::arg_

private

Definition at line 13 of file conjugate_matrix.h.

type_code_id

const TypeID SymEngine::ConjugateMatrix::type_code_id = SYMENGINE_CONJUGATEMATRIX

static

Type_code_id shared by all instances

Definition at line 22 of file conjugate_matrix.h.

---

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

• /home/runner/work/symengine/symengine/symengine/matrices/conjugate_matrix.h
• /home/runner/work/symengine/symengine/symengine/matrices/conjugate_matrix.cpp