SymEngine::Zeta Class Reference

Inheritance diagram for SymEngine::Zeta:

Collaboration diagram for SymEngine::Zeta:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Zeta (const RCP< const Basic > &s, const RCP< const Basic > &a)
	Zeta Constructor.
	Zeta (const RCP< const Basic > &s)
	Zeta Constructor.
RCP< const Basic >	get_s () const
RCP< const Basic >	get_a () const
bool	is_canonical (const RCP< const Basic > &s, const RCP< const Basic > &a) 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
	Method to construct classes with canonicalization.
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
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_ZETA

Detailed Description

Definition at line 569 of file functions.h.

Constructor & Destructor Documentation

Zeta() [1/2]

SymEngine::Zeta::Zeta	(	const RCP< const Basic > &	s,
		const RCP< const Basic > &	a
	)

Zeta Constructor.

Definition at line 2768 of file functions.cpp.

    : TwoArgFunction(s, a){SYMENGINE_ASSIGN_TYPEID()
                               SYMENGINE_ASSERT(is_canonical(s, a))}

Zeta() [2/2]

SymEngine::Zeta::Zeta

(

const RCP< const Basic > &

s

)

Zeta Constructor.

Definition at line 2772 of file functions.cpp.

    : TwoArgFunction(s, one)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(s, one))
}

Member Function Documentation

create() [1/3]

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

overridevirtual

Returns

canonicalized zeta

Implements SymEngine::TwoArgBasic< BaseClass >.

Definition at line 2794 of file functions.cpp.

{
    return zeta(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

Method to construct classes with canonicalization.

Implements SymEngine::TwoArgBasic< BaseClass >.

create() [3/3]

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

inline

Definition at line 108 of file functions.h.

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

get_a()

RCP< const Basic > SymEngine::Zeta::get_a ( ) const

inline

Returns

a_

Definition at line 595 of file functions.h.

    {
        return get_arg2();
    }

get_s()

RCP< const Basic > SymEngine::Zeta::get_s ( ) const

inline

Returns

s_

Definition at line 590 of file functions.h.

    {
        return get_arg1();
    }

is_canonical()

bool SymEngine::Zeta::is_canonical	(	const RCP< const Basic > &	s,
		const RCP< const Basic > &	a
	)		const

Returns

true if canonical

Definition at line 2779 of file functions.cpp.

{
    if (eq(*s, *zero))
        return false;
    if (eq(*s, *one))
        return false;
    if (is_a<Integer>(*s) and is_a<Integer>(*a)) {
        auto s_ = down_cast<const Integer &>(*s).as_int();
        if (s_ < 0 || s_ % 2 == 0)
            return false;
    }
    return true;
}

Field Documentation

type_code_id

const TypeID SymEngine::Zeta::type_code_id = SYMENGINE_ZETA

static

Type_code_id shared by all instances

Definition at line 584 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