com.epochx.representation.dbl
Class CosecantFunction

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.CosecantFunction
All Implemented Interfaces:
java.lang.Cloneable

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

A FunctionNode which performs the reciprocal trigonometric function of cosecant. Cosecant x is equal to 1/sin x.


Constructor Summary
CosecantFunction()
          Construct a CosecantFunction with no children.
CosecantFunction(Node<java.lang.Double> child)
          Construct a CosecantFunction with one child.
 
Method Summary
 java.lang.Double evaluate()
          Evaluating a CosecantFunction involves calculating sine of the child once it's been evaluated, then dividing 1 by the result.
 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

CosecantFunction

public CosecantFunction()
Construct a CosecantFunction with no children.


CosecantFunction

public CosecantFunction(Node<java.lang.Double> child)
Construct a CosecantFunction with one child. When evaluated, the child will be evaluated with cosecant performed on the result.

Parameters:
child - The child which cosecant will be performed on.
Method Detail

evaluate

public java.lang.Double evaluate()
Evaluating a CosecantFunction involves calculating sine of the child once it's been evaluated, then dividing 1 by the result.

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 CosecantFunction which is COSEC.