[Chapel Merge] Add documentation for renamed bigint methods

Branch: refs/heads/main
Revision: 4fcd1ff
Author: lydia-duncan
Link: Add documentation for renamed bigint methods by lydia-duncan · Pull Request #18918 · chapel-lang/chapel · GitHub
Log Message:

Merge pull request #18918 from lydia-duncan/docNewBigIntMethods

Add documentation for renamed bigint methods
[reviewed by @bmcdonald3]

The interface for these methods on the bigint type were recently improved considerably.
They were also missing documentation like the rest of the module, so add documentation
based heavily on the GMP functions they wrap, though obviously tweaked for the
functions with different return types and to reflect the different argument arrangement for
the Chapel versions.

GMP documentation can be found at Integer Functions (GNU MP 6.2.1)

Resolves Cray/chapel-private#2832

Adds documentation for:

  • removeFactor
  • isPerfectPower
  • isPerfectSquare
  • isEven
  • isOdd
  • probablyPrime
  • isDivisible
  • isDivisibleBy2Pow
  • isCongruent
  • isCongruentBy2Pow

Adjusts the documentation for divexact, which was already present and mostly in good
shape, but needed a few minor improvements (moved it to the last overload of the method,
clarified the description so the location of the result is more obvious, adjusts mentions of
bigint to link to the type itself, and expand the types listed for the denom argument to
include both supported types).

Double checked the built documentation and passed a full paratest

Modified Files:
M modules/standard/BigInteger.chpl

Compare: https://github.com/chapel-lang/chapel/compare/2f17396c0ad9...4fcd1ffb01ae