-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #42 from OnixByte/release/1.6.5
v1.6.5
- Loading branch information
Showing
8 changed files
with
286 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| plugins { | ||
| id("java") | ||
| } | ||
|
|
||
| group = "com.onixbyte" | ||
| version = "unspecified" | ||
|
|
||
| repositories { | ||
| mavenCentral() | ||
| } | ||
|
|
||
| dependencies { | ||
| testImplementation(platform("org.junit:junit-bom:5.10.0")) | ||
| testImplementation("org.junit.jupiter:junit-jupiter") | ||
| } | ||
|
|
||
| tasks.test { | ||
| useJUnitPlatform() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
num4j/src/main/java/com/onixbyte/nums/PercentileCalculator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| * Copyright (C) 2024 OnixByte. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.onixbyte.nums; | ||
|
|
||
| import com.onixbyte.nums.model.QuartileBounds; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * A utility class that provides methods for calculating percentiles and interquartile range (IQR) bounds | ||
| * for a dataset. | ||
| * <p> | ||
| * This class contains static methods to: | ||
| * <ul> | ||
| * <li>Calculate a specified percentile from a list of double values using linear interpolation.</li> | ||
| * <li>Calculate interquartile bounds (Q1, Q3) and the corresponding lower and upper bounds, | ||
| * which can be used to identify outliers in the dataset.</li> | ||
| * </ul> | ||
| * <p> | ||
| * This class is final, meaning it cannot be subclassed, and it only contains static methods, | ||
| * so instances of the class cannot be created. | ||
| * </p> | ||
| * <h2>Example usage:</h2> | ||
| * <pre> | ||
| * {@code | ||
| * List<Double> data = Arrays.asList(1.0, 2.0, 3.0, 4.0, 5.0); | ||
| * Double percentileValue = PercentileCalculator.calculatePercentile(data, 50.0); // Calculates median | ||
| * QuartileBounds bounds = PercentileCalculator.calculatePercentileBounds(data); // Calculates IQR bounds | ||
| * } | ||
| * </pre> | ||
| * | ||
| * @author zihluwang | ||
| * @version 1.6.5 | ||
| * @since 1.6.5 | ||
| */ | ||
| public final class PercentileCalculator { | ||
|
|
||
| /** | ||
| * Calculates the specified percentile from a list of values. | ||
| * <p> | ||
| * This method takes a list of double values and calculates the given percentile using linear interpolation between | ||
| * the two closest ranks. The list is first sorted in ascending order, and the specified percentile is | ||
| * then calculated. | ||
| * | ||
| * @param values a list of {@code Double} values from which the percentile is calculated. | ||
| * @param percentile a {@code Double} representing the percentile to be calculated (e.g., 50.0 for the median) | ||
| * @return a {@code Double} value representing the calculated percentile | ||
| */ | ||
| public static Double calculatePercentile(List<Double> values, Double percentile) { | ||
| var sorted = values.stream().sorted().toList(); | ||
| if (sorted.isEmpty()) { | ||
| throw new IllegalArgumentException("Unable to sort an empty list."); | ||
| } | ||
|
|
||
| var rank = percentile / 100. * (sorted.size() - 1); | ||
| var lowerIndex = (int) Math.floor(rank); | ||
| var upperIndex = (int) Math.ceil(rank); | ||
| var weight = rank - lowerIndex; | ||
|
|
||
| return sorted.get(lowerIndex) * (1 - weight) + sorted.get(upperIndex) * weight; | ||
| } | ||
|
|
||
| /** | ||
| * Calculates the interquartile range (IQR) and the corresponding lower and upper bounds | ||
| * based on the first (Q1) and third (Q3) quartiles of a dataset. | ||
| * <p> | ||
| * This method takes a list of double values, calculates the first quartile (Q1), | ||
| * the third quartile (Q3), and the interquartile range (IQR). Using the IQR, it computes | ||
| * the lower and upper bounds, which can be used to detect outliers in the dataset. | ||
| * The lower bound is defined as {@code Q1 - 1.5 * IQR}, and the upper bound is defined as | ||
| * {@code Q3 + 1.5 * IQR}. | ||
| * | ||
| * @param data a list of {@code Double} values for which the quartile bounds will be calculated | ||
| * @return a {@code QuartileBounds} object containing the calculated lower and upper bounds | ||
| */ | ||
| public static QuartileBounds calculatePercentileBounds(List<Double> data) { | ||
| var sorted = data.stream().sorted().toList(); | ||
| var Q1 = calculatePercentile(sorted, 25.); | ||
| var Q3 = calculatePercentile(sorted, 75.); | ||
|
|
||
| var IQR = Q3 - Q1; | ||
|
|
||
| var lowerBound = Q1 - 1.5 * IQR; | ||
| var upperBound = Q3 + 1.5 * IQR; | ||
|
|
||
| return QuartileBounds.builder() | ||
| .upperBound(upperBound) | ||
| .lowerBound(lowerBound) | ||
| .build(); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.