SymEngine::Tanh Class Reference

Inheritance diagram for SymEngine::Tanh:

Collaboration diagram for SymEngine::Tanh:

Public Member Functions
void	accept (Visitor &v) const override
void	accept (EvalRealDoubleVisitorFinal &v) const override
	Tanh (const RCP< const Basic > &arg)
	Tanh 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::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)
hash_t	__hash__ () const override
RCP< const Basic >	get_arg () const
vec_basic	get_args () const override
	Returns the list of arguments.
virtual RCP< const Basic >	create (const RCP< const Basic > &arg) const =0
	Method to construct classes with canonicalization.
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.
virtual hash_t	__hash__ () const =0
hash_t	hash () const
virtual bool	__eq__ (const Basic &o) const =0
	Test equality.
bool	__neq__ (const Basic &o) const
	true if this is not equal to o.
int	__cmp__ (const Basic &o) const
	Comparison operator.
virtual int	compare (const Basic &o) const =0
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
virtual vec_basic	get_args () const =0
	Returns the list of arguments.
virtual void	accept (Visitor &v) const =0
virtual void	accept (EvalRealDoubleVisitorFinal &v) const =0
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_TANH
	The hyperbolic tangent function, \frac{\sinh(x)}{\cosh(x)}.

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 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.

                                      : HyperbolicFunction(arg)
{
    SYMENGINE_ASSIGN_TYPEID()
    SYMENGINE_ASSERT(is_canonical(arg))
}

Member Function Documentation

accept() [1/2]

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

overridevirtual

Implements SymEngine::Basic.

accept() [2/2]

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

overridevirtual

Implements SymEngine::Basic.

create()

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

overridevirtual

Returns

Canonicalized tanh

Implements SymEngine::OneArgFunction.

Definition at line 2607 of file functions.cpp.

{
    return tanh(arg);
}

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.

{
    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::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:

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