Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@param index not in bindings/include/matrix find_best_n_discords function #98

Closed
Nexxel opened this issue Apr 2, 2019 · 1 comment
Closed
Labels
bug Something isn't working Documentation

Comments

@Nexxel
Copy link

Nexxel commented Apr 2, 2019

Describe the bug
In the documentation of find_best_n_discords function there is a @param that does not include the number of the param

Expected behavior
/**
* @brief Primitive of the findBestNDiscords function.
*
* @param profile The matrix profile containing the minimum distance of each
* subsequence
* @param index The matrix profile index containing the index of the most similar
* subsequence
* @param length_profile Length of the matrix profile
* @param m Subsequence length value used to calculate the input matrix profile.
* @param n Number of discords to extract
* @param discord_distances The distance of the best N discords
* @param discord_indices The indices of the best N discords
* @param subsequence_indices The indices of the query sequences that produced
* the "N" bigger discords.
* @param self_join Indicates whether the input profile comes from a self join operation or not. It determines
* whether the mirror similar region is included in the output or not.
*/

@avilchess avilchess added bug Something isn't working Documentation labels Apr 2, 2019
raulbocanegra pushed a commit that referenced this issue Apr 27, 2020
raulbocanegra added a commit that referenced this issue Apr 28, 2020
* Use const for input parameters
* Using C++ calls instead of C ones.
* Better error handling.
* Fix documentation issues #98 and #99
* Documentation fix
@raulbocanegra
Copy link
Contributor

Fixed on #153

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Documentation
Development

No branches or pull requests

3 participants