Package cern.jet.random
Class BreitWigner
java.lang.Object
cern.colt.PersistentObject
cern.jet.random.AbstractDistribution
cern.jet.random.AbstractContinousDistribution
cern.jet.random.BreitWigner
- All Implemented Interfaces:
DoubleFunction
,IntFunction
,Serializable
,Cloneable
- Direct Known Subclasses:
BreitWignerMeanSquare
BreitWigner (aka Lorentz) distribution; See the math definition.
A more general form of the Cauchy distribution.
Static methods operate on a default uniform random number generator; they are synchronized.
Instance methods operate on a user supplied uniform random number generator; they are unsynchronized.
Implementation: This is a port of RandBreitWigner used in CLHEP 1.4.0 (C++).
- Version:
- 1.0, 09/24/99
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected double
protected double
protected double
protected static BreitWigner
Fields inherited from class cern.jet.random.AbstractDistribution
randomGenerator
Fields inherited from class cern.colt.PersistentObject
serialVersionUID
-
Constructor Summary
ConstructorsConstructorDescriptionBreitWigner
(double mean, double gamma, double cut, RandomEngine randomGenerator) Constructs a BreitWigner distribution. -
Method Summary
Modifier and TypeMethodDescriptiondouble
Returns a random number from the distribution.double
nextDouble
(double mean, double gamma, double cut) Returns a random number from the distribution; bypasses the internal state.void
setState
(double mean, double gamma, double cut) Sets the mean, gamma and cut parameters.static double
staticNextDouble
(double mean, double gamma, double cut) Returns a random number from the distribution.toString()
Returns a String representation of the receiver.private static void
xstaticSetRandomGenerator
(RandomEngine randomGenerator) Sets the uniform random number generated shared by all static methods.Methods inherited from class cern.jet.random.AbstractDistribution
apply, apply, clone, getRandomGenerator, makeDefaultGenerator, nextInt, setRandomGenerator
-
Field Details
-
mean
protected double mean -
gamma
protected double gamma -
cut
protected double cut
-
-
Constructor Details
-
BreitWigner
Constructs a BreitWigner distribution.- Parameters:
cut
- cut==Double.NEGATIVE_INFINITY indicates "don't cut".
-
-
Method Details
-
nextDouble
public double nextDouble()Returns a random number from the distribution.- Specified by:
nextDouble
in classAbstractDistribution
-
nextDouble
public double nextDouble(double mean, double gamma, double cut) 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) 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) Returns a random number from the distribution.- Parameters:
cut
- cut==Double.NEGATIVE_INFINITY indicates "don't cut".
-
toString
Returns a String representation of the receiver. -
xstaticSetRandomGenerator
Sets the uniform random number generated shared by all static methods.- Parameters:
randomGenerator
- the new uniform random number generator to be shared.
-