From 4747f67f0363d42694bb86b37b9a44de0ca1e383 Mon Sep 17 00:00:00 2001 From: Lee Rhodes <leerho@users.noreply.github.com> Date: Thu, 16 Nov 2023 14:23:36 -0800 Subject: [PATCH] Fix javadoc issues. --- .../quantilescommon/GenericPartitionBoundaries.java | 12 ++++++------ .../quantilescommon/PartitioningFeature.java | 6 ++++-- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.java b/src/main/java/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.java index 733f7846d..4db851460 100644 --- a/src/main/java/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.java +++ b/src/main/java/org/apache/datasketches/quantilescommon/GenericPartitionBoundaries.java @@ -83,17 +83,17 @@ public GenericPartitionBoundaries( * <p>If these results were computed using QuantileSearchCriteria.INCLUSIVE then these sequential boundaries * are to be interpreted as follows: * <ul> - * <li>Partition 1: include all items >= index 0 and <= index 1.</li> - * <li>Partition 2: include all items > index 1 and <= index 2.</li> - * <li>Partition N: include all items > index N-1 and <= index N.</li> + * <li>Partition 1: include all items ≥ index 0 and ≤ index 1.</li> + * <li>Partition 2: include all items > index 1 and ≤ index 2.</li> + * <li>Partition N: include all items > index N-1 and ≤ index N.</li> * </ul> * * <p>If these results were computed using QuantileSearchCriteria.EXCLUSIVE then these sequential boundaries * are to be interpreted as follows: * <ul> - * <li>Partition 1: include all items >= index 0 and < index 1.</li> - * <li>Partition 2: include all items >= index 1 and < index 2.</li> - * <li>Partition N: include all items >= index N-1 and <= index N.</li> + * <li>Partition 1: include all items ≥ index 0 and < index 1.</li> + * <li>Partition 2: include all items ≥ index 1 and < index 2.</li> + * <li>Partition N: include all items ≥ index N-1 and ≤ index N.</li> * </ul> * * @return an array of boundaries that sequentially define the upper and lower boundaries of partitions. diff --git a/src/main/java/org/apache/datasketches/quantilescommon/PartitioningFeature.java b/src/main/java/org/apache/datasketches/quantilescommon/PartitioningFeature.java index 3ff51a3b4..2c36bb10a 100644 --- a/src/main/java/org/apache/datasketches/quantilescommon/PartitioningFeature.java +++ b/src/main/java/org/apache/datasketches/quantilescommon/PartitioningFeature.java @@ -37,7 +37,8 @@ public interface PartitioningFeature<T> { * </p> * * @param numEquallySized an integer that specifies the number of equally sized partitions between - * {@link #getMinItem() getMinItem()} and {@link #getMaxItem() getMaxItem()}. + * {@link GenericPartitionBoundaries#getMinItem() getMinItem()} and + * {@link GenericPartitionBoundaries#getMaxItem() getMaxItem()}. * This must be a positive integer greater than zero. * <ul> * <li>A 1 will return: minItem, maxItem.</li> @@ -60,7 +61,8 @@ default GenericPartitionBoundaries<T> getPartitionBoundaries(int numEquallySized * refers to an approximately equal number of items per partition. * * @param numEquallySized an integer that specifies the number of equally sized partitions between - * {@link #getMinItem() getMinItem()} and {@link #getMaxItem() getMaxItem()}. + * {@link GenericPartitionBoundaries#getMinItem() getMinItem()} and + * {@link GenericPartitionBoundaries#getMaxItem() getMaxItem()}. * This must be a positive integer greater than zero. * <ul> * <li>A 1 will return: minItem, maxItem.</li>