Class BoxSampler.BoxSampler3D
java.lang.Object
org.apache.commons.rng.sampling.shape.BoxSampler
org.apache.commons.rng.sampling.shape.BoxSampler.BoxSampler3D
- All Implemented Interfaces:
ObjectSampler<double[]>
,SharedStateObjectSampler<double[]>
,SharedStateSampler<SharedStateObjectSampler<double[]>>
- Enclosing class:
BoxSampler
Sample uniformly from a box in 3D. This is an non-array based specialisation of
BoxSampler.BoxSamplerND
for performance.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final double
The x component of bound a.private final double
The y component of bound a.private final double
The z component of bound a.private final double
The x component of bound b.private final double
The y component of bound b.private final double
The z component of bound b. -
Constructor Summary
ConstructorsConstructorDescriptionBoxSampler3D
(UniformRandomProvider rng, double[] a, double[] b) BoxSampler3D
(UniformRandomProvider rng, BoxSampler.BoxSampler3D source) -
Method Summary
Modifier and TypeMethodDescriptiondouble[]
sample()
Create an object sample.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
-
ax
private final double axThe x component of bound a. -
ay
private final double ayThe y component of bound a. -
az
private final double azThe z component of bound a. -
bx
private final double bxThe x component of bound b. -
by
private final double byThe y component of bound b. -
bz
private final double bzThe z component of bound b.
-
-
Constructor Details
-
BoxSampler3D
BoxSampler3D(UniformRandomProvider rng, double[] a, double[] b) - Parameters:
rng
- Source of randomness.a
- Bound a.b
- Bound b.
-
BoxSampler3D
BoxSampler3D(UniformRandomProvider rng, BoxSampler.BoxSampler3D 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 interfaceObjectSampler<double[]>
- Specified by:
sample
in classBoxSampler
- Returns:
- a random Cartesian coordinate within the box.
-
withUniformRandomProvider
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 interfaceSharedStateSampler<SharedStateObjectSampler<double[]>>
- Specified by:
withUniformRandomProvider
in classBoxSampler
- Parameters:
rng
- Generator of uniformly distributed random numbers.- Returns:
- the sampler
-