Loading...
Searching...
No Matches
SymEngine::Primorial Class Reference
+ Inheritance diagram for SymEngine::Primorial:
+ Collaboration diagram for SymEngine::Primorial:

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Primorial (const RCP< const Basic > &arg)
 
bool is_canonical (const RCP< const Basic > &arg) const
 
RCP< const Basiccreate (const RCP< const Basic > &arg) const
 Method to construct classes with canonicalization. More...
 
- 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. More...
 
virtual RCP< const Basiccreate (const RCP< const Basic > &arg) const =0
 Method to construct classes with canonicalization. More...
 
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. More...
 
- Public Member Functions inherited from SymEngine::Basic
TypeID get_type_code () const
 
 Basic ()
 Constructor. More...
 
 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. More...
 
bool __neq__ (const Basic &o) const
 true if this is not equal to o. More...
 
int __cmp__ (const Basic &o) const
 Comparison operator. More...
 
virtual int compare (const Basic &o) const =0
 
std::string __str__ () const
 
std::string dumps () const
 Returns a string of the instance serialized. More...
 
RCP< const Basicsubs (const map_basic_basic &subs_dict) const
 Substitutes 'subs_dict' into 'self'. More...
 
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 More...
 
virtual vec_basic get_args () const =0
 Returns the list of arguments. More...
 
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) More...
 
RCP< const Basicrcp_from_this () const
 Get RCP<const T> pointer to self (it will cast the pointer to const T) More...
 
RCP< const T2 > rcp_from_this_cast () const
 Get RCP<T2> pointer to self (it will cast the pointer to T2) More...
 
unsigned int use_count () const
 

Static Public Attributes

static const TypeID type_code_id = SYMENGINE_PRIMORIAL
 

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. More...
 
- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 31 of file ntheory_funcs.h.

Constructor & Destructor Documentation

◆ Primorial()

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

Definition at line 59 of file ntheory_funcs.cpp.

59 : OneArgFunction(arg)
60{
61 SYMENGINE_ASSIGN_TYPEID()
62 SYMENGINE_ASSERT(is_canonical(arg))
63}
OneArgFunction(const RCP< const Basic > &arg)
The arg in OneArgFunction(arg)
Definition: functions.h:27

Member Function Documentation

◆ accept() [1/2]

virtual void SymEngine::Primorial::accept ( EvalRealDoubleVisitorFinal v) const
virtual

Implements SymEngine::Basic.

◆ accept() [2/2]

virtual void SymEngine::Primorial::accept ( Visitor v) const
virtual

Implements SymEngine::Basic.

◆ create()

RCP< const Basic > SymEngine::Primorial::create ( const RCP< const Basic > &  arg) const
virtual

Method to construct classes with canonicalization.

Implements SymEngine::OneArgFunction.

Definition at line 74 of file ntheory_funcs.cpp.

75{
76 return primorial(arg);
77}

◆ is_canonical()

bool SymEngine::Primorial::is_canonical ( const RCP< const Basic > &  arg) const

Definition at line 65 of file ntheory_funcs.cpp.

66{
67 if (is_a_Number(*arg) or is_a<Constant>(*arg)) {
68 return false;
69 } else {
70 return true;
71 }
72}
bool is_a_Number(const Basic &b)
Definition: number.h:130

Field Documentation

◆ type_code_id

const TypeID SymEngine::Primorial::type_code_id = SYMENGINE_PRIMORIAL
static

The primorial of n (n#) The product all primes up to n https://en.wikipedia.org/wiki/Primorial

Type_code_id shared by all instances

Definition at line 39 of file ntheory_funcs.h.


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