From commits-return-71596-archive-asf-public=cust-asf.ponee.io@commons.apache.org Thu Jan 2 15:04:46 2020 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 4B3F6180647 for ; Thu, 2 Jan 2020 16:04:46 +0100 (CET) Received: (qmail 79688 invoked by uid 500); 2 Jan 2020 15:04:43 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 79481 invoked by uid 99); 2 Jan 2020 15:04:43 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 02 Jan 2020 15:04:43 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id F13808D815; Thu, 2 Jan 2020 15:04:42 +0000 (UTC) Date: Thu, 02 Jan 2020 15:04:46 +0000 To: "commits@commons.apache.org" Subject: [commons-numbers] 04/04: Javadoc cleanup of 
 tags for better
 rendered layout.
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
From: aherbert@apache.org
In-Reply-To: <157797748283.4858.7793634578566204218@gitbox.apache.org>
References: <157797748283.4858.7793634578566204218@gitbox.apache.org>
X-Git-Host: gitbox.apache.org
X-Git-Repo: commons-numbers
X-Git-Refname: refs/heads/master
X-Git-Reftype: branch
X-Git-Rev: 6361a80f3910921f8854c15ea5e854f510e208e7
X-Git-NotificationType: diff
X-Git-Multimail-Version: 1.5.dev
Auto-Submitted: auto-generated
Message-Id: <20200102150442.F13808D815@gitbox.apache.org>

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git

commit 6361a80f3910921f8854c15ea5e854f510e208e7
Author: Alex Herbert 
AuthorDate: Thu Jan 2 14:06:19 2020 +0000

    Javadoc cleanup of 
 tags for better rendered layout.
---
 .../apache/commons/numbers/complex/Complex.java    | 45 +++++++++-------------
 1 file changed, 19 insertions(+), 26 deletions(-)

diff --git a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
index bee566b..202cc1d 100644
--- a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
+++ b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
@@ -92,7 +92,7 @@ public final class Complex implements Serializable  {
      * {@code 1 + EPSILON} is numerically equal to 1. This value is an upper
      * bound on the relative error due to rounding real numbers to double
      * precision floating-point numbers.
-     * 
+     *
      * 
In IEEE 754 arithmetic, this is 2-53.
      * Copied from o.a.c.numbers.Precision.
      *
@@ -224,10 +224,11 @@ public final class Complex implements Serializable  {
      *
      * 
A non-NaN complex number constructed using this method will satisfy the following
      * to within floating-point error when {@code theta} is in the range
-     * \( -\pi\ \lt \theta \leq \pi \):

+     * \( -\pi\ \lt \theta \leq \pi \):
+     *
      * 
      *  Complex.ofPolar(rho, theta).abs() == rho
-     *  Complex.ofPolar(rho, theta).arg() == theta 

+     *  Complex.ofPolar(rho, theta).arg() == theta

      *
      * 
If {@code rho} is infinite then the resulting parts may be infinite or NaN
      * following the rules for double arithmetic, for example:

@@ -292,8 +293,7 @@ public final class Complex implements Serializable  {
      * "(0.0,0.0)"         = Complex.ofCartesian(0, 0)
      * "(-0.0, 0.0)"       = Complex.ofCartesian(-0.0, 0)
      * "(-1.23, 4.56)"     = Complex.ofCartesian(-123, 4.56)
-     * "(1e300,-1.1e-2)"   = Complex.ofCartesian(1e300, -1.1e-2)
-     *
+ * "(1e300,-1.1e-2)" = Complex.ofCartesian(1e300, -1.1e-2) * * @param s String representation. * @return {@code Complex} number. @@ -406,10 +406,9 @@ public final class Complex implements Serializable { *

\( 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. * - * If \( z \) has an infinite part, then {@code z.proj()} shall be equivalent to:

- * 
-     *   return Complex.ofCartesian(Double.POSITIVE_INFINITY, Math.copySign(0.0, z.imag());
-     *
+ * If \( z \) has an infinite part, then {@code z.proj()} shall be equivalent to: + * + * 
return Complex.ofCartesian(Double.POSITIVE_INFINITY, Math.copySign(0.0, z.imag());
* * @return \( z \) projected onto the Riemann sphere. * @see #isInfinite() @@ -760,7 +759,7 @@ public final class Complex implements Serializable { * value of {@code c1.equals(c2)} is {@code true} if and only if * * 
-     * {@code c1.getReal() == c2.getReal() && c1.getImaginary() == c2.getImaginary()}
+ * {@code c1.getReal() == c2.getReal() && c1.getImaginary() == c2.getImaginary()} * *

also has the value {@code true}. However, there are exceptions: * @@ -813,9 +812,9 @@ public final class Complex implements Serializable { * *

The behavior is the same as if the components of the complex number were passed * to {@link java.util.Arrays#hashCode(double[]) Arrays.hashCode(double[])}: + * * 

-     *  {@code Arrays.hashCode(new double[] {getReal(), getImaginary()})}
-     *
+ * {@code Arrays.hashCode(new double[] {getReal(), getImaginary()})} * * @return A hash code value for this object. * @see java.util.Arrays#hashCode(double[]) Arrays.hashCode(double[]) @@ -882,8 +881,7 @@ public final class Complex implements Serializable { /** * Returns a {@code Complex} whose value is: * 
-     *   (a + i b)(c + i d) = (ac - bd) + i (ad + bc)
-     *
+ * (a + i b)(c + i d) = (ac - bd) + i (ad + bc) * *

Recalculates to recover infinities as specified in C99 standard G.5.1. * @@ -2099,9 +2097,9 @@ public final class Complex implements Serializable { /** * Returns the logarithm of this complex number using the provided function. * Implements the formula: + * * 

-     *   log(x + i y) = log(|x + i y|) + i arg(x + i y)
-     *
+ * log(x + i y) = log(|x + i y|) + i arg(x + i y) * *

Warning: The argument {@code logOf2} must be equal to {@code log(2)} using the * provided log function otherwise scaling using powers of 2 in the case of overflow @@ -2641,11 +2639,9 @@ public final class Complex implements Serializable { * Safely compute {@code cos(2*a)} when {@code a} is finite. * Note that {@link Math#cos(double)} returns NaN when the input is infinite. * If {@code 2*a} is finite use {@code Math.cos(2*a)}; otherwise use the identity: + * * 

-     * 
-     *   cos(2a) = 2 cos2(a) - 1
-     * 
-     *
+ * cos(2a) = 2 cos2(a) - 1 * * @param a Angle a. * @return The cosine of 2a. @@ -2664,11 +2660,9 @@ public final class Complex implements Serializable { * Safely compute {@code sin(2*a)} when {@code a} is finite. * Note that {@link Math#sin(double)} returns NaN when the input is infinite. * If {@code 2*a} is finite use {@code Math.sin(2*a)}; otherwise use the identity: + * * 
-     * 
-     *   sin(2a) = 2 sin(a) cos(a)
-     * 
-     *
+ * sin(2a) = 2 sin(a) cos(a) * * @param a Angle a. * @return The sine of 2a. @@ -2823,8 +2817,7 @@ public final class Complex implements Serializable { * equivalent of: * * 
-     *   z = new Complex(real, imaginary).multiplyImaginary(-1);
-     *
+ * z = new Complex(real, imaginary).multiplyImaginary(-1); * * @param real Real part. * @param imaginary Imaginary part.