BoxSampler.BoxSamplerND

java.lang.Object

org.apache.commons.rng.sampling.shape.BoxSampler

org.apache.commons.rng.sampling.shape.BoxSampler.BoxSamplerND

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

Enclosing class:: BoxSampler

private static final class BoxSampler.BoxSamplerND extends BoxSampler

Sample uniformly from a box in ND.

Field Summary

Fields

Modifier and Type

Field

Description

private final double[]

a

Bound a.

private final double[]

b

Bound b.
Constructor Summary

Constructors

Constructor

Description

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

BoxSamplerND(UniformRandomProvider rng, BoxSampler.BoxSamplerND source)
Method Summary

Modifier and Type

Method

Description

double[]

sample()

Create an object sample.

BoxSampler

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.BoxSampler
createSample, 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
- a
  
  private final double[] a
  
  Bound a.
- b
  
  private final double[] b
  
  Bound b.
Constructor Details
- BoxSamplerND
  
  BoxSamplerND(UniformRandomProvider rng, double[] a, double[] b)
  
  Parameters:
  
  rng - Source of randomness.
  
  a - Bound a.
  
  b - Bound b.
- BoxSamplerND
  
  BoxSamplerND(UniformRandomProvider rng, BoxSampler.BoxSamplerND source)
  
  Parameters:
  
  rng - Source of randomness.
  
  source - Source to copy.
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 BoxSampler
  
  Returns:
  
  a random Cartesian coordinate within the box.
- withUniformRandomProvider
  
  public BoxSampler withUniformRandomProvider(UniformRandomProvider rng)
  
  Description copied from class: BoxSampler
  
  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 BoxSampler
  
  Parameters:
  
  rng - Generator of uniformly distributed random numbers.
  
  Returns:
  
  the sampler