org.apache.mahout.math.jet.random
Class StudentT

java.lang.Object
  extended by org.apache.mahout.math.PersistentObject
      extended by org.apache.mahout.math.jet.random.AbstractDistribution
          extended by org.apache.mahout.math.jet.random.AbstractContinousDistribution
              extended by org.apache.mahout.math.jet.random.StudentT
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.apache.mahout.math.function.DoubleFunction, IntFunction, UnaryFunction

Deprecated. until unit tests are in place. Until this time, this class/interface is unsupported.

@Deprecated
public class StudentT
extends AbstractContinousDistribution

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.mahout.math.jet.random.AbstractDistribution
randomGenerator
 
Constructor Summary
StudentT(double freedom, java.util.Random randomGenerator)
          Deprecated. Constructs a StudentT distribution.
 
Method Summary
 double cdf(double x)
          Deprecated. Returns the cumulative distribution function.
 double nextDouble()
          Deprecated. Returns a random number from the distribution.
 double nextDouble(double degreesOfFreedom)
          Deprecated. Returns a random number from the distribution; bypasses the internal state.
 double pdf(double x)
          Deprecated. Returns the probability distribution function.
 void setState(double freedom)
          Deprecated. Sets the distribution parameter.
static double staticNextDouble(double freedom)
          Deprecated. Returns a random number from the distribution.
 java.lang.String toString()
          Deprecated. Returns a String representation of the receiver.
 
Methods inherited from class org.apache.mahout.math.jet.random.AbstractContinousDistribution
nextInt
 
Methods inherited from class org.apache.mahout.math.jet.random.AbstractDistribution
apply, apply, getRandomGenerator, setRandomGenerator
 
Methods inherited from class org.apache.mahout.math.PersistentObject
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StudentT

public StudentT(double freedom,
                java.util.Random randomGenerator)
Deprecated. 
Constructs a StudentT distribution. Example: freedom=1.0.

Parameters:
freedom - degrees of freedom.
Throws:
java.lang.IllegalArgumentException - if freedom <= 0.0.
Method Detail

cdf

public double cdf(double x)
Deprecated. 
Returns the cumulative distribution function.

Overrides:
cdf in class AbstractContinousDistribution

nextDouble

public double nextDouble()
Deprecated. 
Returns a random number from the distribution.

Specified by:
nextDouble in class AbstractDistribution
Returns:
A new sample from this distribution.

nextDouble

public double nextDouble(double degreesOfFreedom)
Deprecated. 
Returns a random number from the distribution; bypasses the internal state.

Parameters:
degreesOfFreedom - a degrees of freedom.
Throws:
java.lang.IllegalArgumentException - if a <= 0.0.

pdf

public double pdf(double x)
Deprecated. 
Returns the probability distribution function.

Overrides:
pdf in class AbstractContinousDistribution

setState

public void setState(double freedom)
Deprecated. 
Sets the distribution parameter.

Parameters:
freedom - degrees of freedom.
Throws:
java.lang.IllegalArgumentException - if freedom <= 0.0.

staticNextDouble

public static double staticNextDouble(double freedom)
Deprecated. 
Returns a random number from the distribution.

Parameters:
freedom - degrees of freedom.
Throws:
java.lang.IllegalArgumentException - if freedom <= 0.0.

toString

public java.lang.String toString()
Deprecated. 
Returns a String representation of the receiver.

Overrides:
toString in class java.lang.Object


Copyright © 2008-2010 The Apache Software Foundation. All Rights Reserved.