boostorg/algorithm
1
0
Fork 1
mirror of https://github.com/boostorg/algorithm.git synced 2026-08-10 07:21:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix \fn and \param tags in the searching algorithms

Browse Source 
The four searchers share copied comment blocks, and three of them kept
names from a function they no longer describe.

boyer_moore and knuth_morris_pratt document a predicate parameter Pred p
that none of the operators or do_search overloads take. boyer_moore also
names the block \fn operator while it sits on do_search, and so does one
of the two blocks in knuth_morris_pratt, where the real third parameter
is k_corpus_length rather than p. boyer_moore_horspool documents
k_corpus_length on a do_search that takes two arguments.

The correct form is already in the same family: boyer_moore.hpp:73 and
boyer_moore_horspool.hpp:68 both name two parameters and no predicate.
This commit is contained in:
Anton Karpov
2026-08-05 06:16:33 +03:00
parent bdaee1f3f6
commit db783f5815
3 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/boost/algorithm/searching/boyer_moore.hpp
+2 -3
View File
@@ -108,12 +108,11 @@ Requirements:
typename traits::skip_table_t skip_;
std::vector <difference_type> suffix_;
/// \fn operator ( corpusIter corpus_first, corpusIter corpus_last, Pred p )
/// \fn do_search ( corpusIter corpus_first, corpusIter corpus_last )
/// \brief Searches the corpus for the pattern that was passed into the constructor
///
///
/// \param corpus_first The start of the data to search (Random Access Iterator)
/// \param corpus_last One past the end of the data to search
/// \param p A predicate used for the search comparisons.
///
template <typename corpusIter>
std::pair<corpusIter, corpusIter>
include/boost/algorithm/searching/boyer_moore_horspool.hpp
-1
View File
@@ -107,7 +107,6 @@ http://www-igm.univ-mlv.fr/%7Elecroq/string/node18.html
///
/// \param corpus_first The start of the data to search (Random Access Iterator)
/// \param corpus_last One past the end of the data to search
/// \param k_corpus_length The length of the corpus to search
///
template <typename corpusIter>
std::pair<corpusIter, corpusIter>
include/boost/algorithm/searching/knuth_morris_pratt.hpp
+6 -7
View File
@@ -62,12 +62,11 @@ namespace boost { namespace algorithm {
~knuth_morris_pratt () {}
/// \fn operator ( corpusIter corpus_first, corpusIter corpus_last, Pred p )
/// \fn operator ( corpusIter corpus_first, corpusIter corpus_last )
/// \brief Searches the corpus for the pattern that was passed into the constructor
///
///
/// \param corpus_first The start of the data to search (Random Access Iterator)
/// \param corpus_last One past the end of the data to search
/// \param p A predicate used for the search comparisons.
///
template <typename corpusIter>
std::pair<corpusIter, corpusIter>
@@ -99,16 +98,16 @@ namespace boost { namespace algorithm {
const difference_type k_pattern_length;
std::vector <difference_type> skip_;
/// \fn operator ( corpusIter corpus_first, corpusIter corpus_last, Pred p )
/// \fn do_search ( corpusIter corpus_first, corpusIter corpus_last, difference_type k_corpus_length )
/// \brief Searches the corpus for the pattern that was passed into the constructor
///
///
/// \param corpus_first The start of the data to search (Random Access Iterator)
/// \param corpus_last One past the end of the data to search
/// \param p A predicate used for the search comparisons.
/// \param k_corpus_length The length of the corpus to search
///
template <typename corpusIter>
std::pair<corpusIter, corpusIter>
do_search ( corpusIter corpus_first, corpusIter corpus_last,
do_search ( corpusIter corpus_first, corpusIter corpus_last,
difference_type k_corpus_length ) const {
difference_type match_start = 0; // position in the corpus that we're matching