Package functions.unitary.trig.normal

Class Tanh

Object

GeneralFunction

UnitaryFunction

GeneralTrigFunction

TrigFunction

Tanh

All Implemented Interfaces:

Differentiable, Evaluable, Integrable, Invertible, Outputable, Simplifiable, Comparable<GeneralFunction>, Iterable<GeneralFunction>

public class Tanh
extends TrigFunction

Field Summary

Fields inherited from class UnitaryFunction

operand

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Tanh(GeneralFunction operand)	Constructs a new Tanh

Method Summary

Modifier and Type	Method	Description
double	evaluate(Map<String,Double> variableValues)	Returns the hyperbolic tangent of the stored UnitaryFunction.operand evaluated
GeneralFunction	getDerivative(String varID)	Returns the derivative of a GeneralFunction with respect to a variable.
GeneralFunction	getElementaryIntegral()	Returns the elementary integral of the function.
UnitaryFunction	getInstance(GeneralFunction operand)	Returns a new instance of this UnitaryFunction
Class<?>	getInverse()	Returns the Class corresponding to the inverse of this function
GeneralFunction	simplifyInverse()	If UnitaryFunction.operand is an instance of the inverse of this function, returns operand.operand

Methods inherited from class TrigFunction

toOutputFunction

Methods inherited from class UnitaryFunction

clone, compareSelf, equalsFunction, hashCode, iterator, newInstanceOf, simplify, simplifyFOC, simplifyInternal, substituteAll, toString

Methods inherited from class GeneralFunction

compareTo, derivativeAt, equals, equalsSimplified, getNthDerivative, getSimplifiedDerivative, substituteVariables

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

Tanh

public Tanh(GeneralFunction operand)

Constructs a new Tanh

Parameters:

operand - The function which tanh is operating on

Method Details

evaluate

public double evaluate(Map<String,Double> variableValues)

Returns the hyperbolic tangent of the stored UnitaryFunction.operand evaluated

Parameters:

variableValues - The values of the variables of the GeneralFunction at the point

Returns:

the tanh of UnitaryFunction.operand evaluated

getDerivative

public GeneralFunction getDerivative(String varID)

Description copied from interface: Differentiable

Returns the derivative of a GeneralFunction with respect to a variable. Should not be used in general; GeneralFunction.getSimplifiedDerivative(java.lang.String) is strongly preferred.

Parameters:

varID - the ID of the variable that is differentiated against

Returns:

the derivative of the function with respect to varID

getInstance

public UnitaryFunction getInstance(GeneralFunction operand)

Description copied from class: UnitaryFunction

Returns a new instance of this UnitaryFunction

Specified by:

getInstance in class UnitaryFunction

Parameters:

operand - the GeneralFunction to be operated on

Returns:

a new instance of this UnitaryFunction

getElementaryIntegral

public GeneralFunction getElementaryIntegral()

Description copied from interface: Integrable

Returns the elementary integral of the function. Ex: sin(2x) becomes -cos{2x}, NOT -cos(2x)/2.

Returns:

the elementary integral of the function as specified above

getInverse

public Class<?> getInverse()

Description copied from interface: Invertible

Returns the Class corresponding to the inverse of this function

Returns:

the inverse Class

simplifyInverse

public GeneralFunction simplifyInverse()

Description copied from class: UnitaryFunction

If UnitaryFunction.operand is an instance of the inverse of this function, returns operand.operand

Overrides:

simplifyInverse in class UnitaryFunction

Returns:

operand.operand if UnitaryFunction.operand is an instance of the inverse, and this otherwise