pattern_matching/lib.rs
1// Copyright 2020 Alexander Korn
2//
3// Licensed under the MIT license
4
5//! A library containing pattern matching and full-text index algorithms.
6//!
7//! # How to Start
8//!
9//! As you are looking at this documentation, I assume that you'd like to
10//! match a pattern on a text. This library contains different algorithms
11//! doing exactly that. Which algorithm you should use, however, depends
12//! strongly on your use case.
13//!
14//! If you don't already know, which algorithms would suite your needs,
15//! you should click through the algorithms listed below and have a look
16//! at the *When to Use It* parts of their descriptions.
17//!
18//! # Algorithms
19//!
20//! Currently, the following algorithms are implemented:
21//!
22//! - [BNDM](single_pattern::bndm)
23//! - [Horspool](single_pattern::horspool)
24//! - [Naive](single_pattern::naive)
25//! - [Shift-And](single_pattern::shift_and)
26
27pub mod single_pattern;