Mailing-List: contact dev-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Commons Developers List" <dev@commons.apache.org>
Received-SPF: pass (nike.apache.org: domain of
 SRS0=XiAc=G7=m4x.org=sebastien.brisard@bounces.m4x.org designates
 129.104.30.34 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <20120831124919.GM24856@dusk.harfang.homelinux.org>
References: <20120831031216.E0A7F23888E4@eris.apache.org>
	<20120831124919.GM24856@dusk.harfang.homelinux.org>
Date: Fri, 31 Aug 2012 15:52:10 +0200
Message-ID: 
 <CAGRH7HrKu6AVx7-cN6TQnHwkvERo56sxW2sUueUSjY9aVx1b8Q@mail.gmail.com>
Subject: Re: [Math] Formatting (Was: svn commit: r1379270 -
 /commons/proper/math/trunk/...)
From: =?ISO-8859-1?Q?S=E9bastien_Brisard?= <sebastien.brisard@m4x.org>
To: Commons Developers List <dev@commons.apache.org>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

Hi Gilles,

2012/8/31 Gilles Sadowski <gilles@harfang.homelinux.org>:
> Hello S=E9bastien.
>
>> Author: celestin
>> Date: Fri Aug 31 03:12:16 2012
>> New Revision: 1379270
>>
>> URL: http://svn.apache.org/viewvc?rev=3D1379270&view=3Drev
>> Log:
>> MATH-849: changed boundary case x =3D 8.0 in double Gamma.logGamma(doubl=
e).
>>
>> Modified:
>>     commons/proper/math/trunk/src/main/java/org/apache/commons/math3/spe=
cial/Gamma.java
>>
>> Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/mat=
h3/special/Gamma.java
>> URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/jav=
a/org/apache/commons/math3/special/Gamma.java?rev=3D1379270&r1=3D1379269&r2=
=3D1379270&view=3Ddiff
>> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D
>> --- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/spe=
cial/Gamma.java (original)
>> +++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/spe=
cial/Gamma.java Fri Aug 31 03:12:16 2012
>> @@ -222,9 +222,9 @@ public class Gamma {
>>       * Returns the value of log&nbsp;&Gamma;(x) for x&nbsp;&gt;&nbsp;0.
>>       * </p>
>>       * <p>
>> -     * For x &lt; 8, the implementation is based on the double precisio=
n
>> +     * For x &le; 8, the implementation is based on the double precisio=
n
>
> My personal taste would be to write this as
> ---
>  {@code x <=3D 8}
> ---
> [As I'm not an HTML parser,
>
I'm a bit disappointed by your poor parsing capabilities ;-)

> it always takes me a few moments to figure out a
> sequence such as "x &lt; 8", while it is easier to focus on the central p=
art
> of "{@code x <=3D 8}".]
>
> So, if nobody disagrees, this could become a formatting rule. [The ration=
ale
> (to be included in the document you proposed to create) would be that
> Javadoc comments should be as easy as possible to read in their source fo=
rm,
> for the developer's sake.]
>
Yeah, and it gets worse when I had to find a work around for the
decimal point not being interpreted as the end of the first sentence:
I ended up with something like
Returns the value of 1 / &Gamma;(1 + x) - 1 for -0&#46;5 &le; x &le;
1&#46;5. In case you wondered, &#46; is simply '.'. This is uggly, I
agree.

I was thinking this very morning of something like "HTML tags are
allowed as long as reading the source file is still reasonably easy".
I'm quite happy with a more radical approach, like "HTML text
formatting tags should be avoided as much as possible. Paragraph
formatting (<p>, <li>, <pre>, ... is allowed)". Note that it has not
been applied consistently in CM yet : in some parts, formulae are
formatted with HTML tags, in other parts, it's pure {@code }. I
contributed to this mess :-(
As sebb mentions {@code } prevents *any* formatting, but this would
not really be an issue. If needed, we can use <pre></pre> tags and
nice text-based equations (again, tools like Maxima can help a lot),
even if it looks old fashioned.

I'll write something up in the JIRA ticket, so that everyone can review it.

Thanks for this suggestion,

S=E9bastien
>
> Best regards,
> Gilles
>
>>       * implementation in the <em>NSWC Library of Mathematics Subroutine=
s</em>,
>> -     * {@code DGAMLN}. For x &ge; 8, the implementation is based on
>> +     * {@code DGAMLN}. For x &gt; 8, the implementation is based on
>>       * </p>
>>       * <ul>
>>       * <li><a href=3D"http://mathworld.wolfram.com/GammaFunction.html">=
Gamma
>> @@ -249,7 +249,7 @@ public class Gamma {
>>              return logGamma1p(x) - FastMath.log(x);
>>          } else if (x <=3D 2.5) {
>>              return logGamma1p((x - 0.5) - 0.5);
>> -        } else if (x < 8.0) {
>> +        } else if (x <=3D 8.0) {
>>              final int n =3D (int) FastMath.floor(x - 1.5);
>>              double prod =3D 1.0;
>>              for (int i =3D 1; i <=3D n; i++) {
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org