SymEngine::Gamma Class Reference
+ Inheritance diagram for SymEngine::Gamma:
+ Collaboration diagram for SymEngine::Gamma:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Gamma (const RCP< const Basic > &arg)
 Gamma Constructor.
 
bool is_canonical (const RCP< const Basic > &arg) const
 
virtual RCP< const Basiccreate (const RCP< const Basic > &arg) const
 
- Public Member Functions inherited from SymEngine::OneArgFunction
 OneArgFunction (const RCP< const Basic > &arg)
 The arg in OneArgFunction(arg) More...
 
hash_t __hash__ () const
 
RCP< const Basicget_arg () const
 
virtual vec_basic get_args () const
 Returns the list of arguments.
 
RCP< const Basiccreate (const vec_basic &b) const
 
virtual bool __eq__ (const Basic &o) const
 
virtual int compare (const Basic &o) const
 Structural equality comparator.
 
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 
 Basic ()
 Constructor.
 
 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.
 
hash_t hash () const
 
bool __neq__ (const Basic &o) const
 true if this is not equal to o. More...
 
int __cmp__ (const Basic &o) const
 Comparison operator.
 
std::string __str__ () const
 
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
 
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_GAMMA
 

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 1083 of file functions.h.

Member Function Documentation

◆ create()

RCP< const Basic > SymEngine::Gamma::create ( const RCP< const Basic > &  arg) const
virtual
Returns
Canonicalized gamma

Implements SymEngine::OneArgFunction.

Definition at line 2925 of file functions.cpp.

2926 {
2927  return gamma(arg);
2928 }
RCP< const Basic > gamma(const RCP< const Basic > &arg)
Canonicalize Gamma:
Definition: functions.cpp:2971

◆ is_canonical()

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

Definition at line 2910 of file functions.cpp.

2911 {
2912  if (is_a<Integer>(*arg))
2913  return false;
2914  if (is_a<Rational>(*arg)
2915  and (get_den(down_cast<const Rational &>(*arg).as_rational_class()))
2916  == 2) {
2917  return false;
2918  }
2919  if (is_a_Number(*arg) and not down_cast<const Number &>(*arg).is_exact()) {
2920  return false;
2921  }
2922  return true;
2923 }
bool is_a_Number(const Basic &b)
Definition: number.h:130

Field Documentation

◆ type_code_id

const TypeID SymEngine::Gamma::type_code_id = SYMENGINE_GAMMA
static

The gamma function

.. math:: \Gamma(x) := \int^{\infty}_{0} t^{x-1} e^{t} \mathrm{d}t.

The gamma function implements the function which passes through the values of the factorial function, i.e. \Gamma(n) = (n - 1)! when n is an integer. More general, \Gamma(z) is defined in the whole complex plane except at the negative integers where there are simple poles.

Type_code_id shared by all instances

Definition at line 1096 of file functions.h.


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