boostorg/algorithm
1
0
Fork 1
mirror of https://github.com/boostorg/algorithm.git synced 2026-08-09 23:11:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #132 from karpovantonme/docs/searching-param-tags

Browse Source 
Fix \fn and \param tags in the searching algorithms
This commit is contained in:
Marshall Clow
2026-08-04 21:29:36 -07:00
committed by GitHub
parent b738d228bf db783f5815
commit cfc892ccbe
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