Updated variable types, documentation and names #45
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bangerth
reviewed
Nov 14, 2019
| virtual | ||
| void | ||
| consume (InputType sample, | ||
| AuxiliaryData aux_data) override; |
There was a problem hiding this comment.
Can you run the indentation script? I think that is necessary for these lines.
| /** | ||
| * A function that returns the average cosine vector computed from the | ||
| * samples seen so far. If no samples have been processed so far, then | ||
| * a default-constructed object of value_type will be returned. |
There was a problem hiding this comment.
Write this as follows to make sure we get nice markup when doxygen converts the documentation to HTML:
Suggested change
| * a default-constructed object of value_type will be returned. | |
| * a default-constructed object of `value_type` will be returned. |
| * definition of "autocovariance" is more complex than what we do here (except | ||
| * if we work scalar samples types). That said, below we will use the word | ||
| * "autocovariance" even when refering to this spurious autocovariance. | ||
| * "autocovariance" even when refering to this spurious autocovariance. It can be looked as trace of |
There was a problem hiding this comment.
Suggested change
| * "autocovariance" even when refering to this spurious autocovariance. It can be looked as trace of | |
| * "autocovariance" even when refering to this spurious autocovariance. It can be looked as the trace of |
| * @f} | ||
| * In other words, it calculates the covariance of samples $x_{t+l}$ and $x_t$ | ||
| * with a lag between zero and $k$ | ||
| * with a lag l between zero and $k$ |
There was a problem hiding this comment.
Suggested change
| * with a lag l between zero and $k$ | |
| * with a lag $l$ between zero and $k$ |
| * \hat\gamma(l) | ||
| * = | ||
| * \frac{1}{n} \sum_{t=1}^{n-l}{(x_{t+l}-\bar{x})(x_{t}-\bar{x})}. | ||
| * \frac{1}{n-l} \sum_{t=1}^{n-l}{(x_{t+l}-\bar{x})(x_{t}-\bar{x})}. |
|
Any news? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed on Friday, I have updated code for average cosinus. Also, I have fixed mistakes at the documentation of spurious autoregression and changed the variable name from "current_autocovariation" to "current_spur_autocovariance". All tests passed successfully.