Inheritance diagram for SymEngine::KroneckerDelta:

Collaboration diagram for SymEngine::KroneckerDelta:

Public Member Functions
void	accept (Visitor &v) const override

void	accept (EvalRealDoubleVisitorFinal &v) const override

	KroneckerDelta (const RCP< const Basic > &i, const RCP< const Basic > &j)
	KroneckerDelta Constructor.

bool	is_canonical (const RCP< const Basic > &i, const RCP< const Basic > &j) const

RCP< const Basic >	create (const RCP< const Basic > &a, const RCP< const Basic > &b) const override

virtual RCP< const Basic >	create (const RCP< const Basic > &a, const RCP< const Basic > &b) const=0

RCP< const Basic >	create (const vec_basic &b) const

Public Member Functions inherited from SymEngine::TwoArgBasic< BaseClass >
	TwoArgBasic (const RCP< const Basic > &a, const RCP< const Basic > &b)
	`b` in `TwoArgBasic(a, b)`

hash_t	__hash__ () const override

RCP< const Basic >	get_arg1 () const

RCP< const Basic >	get_arg2 () const

vec_basic	get_args () const override

virtual RCP< const Basic >	create (const RCP< const Basic > &a, const RCP< const Basic > &b) const =0
	Method to construct classes with canonicalization.

RCP< const Basic >	create (const vec_basic &b) const

bool	__eq__ (const Basic &o) const override

int	compare (const Basic &o) const override
	Structural equality comparator.

Static Public Attributes
static const TypeID	type_code_id = SYMENGINE_KRONECKERDELTA

Detailed Description

Definition at line 986 of file functions.h.

Constructor & Destructor Documentation

◆ KroneckerDelta()

SymEngine::KroneckerDelta::KroneckerDelta	(	const RCP< const Basic > &	i,
		const RCP< const Basic > &	j
	)

KroneckerDelta Constructor.

Definition at line 2647 of file functions.cpp.

    : TwoArgFunction(i, j)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(i, j))
}

Member Function Documentation

◆ create() [1/3]

RCP< const Basic > SymEngine::KroneckerDelta::create	(	const RCP< const Basic > &	a,
		const RCP< const Basic > &	b
	)		const

overridevirtual

Returns: canonicalized KroneckerDelta

Implements SymEngine::TwoArgBasic< BaseClass >.

Definition at line 2669 of file functions.cpp.

{
    return kronecker_delta(a, b);
}

◆ create() [2/3]

virtual RCP< const Basic > SymEngine::TwoArgBasic< BaseClass >::create	(	const RCP< const Basic > &	a,
		const RCP< const Basic > &	b
	)		const

virtual

The discrete, or Kronecker, delta function. A function that takes in two integers i and j. It returns 0 if i and j are not equal or it returns 1 if i and j are equal. http://en.wikipedia.org/wiki/Kronecker_delta

Implements SymEngine::TwoArgBasic< BaseClass >.

◆ create() [3/3]

RCP< const Basic > SymEngine::TwoArgBasic< BaseClass >::create ( const vec_basic & b ) const

inline

The discrete, or Kronecker, delta function. A function that takes in two integers i and j. It returns 0 if i and j are not equal or it returns 1 if i and j are equal. http://en.wikipedia.org/wiki/Kronecker_delta

Definition at line 108 of file functions.h.

    {
        SYMENGINE_ASSERT(b.size() == 2);
        return create(b[0], b[1]);
    }

◆ is_canonical()

bool SymEngine::KroneckerDelta::is_canonical	(	const RCP< const Basic > &	i,
		const RCP< const Basic > &	j
	)		const

Returns: true if canonical

Definition at line 2655 of file functions.cpp.

{
    RCP<const Basic> diff = expand(sub(i, j));
    if (eq(*diff, *zero)) {
        return false;
    } else if (is_a_Number(*diff)) {
        return false;
    } else {
        // TODO: SymPy uses default key sorting to return in order
        return true;
    }
}

Field Documentation

◆ type_code_id

const TypeID SymEngine::KroneckerDelta::type_code_id = SYMENGINE_KRONECKERDELTA

static

Type_code_id shared by all instances

Definition at line 996 of file functions.h.

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

/home/runner/work/symengine/symengine/symengine/functions.h
/home/runner/work/symengine/symengine/symengine/functions.cpp

Public Member Functions

Static Public Attributes