Package org.apache.commons.rng.sampling.shape

Class LineSampler.LineSampler1D

java.lang.Object

org.apache.commons.rng.sampling.shape.LineSampler

org.apache.commons.rng.sampling.shape.LineSampler.LineSampler1D

All Implemented Interfaces:

ObjectSampler<double[]>, SharedStateObjectSampler<double[]>, SharedStateSampler<SharedStateObjectSampler<double[]>>

Enclosing class:

LineSampler

private static final class LineSampler.LineSampler1D
extends LineSampler

Sample uniformly from a line in 1D. This is an non-array based specialisation of LineSampler.LineSamplerND for performance.

Field Summary

Fields

Modifier and Type	Field	Description
private final double	ax	The x component of vertex a.
private final double	bx	The x component of vertex b.

Constructor Summary

Constructors

Constructor	Description
LineSampler1D(UniformRandomProvider rng, double[] a, double[] b)
LineSampler1D(UniformRandomProvider rng, LineSampler.LineSampler1D source)

Method Summary

Modifier and Type	Method	Description
double[]	createSample(double p1mu, double u)	Creates the sample given the random variate u in the interval [0, 1].
LineSampler	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 org.apache.commons.rng.sampling.shape.LineSampler

of, sample

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.rng.sampling.ObjectSampler

samples, samples

Field Details

ax

private final double ax

The x component of vertex a.

bx

private final double bx

The x component of vertex b.

Constructor Details

LineSampler1D

LineSampler1D(UniformRandomProvider rng,
 double[] a,
 double[] b)

Parameters:

rng - Source of randomness.

a - The first vertex.

b - The second vertex.

LineSampler1D

LineSampler1D(UniformRandomProvider rng,
 LineSampler.LineSampler1D source)

Parameters:

rng - Source of randomness.

source - Source to copy.

Method Details

createSample

public double[] createSample(double p1mu,
 double u)

Description copied from class: LineSampler

Creates the sample given the random variate u in the interval [0, 1]. The sum 1 - u is provided. The sample can be obtained from the line ab using:

 p = a(1 - u) + ub
 

Specified by:

createSample in class LineSampler

Parameters:

p1mu - plus 1 minus u (1 - u)

u - the variate u

Returns:

the sample

withUniformRandomProvider

public LineSampler withUniformRandomProvider(UniformRandomProvider rng)

Description copied from class: LineSampler

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<SharedStateObjectSampler<double[]>>

Specified by:

withUniformRandomProvider in class LineSampler

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler