You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
*/
The text was updated successfully, but these errors were encountered:
* Use const for input parameters
* Using C++ calls instead of C ones.
* Better error handling.
* Fix documentation issues #98 and #99
* Documentation fix
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.
*/
The text was updated successfully, but these errors were encountered: