[RNG-177] Add stream methods to the sampler API

• Type: New Feature
• Status: Closed
• Priority: Minor
• Resolution: Implemented
• Affects Version/s: 1.4
• Fix Version/s: 1.5
• Component/s: sampling
• difficulty-level: Easy
• Assignee: Alex Herbert
• Reporter: Alex Herbert
• Created: 04/May/22 11:14
• Updated: 10/Oct/22 11:54
• Resolved: 04/May/22 14:19

Description

Add default stream implementations to the sampler API interfaces

• ContinuousSampler - DoubleStream
• DiscreteSampler - IntStream
• LongSampler - LongStream
• ObjectSampler<T> - Stream<T>

e.g.

default DoubleStream samples() {
    return DoubleStream.generate(this::sample).sequential();
}  

default DoubleStream samples(long streamSize) {
    return samples().limit(streamSize);
}  

This allows for example:

UniformRandomProvider rng = ...;
double[] data = ContinuousUniformSampler.of(rng, 1.23, 4.56)
                                        .samples(50)
                                        .toArray(); 

Issue Links

• is related to: RNG-176 Enhance the UniformRandomProvider interface with extra methods and default implementations