NUMBERS-133: Rename method potentialPrimes(int) to potentialPrimesGTE…

…(int)
apache · Schamschi · Jul 24, 2019 · Jul 24, 2019 · Jul 25, 2019 · Jul 25, 2019
commit a2e75b76d53f93d16a67e8477bef61895d482662
diff --git a/commons-numbers-primes/src/main/java/org/apache/commons/numbers/primes/Primes.java b/commons-numbers-primes/src/main/java/org/apache/commons/numbers/primes/Primes.java
@@ -80,7 +80,7 @@ public static int nextPrime(int n) {
             }
             return SmallPrimes.PRIMES[index];
         } else {
-            PrimitiveIterator.OfInt potentialPrimesIterator = SmallPrimes.potentialPrimes(n);
+            PrimitiveIterator.OfInt potentialPrimesIterator = SmallPrimes.potentialPrimesGTE(n);
             while (true) {
                 // Integer.MAX_VALUE is a prime number, so no risk of overflow
                 int candidate = potentialPrimesIterator.next();

diff --git a/commons-numbers-primes/src/main/java/org/apache/commons/numbers/primes/SmallPrimes.java b/commons-numbers-primes/src/main/java/org/apache/commons/numbers/primes/SmallPrimes.java
@@ -89,7 +89,7 @@ class SmallPrimes {
      * {@code product - 1}, because if {@code product ≡ 0 mod p}, then
      * {@code product - 1 ≡ -1 mod p}, and {@code 0 ≢ -1 mod p} for any prime number p.</p>
      *
-     * @see #potentialPrimes(int)
+     * @see #potentialPrimesGTE(int)
      */
     static final Entry<Set<Integer>, int[]> PRIME_NUMBERS_AND_COPRIME_EQUIVALENCE_CLASSES;
 
@@ -175,7 +175,7 @@ static int smallTrialDivision(int n,
     static int boundedTrialDivision(int n,
                                     int maxFactor,
                                     List<Integer> factors) {
-        PrimitiveIterator.OfInt potentialPrimesIterator = potentialPrimes(PRIMES_LAST + 2);
+        PrimitiveIterator.OfInt potentialPrimesIterator = potentialPrimesGTE(PRIMES_LAST + 2);
 
         boolean done = false;
         while (!done) {
@@ -266,7 +266,7 @@ static boolean millerRabinPrimeTest(final int n) {
 
     /**
      * Returns an iterator that iterates, in ascending oder, over all positive
-     * integers greater than or equal to the passed lower bound, skipping
+     * integers greater than or equal to ("GTE") the passed lower bound, skipping
      * numbers that are a multiple of any of the prime numbers contained in the
      * key of {@link #PRIME_NUMBERS_AND_COPRIME_EQUIVALENCE_CLASSES}.
      *
@@ -282,7 +282,7 @@ static boolean millerRabinPrimeTest(final int n) {
      * @param lowerBound the lower bound for the iteration results
      * @return an iterator as described above
      */
-    static PrimitiveIterator.OfInt potentialPrimes(final int lowerBound) {
+    static PrimitiveIterator.OfInt potentialPrimesGTE(final int lowerBound) {
         /*
          * The numbers that should be iterated over are of the form k*m + c,
          * where k >= 0, m is the least common multiple, that is, the product of

diff --git a/commons-numbers-primes/src/test/java/org/apache/commons/numbers/primes/SmallPrimesTest.java b/commons-numbers-primes/src/test/java/org/apache/commons/numbers/primes/SmallPrimesTest.java
@@ -151,7 +151,7 @@ public void testPotentialPrimes() {
     }
 
     private void testPotentialPrimes(int lowerBound, int maxIterations) {
-        PrimitiveIterator.OfInt potentialPrimesIterator = SmallPrimes.potentialPrimes(lowerBound);
+        PrimitiveIterator.OfInt potentialPrimesIterator = SmallPrimes.potentialPrimesGTE(lowerBound);
 
         int iterationCount = 0;
         boolean overflow = false;