Class UnitSphereSampler.UnitSphereSampler1D

java.lang.Object

org.apache.commons.rng.sampling.UnitSphereSampler

org.apache.commons.rng.sampling.UnitSphereSampler.UnitSphereSampler1D

All Implemented Interfaces:

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

Enclosing class:

UnitSphereSampler

private static final class UnitSphereSampler.UnitSphereSampler1D
extends UnitSphereSampler

Sample uniformly from the ends of a 1D unit line.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
private final UniformRandomProvider	rng	The source of randomness.

Constructor Summary

Constructors

Constructor	Description
UnitSphereSampler1D(UniformRandomProvider rng)

Method Summary

Modifier and Type	Method	Description
double[]	sample()	Create an object sample.
UnitSphereSampler	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 UnitSphereSampler

nextVector, of

Methods inherited from class Object

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

Methods inherited from interface ObjectSampler

samples, samples

Field Details

rng

private final UniformRandomProvider rng

The source of randomness.

Constructor Details

UnitSphereSampler1D

UnitSphereSampler1D(UniformRandomProvider rng)

Parameters:

rng - Source of randomness.

Method Details

sample

public double[] sample()

Description copied from interface: ObjectSampler

Create an object sample.

Specified by:

sample in interface ObjectSampler<double[]>

Overrides:

sample in class UnitSphereSampler

Returns:

a random normalized Cartesian vector.

withUniformRandomProvider

public UnitSphereSampler withUniformRandomProvider(UniformRandomProvider rng)

Description copied from class: UnitSphereSampler

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

Overrides:

withUniformRandomProvider in class UnitSphereSampler

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler