[ 
https://issues.apache.org/jira/browse/MATH-1664?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17751288#comment-17751288
 ] 

Gilles Sadowski commented on MATH-1664:
---------------------------------------

bq. There doesn't seem to be any indication of what the various elements 
represent, either in the javadocs, [...]

Excerpt from the [API docs of 
{{GaussianFitter}}|https://commons.apache.org/proper/commons-math/javadocs/api-4.0-beta1/org/apache/commons/math4/legacy/fitting/GaussianCurveFitter.html]:
{noformat}
Fits points to a Gaussian function.
The initial guess values must be passed in the following order:

    Normalization
    Mean
    Sigma

The optimal values will be returned in the same order.
{noformat}

bq. [...] nor the source code.

The above is generated from the Javadoc in the [source 
code|https://github.com/apache/commons-math/blob/master/commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/GaussianCurveFitter.java].

bq. [...] have the interpolate method return a Map<String, Double> [...]

An array seemed the easiest way to return and use a very small set of values, 
in a known order (as per the documentation); using a map for this looks like 
overkill.

> interpolate should return Map<String, double> instead of double[]
> -----------------------------------------------------------------
>
>                 Key: MATH-1664
>                 URL: https://issues.apache.org/jira/browse/MATH-1664
>             Project: Commons Math
>          Issue Type: Improvement
>          Components: core
>    Affects Versions: 3.6.1
>            Reporter: Hasan Diwan
>            Priority: Minor
>
> It should be considered to have the interpolate method return a Map<String, 
> Double> (or Map<String, double> where the key would be a descriptive label of 
> what it means. There doesn't seem to be any indication of what the various 
> elements represent, either in the javadocs, nor the source code. 
> If someone would be so kind and tell me what the numbers represent, I am 
> willing to patch the project myself and issue a pull request.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to