com.epochx.representation.dbl
Class LogFunction

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

All Implemented Interfaces:

java.lang.Cloneable

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

A FunctionNode which performs the natural (base e) logarithm.

See Also:

Log10Function

Constructor Summary

LogFunction()
Construct a LogFunction with no children.

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

Method Summary

java.lang.Double	evaluate() Evaluating a LogFunction involves evaluating the child then calculating it's base e logarithm.
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

LogFunction

public LogFunction()

Construct a LogFunction with no children.

LogFunction

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

Construct a LogFunction with one child. When evaluated, the logarithm of the evaluated child will be calculated.

Parameters:

child - The child of which the base e logarithm will be calculated.

Method Detail

evaluate

public java.lang.Double evaluate()

Evaluating a LogFunction involves evaluating the child then calculating it's base e logarithm.

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 LogFunction which is LN.