JTR 5.0 API Documentation

jtr.lang.functions
Enum StatFunctions

java.lang.Object
  extended by java.lang.Enum<StatFunctions>
      extended by jtr.lang.functions.StatFunctions
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StatFunctions>

public enum StatFunctions
extends java.lang.Enum<StatFunctions>

Built-in statistical functions.

Since:
5.0
Version:
5.0
Author:
frusso

Enum Constant Summary
Exponential
           
Gaussian
           
Poisson
           
UniformDouble
           
UniformInt
           
UniformLong
           
 
Method Summary
static java.lang.String asString()
          Returns a String representation of all the built-in supported statistical functions.
static StatFunctions valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static StatFunctions[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Exponential

public static final StatFunctions Exponential

Gaussian

public static final StatFunctions Gaussian

UniformInt

public static final StatFunctions UniformInt

UniformLong

public static final StatFunctions UniformLong

UniformDouble

public static final StatFunctions UniformDouble

Poisson

public static final StatFunctions Poisson
Method Detail

values

public static StatFunctions[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (StatFunctions c : StatFunctions.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static StatFunctions valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

asString

public static java.lang.String asString()
Returns a String representation of all the built-in supported statistical functions.

Returns:

The JTR Project is licensed under GPL version 2