Anton Karpov db783f5815 Fix \fn and \param tags in the searching algorithms
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.
2026-08-05 06:16:33 +03:00
2025-06-23 21:06:23 -04:00

Algorithm, part of collection of the Boost C++ Libraries, is a collection of general purpose algorithms.

License

Distributed under the Boost Software License, Version 1.0.

Properties

  • C++03
  • Header-only

Build Status

Branch Travis Appveyor Coverity Scan codecov.io Deps Docs Tests
master Build Status Build status Coverity Scan Build Status codecov Deps Documentation Enter the Matrix
develop Build Status Build status Coverity Scan Build Status codecov Deps Documentation Enter the Matrix

Directories

Name Purpose
doc documentation
example examples
include headers
test unit tests

More information

  • Ask questions
  • Report bugs: Be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well.
  • Submit your patches as pull requests against develop branch. Note that by submitting patches you agree to license your modifications under the Boost Software License, Version 1.0.
  • Discussions about the library are held on the Boost developers mailing list. Be sure to read the discussion policy before posting and add the [algorithm] tag at the beginning of the subject line.
S
Description
Boost.org algorithm module
Readme BSL-1.0
5.4 MiB
Languages
C++ 91.7%
HTML 4.5%
Max 3.7%