UnitBallSampler.UnitBallSampler3D

java.lang.Object

org.apache.commons.rng.sampling.shape.UnitBallSampler

org.apache.commons.rng.sampling.shape.UnitBallSampler.UnitBallSampler3D

All Implemented Interfaces:: ObjectSampler<double[]>, SharedStateObjectSampler<double[]>, SharedStateSampler<SharedStateObjectSampler<double[]>>

Enclosing class:: UnitBallSampler

private static final class UnitBallSampler.UnitBallSampler3D extends UnitBallSampler

Sample uniformly from a 3D unit ball. This is an non-array based specialisation of UnitBallSampler.UnitBallSamplerND for performance.

Field Summary

Fields

Modifier and Type

Field

Description

private final ContinuousSampler

exp

The exponential distribution (mean=1).

private final NormalizedGaussianSampler

normal

The standard normal distribution.
Constructor Summary

Constructors

Constructor

Description

UnitBallSampler3D(UniformRandomProvider rng)
Method Summary

Modifier and Type

Method

Description

double[]

sample()

Create an object sample.

UnitBallSampler

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.UnitBallSampler
of

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
- normal
  
  private final NormalizedGaussianSampler normal
  
  The standard normal distribution.
- exp
  
  private final ContinuousSampler exp
  
  The exponential distribution (mean=1).
Constructor Details
- UnitBallSampler3D
  
  UnitBallSampler3D(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[]>
  
  Specified by:
  
  sample in class UnitBallSampler
  
  Returns:
  
  a random Cartesian coordinate within the unit n-ball.
- withUniformRandomProvider
  
  public UnitBallSampler withUniformRandomProvider(UniformRandomProvider rng)
  
  Description copied from class: UnitBallSampler
  
  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 UnitBallSampler
  
  Parameters:
  
  rng - Generator of uniformly distributed random numbers.
  
  Returns:
  
  the sampler