com.epochx.representation.dbl
Class HyperbolicTangentFunction

java.lang.Object
  com.epochx.representation.Node<TYPE>
      com.epochx.representation.FunctionNode<java.lang.Double>
          com.epochx.representation.dbl.HyperbolicTangentFunction

All Implemented Interfaces:

java.lang.Cloneable

public class HyperbolicTangentFunction
extends FunctionNode<java.lang.Double>

A FunctionNode which performs the hyperbolic trigonometric function of hyperbolic tangent.

Constructor Summary

HyperbolicTangentFunction()
Construct a HyperbolicTangentFunction with no children.

HyperbolicTangentFunction(Node<java.lang.Double> child)
Construct a HyperbolicTangentFunction with one child.

Method Summary

java.lang.Double	evaluate() Evaluating an HyperbolicTangentFunction involves calculating the hyperbolic tangent of the child once it has also been evaluated.
java.lang.String	getFunctionName() Get the unique name that identifies this function.

Methods inherited from class com.epochx.representation.FunctionNode

equals, toString

Methods inherited from class com.epochx.representation.Node

clone, getArity, getChild, getChildren, getDepth, getFunctionNodes, getLength, getNodesAtDepth, getNoDistinctFunctions, getNoDistinctTerminals, getNoFunctions, getNoTerminals, getNthNode, getTerminalNodes, hashCode, setChild, setChildren, setNthNode

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperbolicTangentFunction

public HyperbolicTangentFunction()

Construct a HyperbolicTangentFunction with no children.

HyperbolicTangentFunction

public HyperbolicTangentFunction(Node<java.lang.Double> child)

Construct a HyperbolicTangentFunction with one child. When evaluated, the child will first be evaluated with hyperbolic tangent performed on the result.

Parameters:

child - The child which hyperbolic tangent will be performed on.

Method Detail

evaluate

public java.lang.Double evaluate()

Evaluating an HyperbolicTangentFunction involves calculating the hyperbolic tangent of the child once it has also been evaluated.

Specified by:

evaluate in class Node<java.lang.Double>

Returns:

The result of evaluating the candidate program.

getFunctionName

public java.lang.String getFunctionName()

Get the unique name that identifies this function.

Specified by:

getFunctionName in class FunctionNode<java.lang.Double>

Returns:

the unique name for the HyperbolicTangentFunction which is TANH.