This is an automated email from the ASF dual-hosted git repository. aherbert pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-numbers.git
commit 055e06fe2c96fb2512dd89cdf4db384cf9b08e7a Author: Alex Herbert <[email protected]> AuthorDate: Tue Aug 25 13:47:08 2026 +0100 Add summary javadoc --- .../main/java/org/apache/commons/numbers/angle/Angle.java | 7 ++++--- .../apache/commons/numbers/arrays/KeyUpdatingInterval.java | 2 +- .../java/org/apache/commons/numbers/arrays/SortInPlace.java | 10 ++++++---- .../apache/commons/numbers/combinatorics/Combinations.java | 8 ++++---- .../java/org/apache/commons/numbers/complex/Complex.java | 8 ++++++-- .../src/main/java/org/apache/commons/numbers/core/Norm.java | 13 +++++++------ .../main/java/org/apache/commons/numbers/field/FP64.java | 2 +- .../numbers/fraction/GeneralizedContinuedFraction.java | 2 +- .../org/apache/commons/numbers/quaternion/Quaternion.java | 12 ++++++------ .../java/org/apache/commons/numbers/quaternion/Slerp.java | 2 +- 10 files changed, 37 insertions(+), 29 deletions(-) diff --git a/commons-numbers-angle/src/main/java/org/apache/commons/numbers/angle/Angle.java b/commons-numbers-angle/src/main/java/org/apache/commons/numbers/angle/Angle.java index 2f50e816..cb216ce7 100644 --- a/commons-numbers-angle/src/main/java/org/apache/commons/numbers/angle/Angle.java +++ b/commons-numbers-angle/src/main/java/org/apache/commons/numbers/angle/Angle.java @@ -37,14 +37,15 @@ public abstract class Angle implements DoubleSupplier { /** Value (unit depends on concrete instance). */ private final double value; - /** + /** Create an instance. * @param value Value in turns. */ Angle(final double value) { this.value = value; } - /** @return the value. */ + /** {@inheritDoc} + * @return the value. */ @Override public double getAsDouble() { return value; @@ -301,7 +302,7 @@ public abstract class Angle implements DoubleSupplier { reduce = new Reduce(lo, period); } - /** + /** {@inheritDoc} * @param a Angle. * @return {@code = a - k} where {@code k} is an integer that satisfies * {@code lo <= a - k < lo + period}. diff --git a/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/KeyUpdatingInterval.java b/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/KeyUpdatingInterval.java index aa07c29a..8d670b73 100644 --- a/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/KeyUpdatingInterval.java +++ b/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/KeyUpdatingInterval.java @@ -47,7 +47,7 @@ final class KeyUpdatingInterval implements UpdatingInterval { this(indices, 0, n - 1); } - /** + /** Create an instance. * @param indices Indices. * @param l Index of left key. * @param r Index of right key. diff --git a/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/SortInPlace.java b/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/SortInPlace.java index 0e2eccff..5478adf9 100644 --- a/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/SortInPlace.java +++ b/commons-numbers-arrays/src/main/java/org/apache/commons/numbers/arrays/SortInPlace.java @@ -47,7 +47,7 @@ public enum SortInPlace { /** Comparator. */ private final Comparator<PairDoubleInteger> comparator; - /** + /** Create an instance. * @param comparator Comparator. */ SortInPlace(Comparator<PairDoubleInteger> comparator) { @@ -115,7 +115,7 @@ public enum SortInPlace { /** Value. */ private final int value; - /** + /** Create an instance. * @param key Key. * @param value Value. */ @@ -125,12 +125,14 @@ public enum SortInPlace { this.value = value; } - /** @return the key. */ + /** Get the key. + * @return the key. */ double key() { return key; } - /** @return the value. */ + /** Get the value. + * @return the value. */ int value() { return value; } diff --git a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/Combinations.java b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/Combinations.java index 5c756736..667872ab 100644 --- a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/Combinations.java +++ b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/Combinations.java @@ -36,7 +36,7 @@ public final class Combinations implements Iterable<int[]> { /** Number of elements in each combination. */ private final int k; - /** + /** Create an instance. * @param n Size of the set from which subsets are selected. * @param k Size of the subsets to be enumerated. * @throws IllegalArgumentException if {@code n < 0}. @@ -255,7 +255,7 @@ public final class Combinations implements Iterable<int[]> { SingletonIterator(final int n) { this.n = n; } - /** + /** {@inheritDoc} * @return {@code true} until next is called the first time, * then {@code false}. **/ @@ -263,7 +263,7 @@ public final class Combinations implements Iterable<int[]> { public boolean hasNext() { return more; } - /** + /** {@inheritDoc} * @return the singleton at the first activation. * @throws NoSuchElementException after the first activation. */ @@ -309,7 +309,7 @@ public final class Combinations implements Iterable<int[]> { /** Number of elements in each combination. */ private final int k; - /** + /** Create an instance. * @param n Size of the set from which subsets are selected. * @param k Size of the subsets to be enumerated. */ diff --git a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java index 8f1e05f3..f9f3bae2 100644 --- a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java +++ b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java @@ -874,7 +874,9 @@ public final class Complex implements Serializable { } /** - * Returns a {@code Complex} whose value is: + * Compute the multiplication of two complex numbers. + * + * <p>Returns a {@code Complex} whose value is: * <pre> * (a + i b)(c + i d) = (ac - bd) + i (ad + bc)</pre> * @@ -1070,7 +1072,9 @@ public final class Complex implements Serializable { } /** - * Returns a {@code Complex} whose value is: + * Compute the division of two complex numbers. + * + * <p>Returns a {@code Complex} whose value is: * <pre> * <code> * a + i b (ac + bd) + i (bc - ad) diff --git a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/Norm.java b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/Norm.java index a34520d3..055d0bb4 100644 --- a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/Norm.java +++ b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/Norm.java @@ -82,7 +82,7 @@ public enum Norm { /** Function of 2 arguments. */ @FunctionalInterface private interface Two { - /** + /** Compute the norm of the arguments. * @param x Argument. * @param y Argument. * @return the norm. @@ -92,7 +92,7 @@ public enum Norm { /** Function of 3 arguments. */ @FunctionalInterface private interface Three { - /** + /** Compute the norm of the arguments. * @param x Argument. * @param y Argument. * @param z Argument. @@ -103,14 +103,14 @@ public enum Norm { /** Function of array argument. */ @FunctionalInterface private interface Array { - /** + /** Compute the norm of the array. * @param v Array of arguments. * @return the norm. */ double of(double[] v); } - /** + /** Create an instance. * @param two Function of 2 arguments. * @param three Function of 3 arguments. * @param array Function of array argument. @@ -123,7 +123,7 @@ public enum Norm { this.array = array; } - /** + /** Create an instance. * @param alias Alternative name. */ Norm(Norm alias) { @@ -548,7 +548,8 @@ public enum Norm { return max; } - /** + /** Check the array is not empty. + * * @param a Array. * @throws IllegalArgumentException for zero-size array. */ diff --git a/commons-numbers-field/src/main/java/org/apache/commons/numbers/field/FP64.java b/commons-numbers-field/src/main/java/org/apache/commons/numbers/field/FP64.java index fe1c6e63..4f06ef25 100644 --- a/commons-numbers-field/src/main/java/org/apache/commons/numbers/field/FP64.java +++ b/commons-numbers-field/src/main/java/org/apache/commons/numbers/field/FP64.java @@ -34,7 +34,7 @@ public final class FP64 extends Number /** Value. */ private final double value; - /** + /** Create an instance. * @param value Value. */ private FP64(double value) { diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java index 130f772d..0b5a0882 100644 --- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java +++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java @@ -102,7 +102,7 @@ public final class GeneralizedContinuedFraction { /** "b" coefficient. */ private final double b; - /** + /** Create an instance. * @param a "a" coefficient * @param b "b" coefficient */ diff --git a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java index 5d5364df..a8dfacc4 100644 --- a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java +++ b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java @@ -120,7 +120,7 @@ public final class Quaternion implements Serializable { static final BiPredicate<Quaternion, Double> IS_UNIT = (q, eps) -> true; } - /** + /** Create an instance. * @param normSq {@code normSq} method. * @param norm {@code norm} method. * @param isUnit {@code isUnit} method. @@ -133,21 +133,21 @@ public final class Quaternion implements Serializable { this.testIsUnit = isUnit; } - /** + /** Compute the norm-squared of the quaternion. * @param q Quaternion. * @return the norm squared. */ double normSq(Quaternion q) { return normSq.applyAsDouble(q); } - /** + /** Compute the norm of the quaternion. * @param q Quaternion. * @return the norm. */ double norm(Quaternion q) { return norm.applyAsDouble(q); } - /** + /** Test if the quaternion has a unit norm. * @param q Quaternion. * @param eps Tolerance. * @return whether {@code q} has unit norm within the allowed tolerance. @@ -714,14 +714,14 @@ public final class Quaternion implements Serializable { /** Serializable version identifier. */ private static final long serialVersionUID = 20181128L; - /** + /** Create an instance. * @param msg Error message. */ QuaternionParsingException(String msg) { super(msg); } - /** + /** Create an instance. * @param msg Error message. * @param cause Cause of the exception. */ diff --git a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java index c20d5920..b0a76329 100644 --- a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java +++ b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java @@ -125,7 +125,7 @@ public class Slerp implements DoubleFunction<Quaternion> { /** Sine of {@link #theta}. */ private final double sinTheta; - /** + /** Create an instance. * @param dot Dot product of the start and end quaternions. */ Spherical(double dot) {
