Skip to content

NUMBERS-194: GCD JavaDoc mention coprimes check#133

Closed
orionlibs wants to merge 6 commits intoapache:masterfrom
orionlibs:NUMB-194]-JavaDoc-coprime-ArithmeticUtils-gcd
Closed

NUMBERS-194: GCD JavaDoc mention coprimes check#133
orionlibs wants to merge 6 commits intoapache:masterfrom
orionlibs:NUMB-194]-JavaDoc-coprime-ArithmeticUtils-gcd

Conversation

@orionlibs
Copy link
Copy Markdown
Contributor

@orionlibs orionlibs commented Jul 13, 2023

NUMB-194 Changed JavaDoc of the GCD methods to mention that they can be used to determine if 2 numbers are relatively prime or coprime

…n be used to determine if 2 numbers are relatively prime or coprime
It explains how GCD can be used to determine if 2 numbers are relatively prime or coprime
@aherbert aherbert changed the title [NUMB-194] GCD JavaDoc mention coprimes check NUMBERS-194: GCD JavaDoc mention coprimes check Jul 13, 2023
* for the special cases above.</li>
* <li>The invocation {@code gcd(0, 0)} is the only one which returns
* {@code 0}.</li>
* <li>gcd can be used to determine if two numbers are relatively prime.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has been added as a special case. It is not a special case, it is a usage example. It should be moved to a new paragraph, e.g.

<p>Two numbers are relatively prime, or coprime, if their gcd is 1.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aherbert fixed JavaDoc

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

Merging #133 (c9e905f) into master (4471386) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #133   +/-   ##
=========================================
  Coverage     99.14%   99.14%           
  Complexity     1681     1681           
=========================================
  Files            65       65           
  Lines          4305     4305           
  Branches        854      854           
=========================================
  Hits           4268     4268           
  Misses           10       10           
  Partials         27       27           
Impacted Files Coverage Δ
...g/apache/commons/numbers/core/ArithmeticUtils.java 99.40% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@asfgit asfgit closed this in 0437008 Jul 17, 2023
@orionlibs orionlibs deleted the NUMB-194]-JavaDoc-coprime-ArithmeticUtils-gcd branch July 17, 2023 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants