This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch complex-gsoc-2022
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git
The following commit(s) were added to refs/heads/complex-gsoc-2022 by this push:
new 66a8e69d Update javadoc for proj function
66a8e69d is described below
commit 66a8e69d4931e55dee30f814323435f0d118e88e
Author: aherbert <aherb...@apache.org>
AuthorDate: Wed Jul 27 11:53:29 2022 +0100
Update javadoc for proj function
---
.../java/org/apache/commons/numbers/complex/ComplexFunctions.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git
a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/ComplexFunctions.java
b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/ComplexFunctions.java
index 6dd614fb..1b7445f4 100644
---
a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/ComplexFunctions.java
+++
b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/ComplexFunctions.java
@@ -378,9 +378,9 @@ public final class ComplexFunctions {
* <p>\( z \) projects to \( z \), except that all complex infinities
(even those
* with one infinite part and one NaN part) project to positive infinity
on the real axis.
*
- * <p>If \( z \) has an infinite part, then {@code z.proj()} shall be
equivalent to:
+ * <p>If \( z \) has an infinite part, then the projection shall be
equivalent to:
*
- * <pre>return Complex.ofCartesian(Double.POSITIVE_INFINITY,
Math.copySign(0.0, z.imag());</pre>
+ * <pre>(Double.POSITIVE_INFINITY, Math.copySign(0.0, imaginary))</pre>
*
* @param real Real part \( a \) of the complex number \( (a +ib) \).
* @param imaginary Imaginary part \( b \) of the complex number \( (a
+ib) \).
