com.epochx.representation.dbl
Class Log10Function

java.lang.Object
  extended by com.epochx.representation.Node<TYPE>
      extended by com.epochx.representation.FunctionNode<java.lang.Double>
          extended by com.epochx.representation.dbl.Log10Function
All Implemented Interfaces:
java.lang.Cloneable

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

A FunctionNode which performs the common (base 10) logarithm.

See Also:
LogFunction

Constructor Summary
Log10Function()
          Construct a Log10Function with no children.
Log10Function(Node<java.lang.Double> child)
          Construct a Log10Function with one child.
 
Method Summary
 java.lang.Double evaluate()
          Evaluating a Log10Function involves evaluating the child then calculating it's base 10 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

Log10Function

public Log10Function()
Construct a Log10Function with no children.


Log10Function

public Log10Function(Node<java.lang.Double> child)
Construct a Log10Function with one child. When evaluated, the logarithm of the evaluated child will be calculated.

Parameters:
child - The child of which the base 10 logarithm will be calculated.
Method Detail

evaluate

public java.lang.Double evaluate()
Evaluating a Log10Function involves evaluating the child then calculating it's base 10 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 Log10Function which is LOG-10.