cern.jet.random
Class BreitWignerMeanSquare

java.lang.Object
  extended by cern.colt.PersistentObject
      extended by cern.jet.random.AbstractDistribution
          extended by cern.jet.random.AbstractContinousDistribution
              extended by cern.jet.random.BreitWigner
                  extended by cern.jet.random.BreitWignerMeanSquare
All Implemented Interfaces:
DoubleFunction, IntFunction, java.io.Serializable, java.lang.Cloneable

public class BreitWignerMeanSquare
extends BreitWigner

Mean-square BreitWigner distribution; See the math definition.

Instance methods operate on a user supplied uniform random number generator; they are unsynchronized.

Static methods operate on a default uniform random number generator; they are synchronized.

Implementation: This is a port of RandBreitWigner used in CLHEP 1.4.0 (C++).

Author:
wolfgang.hoschek@cern.ch
See Also:
Serialized Form

Field Summary
protected static BreitWigner shared
           
protected  Uniform uniform
           
 
Fields inherited from class cern.jet.random.BreitWigner
cut, gamma, mean
 
Fields inherited from class cern.jet.random.AbstractDistribution
randomGenerator
 
Fields inherited from class cern.colt.PersistentObject
serialVersionUID
 
Constructor Summary
BreitWignerMeanSquare(double mean, double gamma, double cut, RandomEngine randomGenerator)
          Constructs a mean-squared BreitWigner distribution.
 
Method Summary
 java.lang.Object clone()
          Returns a deep copy of the receiver; the copy will produce identical sequences.
 double nextDouble(double mean, double gamma, double cut)
          Returns a mean-squared random number from the distribution; bypasses the internal state.
static double staticNextDouble(double mean, double gamma, double cut)
          Returns a random number from the distribution.
 
Methods inherited from class cern.jet.random.BreitWigner
nextDouble, setState, toString
 
Methods inherited from class cern.jet.random.AbstractDistribution
apply, apply, getRandomGenerator, makeDefaultGenerator, nextInt, setRandomGenerator
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

uniform

protected Uniform uniform

shared

protected static BreitWigner shared
Constructor Detail

BreitWignerMeanSquare

public BreitWignerMeanSquare(double mean,
                             double gamma,
                             double cut,
                             RandomEngine randomGenerator)
Constructs a mean-squared BreitWigner distribution.

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

clone

public java.lang.Object clone()
Returns a deep copy of the receiver; the copy will produce identical sequences. After this call has returned, the copy and the receiver have equal but separate state.

Overrides:
clone in class AbstractDistribution
Returns:
a copy of the receiver.

nextDouble

public double nextDouble(double mean,
                         double gamma,
                         double cut)
Returns a mean-squared random number from the distribution; bypasses the internal state.

Overrides:
nextDouble in class BreitWigner
Parameters:
cut - cut==Double.NEGATIVE_INFINITY indicates "don't cut".

staticNextDouble

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

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