[
https://issues.apache.org/jira/browse/MATH-851?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13439277#comment-13439277
]
Sébastien Brisard commented on MATH-851:
----------------------------------------
Hi Clemens,
thanks for this contribution.
Regarding formatting. The first sentence of a javadoc comment should always end
with '.'. This allows the {{javadoc}} tool to extract this first sentence,
which is shown in the various summaries. See [How to Write Doc Comments for the
Javadoc
Tool|http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#firstsentence]
-- Side note: although this is not required in CM, I personally try to comply
as much as possible with this document: for example, description of arguments
should begin with "the", no capital letter, and should not end with '.' ; there
are dozens more useless conventions which help having a consistent style. Feel
free to *not* adopt them ;) The one I was referring to first *should* be
applied.
Regarding the content. I think more details should be given in the Javadoc.
* You should first state that this method does not use the FFT, and should
therefore be used only with small kernels (BTW, it would be good to state which
is which)
* Also, boundary conditions should be stated explicitely. If I understand
correctly, the data {{x[i]}} is zero outside the domain {{i = 0, ..., x.length
- 1}}. This is perfectly acceptable, but other conventions could be adopted
(linear extrapolation, periodization, ...), so that's something that must be
clearly explained.
Finally: do you intend to add other methods to class {{FilterUtils}}. If yes,
which ones? Maybe we should think about that before we include this new class.
Thanks for your involvement.
Sébastien
PS: beware the wiki: I've tried to make use of it for several issues. I found
it not so convenient, and nearly noone in CM uses it...
> Add convolution
> ---------------
>
> Key: MATH-851
> URL: https://issues.apache.org/jira/browse/MATH-851
> Project: Commons Math
> Issue Type: New Feature
> Reporter: Clemens Novak
> Priority: Minor
> Attachments: Filter.java, FilterTest.java, FilterUtils.java,
> FilterUtilsTest.java
>
>
> I created a function performing (one-dimensional) convolution. Currently, the
> function is in a class called Filter, but I am not sure whether this is the
> appropriate place for it(?).
--
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
