[commons-numbers] branch master updated: NUMBERS-194: Javadoc.

[aherbert]

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


The following commit(s) were added to refs/heads/master by this push:
     new 0437008e NUMBERS-194: Javadoc.
0437008e is described below

commit 0437008ed3e901ce70090542855c2a51731d1638
Author: Dimitrios Efthymiou <efthymiou.dimitri...@gmail.com>
AuthorDate: Tue Jul 18 00:13:28 2023 +0100

    NUMBERS-194: Javadoc.
    
    Explain how to determine whether two numbers are relative primes 
("coprime").
    
    Closes #133
---
 .../main/java/org/apache/commons/numbers/core/ArithmeticUtils.java    | 4 ++++
 1 file changed, 4 insertions(+)

diff --git 
a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ArithmeticUtils.java
 
b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ArithmeticUtils.java
index 11c55147..d3d51fff 100644
--- 
a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ArithmeticUtils.java
+++ 
b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ArithmeticUtils.java
@@ -60,6 +60,8 @@ public final class ArithmeticUtils {
      *   {@code 0}.</li>
      * </ul>
      *
+     * <p>Two numbers are relatively prime, or coprime, if their gcd is 1.</p>
+     *
      * @param p Number.
      * @param q Number.
      * @return the greatest common divisor (never negative).
@@ -132,6 +134,8 @@ public final class ArithmeticUtils {
      * {@code 0L}.</li>
      * </ul>
      *
+     * <p>Two numbers are relatively prime, or coprime, if their gcd is 1.</p>
+     *
      * @param p Number.
      * @param q Number.
      * @return the greatest common divisor, never negative.