Merge pull request #302 from cicirello/composite-sampler

Implemented SequenceSampler interface in the SequenceCompositeSampler class

Author: cicirello

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 **BREAKING CHANGES:** See the Removed section for details.
 
 ### Added
+* Added the SequenceSampler interface's methods to SequenceCompositeSampler.
 * Added the SequenceSampler interface's methods to SequenceReservoirSampler.
 * Added the SequenceSampler interface's methods to SequencePoolSampler.
 * Added the SequenceSampler interface's methods to SequenceInsertionSampler.

src/main/java/org/cicirello/sequences/SequenceCompositeSampler.java

@@ -24,8 +24,7 @@
 import java.util.random.RandomGenerator;
 
 /**
- * SequenceCompositeSampler is a class of utility methods for efficiently generating random samples
- * of array elements, without replacement.
+ * SequenceCompositeSampler generates random samples of array elements, without replacement.
  *
  * <p>This class implements the composite sampler that combines reservoir sampling, pool sampling,
  * and insertion sampling as described in:
@@ -42,10 +41,117 @@
  * @author <a href=https://www.cicirello.org/ target=_top>Vincent A. Cicirello</a>, <a
  *     href=https://www.cicirello.org/ target=_top>https://www.cicirello.org/</a>
  */
-public final class SequenceCompositeSampler {
+public final class SequenceCompositeSampler implements SequenceSampler {
 
-  /** Class of static utility methods so prevent instantiation with a private constructor. */
-  private SequenceCompositeSampler() {}
+  private final RandomGenerator r;
+
+  /**
+   * Constructs a sampler wrapping a RandomGenerator used as the source of randomness.
+   *
+   * @param r The source of randomness.
+   */
+  public SequenceCompositeSampler(RandomGenerator r) {
+    this.r = r;
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public int[] nextSample(int[] source, int k, int[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public long[] nextSample(long[] source, int k, long[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public short[] nextSample(short[] source, int k, short[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public byte[] nextSample(byte[] source, int k, byte[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public double[] nextSample(double[] source, int k, double[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public float[] nextSample(float[] source, int k, float[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public char[] nextSample(char[] source, int k, char[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length()
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public char[] nextSample(String source, int k, char[] target) {
+    return sample(source, k, target, r);
+  }
+
+  /**
+   * {@inheritDoc}
+   *
+   * @throws IllegalArgumentException if k &gt; source.length
+   * @throws NegativeArraySizeException if k &lt; 0
+   */
+  @Override
+  public <T> T[] nextSample(T[] source, int k, T[] target) {
+    return sample(source, k, target, r);
+  }
 
   /**
    * Generates a random sample of k elements, without replacement, from a given source array. All n

src/test/java/org/cicirello/sequences/SequenceSamplerByteTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of bytes. */
 public class SequenceSamplerByteTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerCharTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of chars. */
 public class SequenceSamplerCharTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerDoubleTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of doubles. */
 public class SequenceSamplerDoubleTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerFloatTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of floats. */
 public class SequenceSamplerFloatTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerIntTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of ints. */
 public class SequenceSamplerIntTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerLongTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of longs. */
 public class SequenceSamplerLongTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerObjectTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of objects. */
 public class SequenceSamplerObjectTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));

src/test/java/org/cicirello/sequences/SequenceSamplerShortTests.java

@@ -29,6 +29,12 @@
 /** JUnit tests for sequence samplers of shorts. */
 public class SequenceSamplerShortTests {
 
+  @Test
+  public void testSampleComposite() {
+    SequenceCompositeSampler r = new SequenceCompositeSampler(new SplittableRandom(42));
+    validateSamples(r::nextSample);
+  }
+
   @Test
   public void testSampleReservoir() {
     SequenceReservoirSampler r = new SequenceReservoirSampler(new SplittableRandom(42));