[jira] [Issue Comment Edited] (MATH-677) About package "transform"

["Sébastien Brisard (Issue Comment Edited JIRA)" <ji...@apache.org>]

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

Sébastien Brisard edited comment on MATH-677 at 1/2/12 7:20 AM:
----------------------------------------------------------------

h4. Exceptions
* remove references to {{MathRuntimeException}},
* throw more specific {{Math...Exception}} instances instead of standard {{IAE}}.

As discussed on the [mailing-list|http://mail-archives.apache.org/mod_mbox/commons-dev/201112.mbox/%3CCAGRH7Hq24t8O5hCPawVWFU1tOLAhcBrBjF%2BYh69zZivTnZRKFQ%40mail.gmail.com%3E], {{MathIllegalArgumentException}} (as opposed to more specific subclasses) are returned for non-power-of-two datasets.

(/) {{FastCosineTransformer}}: done in {{r1226359}}
(/) {{FastFourierTransformer}}: done in {{r1226053}}
(x) {{FastHadamardTransformer}}
(x) {{FastSineTransformer}}
                
      was (Author: celestin):
    h4. Exceptions
* remove references to {{MathRuntimeException}},
* throw more specific {{Math...Exception}} instances instead of standard {{IAE}}.

As discussed on the [mailing-list|http://mail-archives.apache.org/mod_mbox/commons-dev/201112.mbox/%3CCAGRH7Hq24t8O5hCPawVWFU1tOLAhcBrBjF%2BYh69zZivTnZRKFQ%40mail.gmail.com%3E], {{MathIllegalArgumentException}} (as opposed to more specific subclasses) are returned for non-power-of-two datasets.

(x) {{FastCosineTransformer}}: done in {{r1226359}}
(/) {{FastFourierTransformer}}: done in {{r1226053}}
(x) {{FastHadamardTransformer}}
(x) {{FastSineTransformer}}
                  
> About package "transform"
> -------------------------
>
>                 Key: MATH-677
>                 URL: https://issues.apache.org/jira/browse/MATH-677
>             Project: Commons Math
>          Issue Type: Improvement
>            Reporter: Gilles
>            Assignee: Sébastien Brisard
>            Priority: Minor
>              Labels: api-change
>             Fix For: 3.0
>
>
> Classes in package "o.a.c.m.transform" might require some changes in order to conform to goals set for the next major release.
> Some observations:
> # Exceptions
> ## Should remove use of deprecated "MathRuntimeException"
> ## Should throw more specific "Math...Exception" instances instead of standard IAE
> # Interface "RealTransformer" (and implementations) contain non-conformant method names (e.g. "inversetransform" instead of "inverseTransform"). {color:red}Fixed in {{r1208293}}.{color}
> # "FastFourierTransformer":
> ## Methods "mdfft" and "verifyDataSet" take an argument of type "Object" (to allow an argument with an unspecified number of dimensions)
> ## The "RootsOfUnity" helper class could be moved to the "complex" package
> ## For clarity, multidimensional transform should be moved to a class of its own (and I also wonder whether the "MultiDimensionalComplexMatrix" name is not misleading)
> # "FastFourierTransformer", "FastSineTranformer" and "FastCosineTranformer" define public methods "tranform2" and "inversetransform2" but they are not part of an interface. {color:red}As of {{r1213157}}, these methods have been removed, and replaced by factory methods {{create()}} and {{createUnitary()}} (FFT) or {{createOrthogonal()}} (FCT, FST).{color}
> # Code uses variables that start with an uppercase. {color:red}Fixed, together with various formatting issues.{color}
> # "FastHadamardTransformer" contains illegible developer documentation (see Javadoc for protected method "fht"). {color:red}Tried to improve things in {{r1208986}}, but things are still a bit obscure. Besides, the link provided is broken. Will look into that.{color}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira