Package org.apache.commons.rng.sampling

Class UnitSphereSampler

java.lang.Object

org.apache.commons.rng.sampling.UnitSphereSampler

All Implemented Interfaces:

SharedStateSampler<UnitSphereSampler>

public class UnitSphereSampler
extends java.lang.Object
implements SharedStateSampler<UnitSphereSampler>

Generate vectors isotropically located on the surface of a sphere.

Sampling uses:

• UniformRandomProvider.nextLong()
• UniformRandomProvider.nextDouble()

Since:

1.1

Constructor Summary

Constructors

Constructor	Description
UnitSphereSampler(int dimension, org.apache.commons.rng.UniformRandomProvider rng)

Method Summary

Modifier and Type	Method	Description
double[]	nextVector()
UnitSphereSampler	withUniformRandomProvider(org.apache.commons.rng.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 java.lang.Object

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

Constructor Detail

UnitSphereSampler

public UnitSphereSampler(int dimension,
                         org.apache.commons.rng.UniformRandomProvider rng)

Parameters:

dimension - Space dimension.

rng - Generator for the individual components of the vectors. A shallow copy will be stored in this instance.

Throws:

java.lang.IllegalArgumentException - If dimension <= 0

Method Detail

nextVector

public double[] nextVector()

Returns:

a random normalized Cartesian vector.

withUniformRandomProvider

public UnitSphereSampler withUniformRandomProvider(org.apache.commons.rng.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.

Specified by:

withUniformRandomProvider in interface SharedStateSampler<UnitSphereSampler>

Parameters:

rng - Generator of uniformly distributed random numbers.

Returns:

the sampler

Since:

1.3