Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Colt 1.2.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

cern.jet.random
Class BreitWignerMeanSquare

java.lang.Object
  extended bycern.colt.PersistentObject
      extended bycern.jet.random.AbstractDistribution
          extended bycern.jet.random.AbstractContinousDistribution
              extended bycern.jet.random.BreitWigner
                  extended bycern.jet.random.BreitWignerMeanSquare
All Implemented Interfaces:
Cloneable, DoubleFunction, IntFunction, Serializable
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++).

Version:
1.0, 09/24/99
See Also:
Serialized Form

Field Summary
 
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
 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, makeDefaultGenerator, nextInt
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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 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".
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Colt 1.2.0
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Jump to the Colt Homepage