No Matches
SymEngine::LogGamma Class Reference
+ Inheritance diagram for SymEngine::LogGamma:
+ Collaboration diagram for SymEngine::LogGamma:

Public Member Functions

void accept (Visitor &v) const override
void accept (EvalRealDoubleVisitorFinal &v) const override
 LogGamma (const RCP< const Basic > &arg)
 LogGamma Constructor.
bool is_canonical (const RCP< const Basic > &arg) const
RCP< const Basicrewrite_as_gamma () const
RCP< const Basiccreate (const RCP< const Basic > &arg) const override
- Public Member Functions inherited from SymEngine::OneArgFunction
 OneArgFunction (const RCP< const Basic > &arg)
 The arg in OneArgFunction(arg)
hash_t __hash__ () const override
RCP< const Basicget_arg () const
vec_basic get_args () const override
 Returns the list of arguments.
virtual RCP< const Basiccreate (const RCP< const Basic > &arg) const =0
 Method to construct classes with canonicalization.
RCP< const Basiccreate (const vec_basic &b) const
bool __eq__ (const Basic &o) const override
int compare (const Basic &o) const override
 Structural equality comparator.
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 Basic ()
 Basic (const Basic &)=delete
 Delete the copy constructor and assignment.
Basicoperator= (const Basic &)=delete
 Assignment operator in continuation with above.
 Basic (Basic &&)=delete
 Delete the move constructor and assignment.
Basicoperator= (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 Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'.
RCP< const Basicxreplace (const map_basic_basic &subs_dict) const
virtual RCP< const Basicexpand_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 Basicdiff (const RCP< const Symbol > &x, bool cache=true) const
- Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basicrcp_from_this ()
 Get RCP<T> pointer to self (it will cast the pointer to T)
RCP< const Basicrcp_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_LOGGAMMA

Additional Inherited Members

- Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basicloads (const std::string &)
 Creates an instance of a serialized string.
- Data Fields inherited from SymEngine::Basic
TypeID type_code_

Detailed Description

Definition at line 1148 of file functions.h.

Constructor & Destructor Documentation

◆ LogGamma()

SymEngine::LogGamma::LogGamma ( const RCP< const Basic > &  arg)

LogGamma Constructor.

Definition at line 1157 of file functions.h.

1157 : OneArgFunction(arg)
1158 {
1160 SYMENGINE_ASSERT(is_canonical(arg))
1161 }
bool is_canonical(const RCP< const Basic > &arg) const
Definition: functions.cpp:3201
OneArgFunction(const RCP< const Basic > &arg)
The arg in OneArgFunction(arg)
Definition: functions.h:27

Member Function Documentation

◆ accept() [1/2]

void SymEngine::LogGamma::accept ( EvalRealDoubleVisitorFinal v) const

Implements SymEngine::Basic.

◆ accept() [2/2]

void SymEngine::LogGamma::accept ( Visitor v) const

Implements SymEngine::Basic.

◆ create()

RCP< const Basic > SymEngine::LogGamma::create ( const RCP< const Basic > &  arg) const
canonicalized loggamma

Implements SymEngine::OneArgFunction.

Definition at line 3221 of file functions.cpp.

3223 return loggamma(arg);
RCP< const Basic > loggamma(const RCP< const Basic > &arg)
Canonicalize LogGamma:
Definition: functions.cpp:3226

◆ is_canonical()

bool SymEngine::LogGamma::is_canonical ( const RCP< const Basic > &  arg) const
true if canonical

Definition at line 3201 of file functions.cpp.

3203 if (is_a<Integer>(*arg)) {
3204 RCP<const Integer> arg_int = rcp_static_cast<const Integer>(arg);
3205 if (not arg_int->is_positive()) {
3206 return false;
3207 }
3208 if (eq(*integer(1), *arg_int) or eq(*integer(2), *arg_int)
3209 or eq(*integer(3), *arg_int)) {
3210 return false;
3211 }
3212 }
3213 return true;
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21
std::enable_if< std::is_integral< T >::value, RCP< constInteger > >::type integer(T i)
Definition: integer.h:197

◆ rewrite_as_gamma()

RCP< const Basic > SymEngine::LogGamma::rewrite_as_gamma ( ) const

Definition at line 3216 of file functions.cpp.

3218 return log(gamma(get_arg()));
RCP< const Basic > get_arg() const
Definition: functions.h:36
RCP< const Basic > gamma(const RCP< const Basic > &arg)
Canonicalize Gamma:
Definition: functions.cpp:3014
RCP< const Basic > log(const RCP< const Basic > &arg)
Returns the Natural Logarithm from argument arg
Definition: functions.cpp:1774

Field Documentation

◆ type_code_id

const TypeID SymEngine::LogGamma::type_code_id = SYMENGINE_LOGGAMMA

The loggamma function The loggamma function implements the logarithm of the gamma function i.e, \log\Gamma(x).

Type_code_id shared by all instances

Definition at line 1155 of file functions.h.

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