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

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.BreitWigner
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.apache.mahout.math.function.DoubleFunction, IntFunction, UnaryFunction
Direct Known Subclasses:
BreitWignerMeanSquare

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

@Deprecated
public class BreitWigner
extends AbstractContinousDistribution

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.mahout.math.jet.random.AbstractDistribution
randomGenerator
 
Constructor Summary
BreitWigner(double mean, double gamma, double cut, java.util.Random randomGenerator)
          Deprecated. Constructs a BreitWigner distribution.
 
Method Summary
 double nextDouble()
          Deprecated. Returns a random number from the distribution.
 double nextDouble(double mean, double gamma, double cut)
          Deprecated. Returns a random number from the distribution; bypasses the internal state.
 void setState(double mean, double gamma, double cut)
          Deprecated. Sets the mean, gamma and cut parameters.
static double staticNextDouble(double mean, double gamma, double cut)
          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
cdf, nextInt, pdf
 
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

BreitWigner

public BreitWigner(double mean,
                   double gamma,
                   double cut,
                   java.util.Random randomGenerator)
Deprecated. 
Constructs a BreitWigner distribution.

Parameters:
cut - cut==Double.NEGATIVE_INFINITY indicates "don't cut".
Method Detail

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 mean,
                         double gamma,
                         double cut)
Deprecated. 
Returns a random number from the distribution; bypasses the internal state.

Parameters:
cut - cut==Double.NEGATIVE_INFINITY indicates "don't cut".

setState

public void setState(double mean,
                     double gamma,
                     double cut)
Deprecated. 
Sets the mean, gamma and cut parameters.

Parameters:
cut - cut==Double.NEGATIVE_INFINITY indicates "don't cut".

staticNextDouble

public static double staticNextDouble(double mean,
                                      double gamma,
                                      double cut)
Deprecated. 
Returns a random number from the distribution.

Parameters:
cut - cut==Double.NEGATIVE_INFINITY indicates "don't cut".

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.