Inheritance diagram for SymEngine::ATanh:

Collaboration diagram for SymEngine::ATanh:

Public Member Functions
void	accept (Visitor &v) const override

void	accept (EvalRealDoubleVisitorFinal &v) const override

	ATanh (const RCP< const Basic > &arg)
	ATanh Constructor.

bool	is_canonical (const RCP< const Basic > &arg) const

RCP< const Basic >	create (const RCP< const Basic > &arg) const override

Public Member Functions inherited from SymEngine::InverseHyperbolicFunction
	InverseHyperbolicFunction (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 override

RCP< const Basic >	get_arg () const

vec_basic	get_args () const override
	Returns the list of arguments.

RCP< const Basic >	create (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 ()
	Constructor.

	Basic (const Basic &)=delete
	Delete the copy constructor and assignment.

Basic &	operator= (const Basic &)=delete
	Assignment operator in continuation with above.

	Basic (Basic &&)=delete
	Delete the move constructor and assignment.

Basic &	operator= (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

std::string	dumps () const
	Returns a string of the instance serialized.

RCP< const Basic >	subs (const map_basic_basic &subs_dict) const
	Substitutes 'subs_dict' into 'self'.

RCP< const Basic >	xreplace (const map_basic_basic &subs_dict) const

virtual RCP< const Basic >	expand_as_exp () const
	expands the special function in terms of exp function

RCP< const Basic >	diff (const RCP< const Symbol > &x, bool cache=true) const

Public Member Functions inherited from SymEngine::EnableRCPFromThis< Basic >
RCP< Basic >	rcp_from_this ()
	Get RCP<T> pointer to self (it will cast the pointer to T)

RCP< const Basic >	rcp_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_ATANH
	The inverse hyperbolic tangent function. More...

Additional Inherited Members
Static Public Member Functions inherited from SymEngine::Basic
static RCP< const Basic >	loads (const std::string &)
	Creates an instance of a serialized string.

Data Fields inherited from SymEngine::Basic
TypeID	type_code_

Detailed Description

Definition at line 938 of file functions.h.

Member Function Documentation

◆ create()

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

overridevirtual

Returns: Canonicalized atanh

Implements SymEngine::OneArgFunction.

Definition at line 2632 of file functions.cpp.

 {
     return atanh(arg);
 }

◆ is_canonical()

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

Returns: true if canonical

Definition at line 2478 of file functions.cpp.

 {
     if (eq(*arg, *zero))
         return false;
     if (is_a_Number(*arg)) {
         if (down_cast<const Number &>(*arg).is_negative()) {
             return false;
         } else if (not down_cast<const Number &>(*arg).is_exact()) {
             return false;
         }
     }
     if (could_extract_minus(*arg))
         return false;
     return true;
 }

Field Documentation

◆ type_code_id

const TypeID SymEngine::ATanh::type_code_id = SYMENGINE_ATANH

static

The inverse hyperbolic tangent function.

Type_code_id shared by all instances

Definition at line 942 of file functions.h.

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

/home/runner/work/symengine/symengine/symengine/functions.h
/home/runner/work/symengine/symengine/symengine/functions.cpp

Public Member Functions