[jira] Updated: (MATH-521) Changes in "HarmonicCoefficientsGuesser"

["Gilles (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/MATH-521?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Gilles updated MATH-521:
------------------------

    Attachment: example_LaTeXLet.tar.gz

This is an example IMO clearly demonstrating that a LaTeX equivalent of those ASCII structures would be

# incomparably easier to decypher in the source file, and
# be even more pleasant to read in the browser as a graphics file rendered by LaTeX.

I've just discovered "LaTeXLet" a tool that does what I had talked about on the ML a few weeks ago: A custom taglet that allows LaTeX in Javadoc and renders it as PNG.

Please have a look at the generated HTML doc (in the attachement) when run on the input file "DocSample.java" (also included).


> Changes in "HarmonicCoefficientsGuesser"
> ----------------------------------------
>
>                 Key: MATH-521
>                 URL: https://issues.apache.org/jira/browse/MATH-521
>             Project: Commons Math
>          Issue Type: Improvement
>            Reporter: Gilles
>            Assignee: Gilles
>            Priority: Minor
>              Labels: api-change, documentation
>             Fix For: 3.0
>
>         Attachments: example_LaTeXLet.tar.gz
>
>
> (1) The "guess" method throws "OptimizationException" when the algorithm fails to determine valid values for amplitude and angular frequency.
> There are no test showing how such a situation can occur.
> Moreover, since this procedure is used to provide an initial guess to an optimizer, it is better to pick any values for those parameters (e.g. zero) and let the optimizer proceed from that initial point.
> (2) The class javadoc seems very thorough in explaining the algorithm, but is quite unreadable in the source code, making it fairly useless for checking how the code complies with the comments. I think that this explanation should go in the user guide (and leave a mostly "plain text" outline of the algorithm, referring to the guide for details). [Does the format of the user guide allow such tricky (ASCII "art") constructs?]

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira