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

Public Member Functions

virtual void accept (Visitor &v) const
 
virtual void accept (EvalRealDoubleVisitorFinal &v) const
 
 Tanh (const RCP< const Basic > &arg)
 Tanh Constructor. More...
 
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::HyperbolicFunction
 HyperbolicFunction (RCP< const Basic > arg)
 Constructor. More...
 
- Public Member Functions inherited from SymEngine::HyperbolicBase
 HyperbolicBase (RCP< const Basic > arg)
 Constructor. 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_TANH
 The hyperbolic tangent function, \frac{\sinh(x)}{\cosh(x)}. More...
 

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 858 of file functions.h.

Constructor & Destructor Documentation

◆ Tanh()

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

Tanh Constructor.

Definition at line 2268 of file functions.cpp.

2268 : HyperbolicFunction(arg)
2269{
2270 SYMENGINE_ASSIGN_TYPEID()
2271 SYMENGINE_ASSERT(is_canonical(arg))
2272}
HyperbolicFunction(RCP< const Basic > arg)
Constructor.
Definition: functions.h:784
bool is_canonical(const RCP< const Basic > &arg) const
Definition: functions.cpp:2274

Member Function Documentation

◆ accept() [1/2]

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

Implements SymEngine::Basic.

◆ accept() [2/2]

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

Implements SymEngine::Basic.

◆ create()

RCP< const Basic > SymEngine::Tanh::create ( const RCP< const Basic > &  arg) const
virtual
Returns
Canonicalized tanh

Implements SymEngine::OneArgFunction.

Definition at line 2607 of file functions.cpp.

2608{
2609 return tanh(arg);
2610}
RCP< const Basic > tanh(const RCP< const Basic > &arg)
Canonicalize Tanh:
Definition: functions.cpp:2290

◆ is_canonical()

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

Definition at line 2274 of file functions.cpp.

2275{
2276 if (eq(*arg, *zero))
2277 return false;
2278 if (is_a_Number(*arg)) {
2279 if (down_cast<const Number &>(*arg).is_negative()) {
2280 return false;
2281 } else if (not down_cast<const Number &>(*arg).is_exact()) {
2282 return false;
2283 }
2284 }
2285 if (could_extract_minus(*arg))
2286 return false;
2287 return true;
2288}
bool is_a_Number(const Basic &b)
Definition: number.h:130
bool eq(const Basic &a, const Basic &b)
Checks equality for a and b
Definition: basic-inl.h:21
bool could_extract_minus(const Basic &arg)
Definition: functions.cpp:325

Field Documentation

◆ type_code_id

const TypeID SymEngine::Tanh::type_code_id = SYMENGINE_TANH
static

The hyperbolic tangent function, \frac{\sinh(x)}{\cosh(x)}.

Type_code_id shared by all instances

Definition at line 862 of file functions.h.


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