Skip to content

Commit 26db6c6

Browse files
committed
doc update
1 parent 9692368 commit 26db6c6

File tree

1 file changed

+18
-27
lines changed

1 file changed

+18
-27
lines changed

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

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,8 @@ public static <T> T[] sample(T[] source, double p) {
162162
* given source array. All n choose k combinations are equally
163163
* likely, where n is the length of the source array.</p>
164164
*
165-
* <p>This method chooses among the samplePool,
166-
* sampleReservoir, and sampleInsertion
167-
* methods based on the values of n and k.</p>
165+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
166+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
168167
*
169168
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
170169
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -195,9 +194,8 @@ public static int[] sample(int[] source, int k, int[] target) {
195194
* given source array. All n choose k combinations are equally
196195
* likely, where n is the length of the source array.</p>
197196
*
198-
* <p>This method chooses among the samplePool,
199-
* sampleReservoir, and sampleInsertion
200-
* methods based on the values of n and k.</p>
197+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
198+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
201199
*
202200
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
203201
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -228,9 +226,8 @@ public static long[] sample(long[] source, int k, long[] target) {
228226
* given source array. All n choose k combinations are equally
229227
* likely, where n is the length of the source array.</p>
230228
*
231-
* <p>This method chooses among the samplePool,
232-
* sampleReservoir, and sampleInsertion
233-
* methods based on the values of n and k.</p>
229+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
230+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
234231
*
235232
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
236233
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -261,9 +258,8 @@ public static short[] sample(short[] source, int k, short[] target) {
261258
* given source array. All n choose k combinations are equally
262259
* likely, where n is the length of the source array.</p>
263260
*
264-
* <p>This method chooses among the samplePool,
265-
* sampleReservoir, and sampleInsertion
266-
* methods based on the values of n and k.</p>
261+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
262+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
267263
*
268264
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
269265
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -294,9 +290,8 @@ public static byte[] sample(byte[] source, int k, byte[] target) {
294290
* given source array. All n choose k combinations are equally
295291
* likely, where n is the length of the source array.</p>
296292
*
297-
* <p>This method chooses among the samplePool,
298-
* sampleReservoir, and sampleInsertion
299-
* methods based on the values of n and k.</p>
293+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
294+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
300295
*
301296
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
302297
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -327,9 +322,8 @@ public static char[] sample(char[] source, int k, char[] target) {
327322
* given source String. All n choose k combinations are equally
328323
* likely, where n is the length of the source String.</p>
329324
*
330-
* <p>This method chooses among the samplePool,
331-
* sampleReservoir, and sampleInsertion
332-
* methods based on the values of n and k.</p>
325+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
326+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
333327
*
334328
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
335329
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -360,9 +354,8 @@ public static char[] sample(String source, int k, char[] target) {
360354
* given source array. All n choose k combinations are equally
361355
* likely, where n is the length of the source array.</p>
362356
*
363-
* <p>This method chooses among the samplePool,
364-
* sampleReservoir, and sampleInsertion
365-
* methods based on the values of n and k.</p>
357+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
358+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
366359
*
367360
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
368361
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -393,9 +386,8 @@ public static double[] sample(double[] source, int k, double[] target) {
393386
* given source array. All n choose k combinations are equally
394387
* likely, where n is the length of the source array.</p>
395388
*
396-
* <p>This method chooses among the samplePool,
397-
* sampleReservoir, and sampleInsertion
398-
* methods based on the values of n and k.</p>
389+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
390+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
399391
*
400392
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
401393
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle
@@ -426,9 +418,8 @@ public static float[] sample(float[] source, int k, float[] target) {
426418
* given source array. All n choose k combinations are equally
427419
* likely, where n is the length of the source array.</p>
428420
*
429-
* <p>This method chooses among the samplePool,
430-
* sampleReservoir, and sampleInsertion
431-
* methods based on the values of n and k.</p>
421+
* <p>This method chooses among the {@link SequencePoolSampler}, {@link SequenceReservoirSampler},
422+
* and {@link SequenceInsertionSampler} classes based on the values of n and k.</p>
432423
*
433424
* <p>This approach combining reservoir sampling, pool sampling, and insertion sampling
434425
* was described in: Vincent A. Cicirello. 2022. <a href="https://www.cicirello.org/publications/applsci-12-05506.pdf">Cycle

0 commit comments

Comments
 (0)