docs: update documentation for LogProbability functions

[wmchad]

This PR updates the documentation for a few of the functions that deal with LogProbability. The documentation should be more correct, but I think a more long term solution would involve changing the names of a few functions. In particular:

• or could be more appropriately named add or something similar. It is just used to add probabilities, which is appropriate for Pr(A or B) only if A and B are mutually independent. For independent events, Pr(A or B) = Pr(A) + Pr(B) - Pr(A)*Pr(B).
• aOrNotB could be more appropriately names subtract or similar. It is just used to subtract one probability from another.

fgbio/src/main/scala/com/fulcrumgenomics/util/NumericTypes.scala

Line 185 in 560f089

def and(values: Array[Double]): LogProbability = values.sum

Is there a reason this and function takes Array[Double] and not Array[LogProbability]?

[codecov-commenter]

Codecov Report

Merging #817 (92d078f) into main (560f089) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #817   +/-   ##
=======================================
  Coverage   95.58%   95.58%           
=======================================
  Files         122      122           
  Lines        7068     7068           
  Branches      511      511           
=======================================
  Hits         6756     6756           
  Misses        312      312           

Flag	Coverage Δ
unittests	95.58% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
.../scala/com/fulcrumgenomics/util/NumericTypes.scala	95.94% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 560f089...92d078f. Read the comment docs.

[nh13]

Thank-you for the doc updates, one minor suggestion!

[nh13]

Will merge once tests pass!

[nh13]

Thank-you @wmchad!