Class StableSampler.CauchyStableSampler

java.lang.Object

org.apache.commons.rng.sampling.distribution.StableSampler

org.apache.commons.rng.sampling.distribution.StableSampler.BaseStableSampler

org.apache.commons.rng.sampling.distribution.StableSampler.CauchyStableSampler

All Implemented Interfaces:

ContinuousSampler, SharedStateContinuousSampler, SharedStateSampler<SharedStateContinuousSampler>

Enclosing class:

StableSampler

private static final class StableSampler.CauchyStableSampler
extends StableSampler.BaseStableSampler

Implement the alpha = 1 and beta = 0 stable distribution case (Cauchy distribution).

Since:

1.4

Nested Class Summary

Nested classes/interfaces inherited from class StableSampler

StableSampler.Alpha1CMSStableSampler, StableSampler.Beta0CMSStableSampler, StableSampler.Beta0WeronStableSampler, StableSampler.CMSStableSampler, StableSampler.SpecialMath, StableSampler.WeronStableSampler

Field Summary

Fields

Modifier and Type	Field	Description
private final double	delta	The location parameter.
private final double	gamma	The scale parameter.

Constructor Summary

Constructors

Constructor	Description
CauchyStableSampler(UniformRandomProvider rng, double gamma, double delta)
CauchyStableSampler(UniformRandomProvider rng, StableSampler.CauchyStableSampler source)

Method Summary

Modifier and Type	Method	Description
double	sample()	Generate a sample from a stable distribution.
StableSampler.CauchyStableSampler	withUniformRandomProvider(UniformRandomProvider rng)	Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Methods inherited from class StableSampler.BaseStableSampler

getOmega, getPhi, getPhiBy2

Methods inherited from class StableSampler

nextLong, of, of, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ContinuousSampler

samples, samples

Field Details

gamma

private final double gamma

The scale parameter.

delta

private final double delta

The location parameter.

Constructor Details

CauchyStableSampler

CauchyStableSampler(UniformRandomProvider rng,
 double gamma,
 double delta)

Parameters:

rng - Underlying source of randomness

gamma - Scale parameter. Must be strictly positive.

delta - Location parameter.

CauchyStableSampler

CauchyStableSampler(UniformRandomProvider rng,
 StableSampler.CauchyStableSampler source)

Parameters:

rng - Underlying source of randomness

source - Source to copy.

Method Details

sample

public double sample()

Description copied from class: StableSampler

Generate a sample from a stable distribution.

The distribution uses the 0-parameterization: S(alpha, beta, gamma, delta; 0).

Specified by:

sample in interface ContinuousSampler

Specified by:

sample in class StableSampler

Returns:

a sample.

withUniformRandomProvider

public StableSampler.CauchyStableSampler withUniformRandomProvider(UniformRandomProvider rng)

Description copied from class: StableSampler

Create a new instance of the sampler with the same underlying state using the given uniform random provider as the source of randomness.

Specified by:

withUniformRandomProvider in interface SharedStateSampler<SharedStateContinuousSampler>

Specified by:

withUniformRandomProvider in class StableSampler

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler