JTR 5.0 API Documentation

jtr.lang.functions.impl
Class Exponential

java.lang.Object
  extended by jtr.lang.functions.impl.BaseFunction
      extended by jtr.lang.functions.impl.Exponential
All Implemented Interfaces:
IStatFunction

public class Exponential
extends BaseFunction
implements IStatFunction

Implementation of the exponential distribution.

Since:
5.0
Version:
5.0
Author:
frusso

Constructor Summary
Exponential(java.lang.String[] actualParameters)
           
 
Method Summary
protected  java.lang.String getErrorMsg()
          An error message that must be provided to the user.
protected  int getMaxNumberOfArguments()
          Returns the maximum number of expected parameters.
protected  int getMinNumberOfArguments()
          Returns the minimum number of expected parameters.
 java.lang.Double value()
          Returns the value produced by the function.
 
Methods inherited from class jtr.lang.functions.impl.BaseFunction
checkPreconditions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Exponential

public Exponential(java.lang.String[] actualParameters)
Method Detail

value

public java.lang.Double value()
Returns the value produced by the function.

Specified by:
value in interface IStatFunction
Returns:

getMinNumberOfArguments

protected int getMinNumberOfArguments()
Description copied from class: BaseFunction
Returns the minimum number of expected parameters.

Specified by:
getMinNumberOfArguments in class BaseFunction
Returns:

getMaxNumberOfArguments

protected int getMaxNumberOfArguments()
Description copied from class: BaseFunction
Returns the maximum number of expected parameters.

Specified by:
getMaxNumberOfArguments in class BaseFunction
Returns:

getErrorMsg

protected java.lang.String getErrorMsg()
Description copied from class: BaseFunction
An error message that must be provided to the user.

Specified by:
getErrorMsg in class BaseFunction
Returns:

The JTR Project is licensed under GPL version 2