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

Public Member Functions

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

Additional Inherited Members

- Data Fields inherited from SymEngine::Basic
TypeID type_code_
 

Detailed Description

Definition at line 874 of file functions.h.

Member Function Documentation

◆ create()

RCP< const Basic > SymEngine::Coth::create ( const RCP< const Basic > &  arg) const
virtual
Returns
Canonicalized coth

Implements SymEngine::OneArgFunction.

Definition at line 2569 of file functions.cpp.

2570 {
2571  return coth(arg);
2572 }
RCP< const Basic > coth(const RCP< const Basic > &arg)
Canonicalize Coth:
Definition: functions.cpp:2290

◆ is_canonical()

bool SymEngine::Coth::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:282

Field Documentation

◆ type_code_id

const TypeID SymEngine::Coth::type_code_id = SYMENGINE_COTH
static

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

Type_code_id shared by all instances

Definition at line 878 of file functions.h.


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